Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
PHPUnit Support for Sublime Text 2
Python JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.gitignore
Context.sublime-menu
Default.sublime-commands
LICENSE.md
README.md
Side Bar.sublime-menu
license-newbsd.sublime-snippet
php-getset.sublime-snippet
php-newbsd.sublime-snippet
php-section-comment.sublime-snippet
phpunit-test.sublime-snippet
phpunit-testcase.sublime-snippet
phpunit.py

README.md

Sublime PHP

This is a collection of (hopefully) useful extras for writing PHP code using the excellent Sublime Text 2 editor.

Installation

We're waiting to be added to Package Control, so for now you'll need to clone this repo into your Sublime Text 2 "Packages/" folder.

PHPUnit Support For Sublime Text 2

This plugin adds support for running PHPUnit tests from inside Sublime Text 2.

Right-click in the editor to:

  • Run all unit tests (available in all PHP files)
  • Run the unit tests in the current file (only available in *Test.php files)
  • Run PHPUnit, using the current XML config file (available inside the XML config file)

Right-click in the side-bar to:

  • Run the unit tests in the current file
  • Run all the unit tests
  • Run PHPUnit, using the selected XML config file

You can also open up the Command Palette (CTRL + SHIFT + P on Linux), and type 'PHPUnit' to see what you can do with PHPUnit in the currently open file.

To make this work, you need to create a phpunit.xml.dist or phpunit.xml file for your code (projects using Phix get this for free). The Sublime-PHP plugin searches the folders upwards from whatever you are trying to test, using the first phpunit.xml or phpunit.xml.dist that it finds. Make sure that your phpunit.xml file is either at the top of your tests folder (or even further up), and this plugin will work for you.

PHPUnit support is based on the Ruby Tests plugin

Snippets

We add the following snippets to speed up writing PHP code.

To use any of the snippets, simply type the name of the snippet, then press the key. Sublime Text 2 will insert the snippet, and you can then use the key to move through any placeholders that you need to replace.

  • license-newbsd: insert the new BSD license (eg into LICENSE.md-type files)
  • php-getset: create getter/setter methods quickly and easily (based on a snippet originally published by @akrabat)
  • php-newbsd: insert the new BSD license as a PHP docblock
  • php-section-comment: insert a prominent comment to help break up the sections of your class
  • phpunit-test: create a new test method inside your TestCase class
  • phpunit-testcase: create a new TestCase class to put your tests inside

Contributions Welcome

Requests for features, and pull requests with patches, are most welcome :)

Something went wrong with that request. Please try again.