ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

PHPUnit​Kit

by gerardroche ST3

PHPUnit support for Sublime Text 3

Labels php, phpunit, testing, tdd

Details

Installs

  • Total 5K
  • Win 3K
  • OS X 1K
  • Linux 1K
Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28
Windows 0 4 1 0 2 1 2 4 1 3 0 2 2 5 5 3 1 1 4 2 4 1 3 2 2 6 1 2 1 0 0 1 1 4 2 1 2 0 0 4 2 1 1 1 0 2
OS X 0 2 0 1 3 1 1 1 0 0 1 2 0 2 1 0 0 1 1 1 2 2 3 1 1 1 1 1 0 1 0 1 2 1 0 2 0 0 0 2 0 0 3 0 0 1
Linux 0 0 1 0 1 1 0 1 0 3 0 0 1 0 0 0 0 0 2 1 1 0 1 1 0 3 2 0 0 0 0 0 0 0 0 0 0 0 2 2 0 1 1 0 0 1

Readme

Source
raw.​githubusercontent.​com

Sublime PHPUnitKit

PHPUnit support for Sublime Text 3.

Build Status Build status Coverage Status Minimum Sublime Version Latest Stable Version GitHub stars Downloads

Screenshot

Features

  • Run Test File
  • Run Test Suite
  • Run Nearest Test
  • Run Last Test
  • Fully customisable configuration
  • Supports Composer installed PHPUnit
  • Supports colour results, diffs, errors, etc.
  • Jump to next and jump to previous failure

Installation

Package Control installation

The preferred method of installation is Package Control.

Manual installation

Close Sublime Text, then download or clone the repository to a directory named PHPUnitKit in the Sublime Text Packages directory for your platform:

OS | Command – | —– Linux | git clone https://github.com/gerardroche/sublime-phpunit.git ~/.config/sublime-text-3/Packages/PHPUnitKit OSX | git clone https://github.com/gerardroche/sublime-phpunit.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/PHPUnitKit Windows | git clone https://github.com/gerardroche/sublime-phpunit.git %APPDATA%\Sublime/ Text/ 3/Packages/PHPUnitKit

Commands

These commands are available through the Command Palette. To use the command palette. To use the command palette:

  1. Press Ctrl+Shift+p (Win, Linux) or Cmd+Shift+p (OS X)
  2. Select a command (all PHPUnitKit commands begin with PHPUnit:)
  3. Press Enter to run the command
command description
TestSuite Runs the whole test suite (if the current file is a test file, runs that framework's test suite).
TestFile In a test file runs all tests in the current file, otherwise runs that file's tests.
TestNearest In a test file runs the test nearest to the cursor, otherwise runs that file's tests.
TestLast Runs the last test.
TestVisit Visits the test file from which you last run your tests (useful when you're trying to make a test pass, and you dive deep into application code and close your test buffer to make more space, and once you've made it pass you want to go back to the test file to write more tests).
TestSwitch In a test file opens the file under test, otherwise opens the test file.
TestResults Opens the test results panel.
TestCancel Cancels the test runner.
TestCoverage Opens the code coverage report in default browser.
ToggleOption Toggles PHPUnit options.

Key Bindings

Add your preferred key bindings via Menu > Preferences > Key Bindings or use the command palette:

  1. Press Ctrl+Shift+p (Win, Linux) or Cmd+Shift+p (OS X)
  2. Select the “Preferences: Key Bindings” command
  3. Press Enter
[
    { "keys": ["ctrl+shift+a"], "command": "phpunit_test_suite" },
    { "keys": ["ctrl+shift+c"], "command": "phpunit_test_cancel" },
    { "keys": ["ctrl+shift+f"], "command": "phpunit_test_file" },
    { "keys": ["ctrl+shift+l"], "command": "phpunit_test_last" },
    { "keys": ["ctrl+shift+n"], "command": "phpunit_test_nearest" },
    { "keys": ["ctrl+shift+r"], "command": "phpunit_test_results" },
    { "keys": ["ctrl+shift+s"], "command": "phpunit_test_switch" },
    { "keys": ["ctrl+shift+v"], "command": "phpunit_test_visit" }
]
key description
F4 Jump to Next Failure
Shift+F4 Jump to Previous Failure

Configuration

You can configure settings via Menu > Preferences > Settings or via the Command Palette (press Ctrl+Shift+P, select Preferences: Settings and press Enter).

key description type default
phpunit.options Default options to use when running PHPUnit. dict {}
phpunit.composer Use PHPUnit installed by Composer? boolean true
phpunit.on_post_save List of events to trigger when a file is saved. list []
phpunit.php_executable Path to PHP executable. string Use system PATH
phpunit.php_versions_path Path to phpenv versions. string ~/.phpenv/versions
phpunit.save_all_on_run Save all dirty buffers before running tests. boolean true
phpunit.strategy Execution environment. string default

phpunit.composer

When enabled, the test runner will checks if there is a Composer installed PHPUnit available, otherwise the system PATH will be used to find PHPUnit. When disabled, the Composer check is skipped. Composer support is enabled by default, but you can disabled it.

"phpunit.composer": false

phpunit.options

If you want some CLI options to stick around, you can configure them in your global preferences:

"phpunit.options": {
    "colors=never": true,
    "coverage-html": "build/coverage",
    "no-coverage": true,
    "d": ["display_errors=1", "xdebug.scream=0"]
}

The option configuration above translates to:

-d "display_errors=1" -d "xdebug.scream=0" --colors=never --coverage-html build/coverage --no-coverage

phpunit.on_post_save

The “on post save” option allows you to trigger events when a file is saved.

event description
run_test_file Runs the the “test file” command for the active view.
"phpunit.on_post_save": ["run_test_file"]

phpunit.php_executable

You can instruct the test runner to use a custom PHP executable.

"phpunit.php_executable": "~/.phpenv/versions/7.3.1/bin/php"

phpunit.save_all_on_run

Save all dirty buffers (views that have unsaved changes) before running tests.

"phpunit.save_all_on_run": false

phpunit.strategy

You can run tests using different execution environments.

strategy identifier description
Panel default Runs test commands in a panel at the bottom of your editor window.
iTerm2.app iterm Sends test commands to iTerm2 >= 2.9 (useful in MacVim GUI).
"phpunit.strategy": "iterm"

Runner commands

Aside from the main commands, you can configure your own custom test runners (which also accept options):

// Key Binding to run two specific test suites
{"keys": ["ctrl+shift+a"], "command": "test_suite", "args": {"testsuite": "fizz,buzz"}},

// Key Binding to run test suite with code coverage
{"keys": ["ctrl+shift+c"], "command": "test_suite", "args": {"coverage-html": "build/coverage"}},

The following commands accept CLI options:

  • phpunit_test_suite
  • phpunit_test_file
  • phpunit_test_nearest

Contributing

See CONTRIBUTING.md.

Changelog

See CHANGELOG.md.

Credits

Based initially on, and inspired by, maltize/sublime-text-2-ruby-tests, stuartherbert/sublime-phpunit, and janko-m/vim-test.

License

Released under the BSD 3-Clause License.