Sublime PHP CodeSniffer, PHP Coding Standards Fixer, Linter and Mess Detector Plugin
This plugin adds PHP CodeSniffer, PHP Coding Standards Fixer, the PHP Linter and phpmd support to Sublime Text 2.
Requirements for this plugin, should you want all the options to work:
- PHP_CodeSniffer 1.3+ (potentially works with lower versions, but this hasn't been tested)
- PHPMD 1.4+ (potentially works with lower versions, but this hasn't been tested)
- PHP CS Fixer version 0.2+ (potentially works with lower versions, but this hasn't been tested)
- Python 2.6
This plugin has been tested on:
- Mac OS X 10.6.8 (2.6.1 r261:67515, Jun 24 2010, 21:47:49) and 10.7.3 (2.6.7 r267:88850, Jul 31 2011, 19:30:54)
- Ubuntu 11.10 (2.6.6 r266:84292, Jun 16 2011, 22:35:51)
- Windows XP (2.6.5 r265:79096, Mar 19 2010, 21:48:26)
Use Sublime Text 2's Package Control (Preferences -> Package Control -> Install Package -> Phpcs) to install this plugin. This is the recommended installation path.
Simply checkout the git repo into “~/Library/Application Support/Sublime Text 2/Packages/ or the equivalent folder on Windows or Linux.
$ cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/ $ git clone git://github.com/benmatselby/sublime-phpcs.git Phpcs
In both cases, you may need to then configure the following with the actual path to the application:
They are optional for the plugin. The path needs to include the application such as "/usr/local/bin/phpcs".
In order to get the path of the application (On a Mac/Linux based environment), you can use:
$ which phpcs $ which phpmd $ which php-cs-fixer
How to use the plugin
This plugin adds support for running PHP CodeSniffer, PHP Coding Standards Fixer, the PHP linter and PHPMD from inside Sublime Text 2.
Right-click in the editor to:
- Sniff the current file
You can also open up the Command Palette (CTRL + SHIFT + P on Linux), and type 'PHP Code Sniffer' to see what you can do with the PHP Code Sniffer plugin in the currently open file.
For more information on how to run this plugin, visit here
You can configure:
- show_debug - Do you want the debug information to be sent to the console?
- extensions_to_execute - Which filetypes do you want the plugin to execute for?
- phpcs_execute_on_save - Do you want the code sniffer plugin to run on file save for php files?
- phpcs_show_errors_on_save - Do you want the errors to be displayed in quick_panel on save?
- phpcs_show_gutter_marks - Do you want the errors to be displayed in the gutter?
- phpcs_outline_for_errors - Do you want the errors to be highlighted in the editor?
- phpcs_show_errors_in_status - Do you want the errors to be displayed in status bar when clicking on the line with error?
- phpcs_show_quick_panel - Do you want the errors to be displayed in the quick panel?
- phpcs_php_prefix_path - Needed on windows for phar based applications. Also if you cannot make phar executable. Avoid if possible
- phpcs_commands_to_php_prefix - List of commands you want the php path to prefix. This would be useful, if you have some commands as a phar that cannot be run without the php prefix, and others using native command.
- phpcs_sniffer_run - Do you want the PHPCS checker to run?
- phpcs_command_on_save - Do you want the command to execute on save?
- phpcs_executable_path - The path to the phpcs executable. If empty string, use PATH to find it
- phpcs_additional_args - This is the extra information you want to pass to the phpcs command. For example which “standard” you want to run, and if you want to show warnings or not
PHP CodeSniffer Fixer
- php_cs_fixer_on_save - Do you want to run the fixer on file save?
- php_cs_fixer_show_quick_panel - Do you want the quick panel to display on execution?
- php_cs_fixer_executable_path - The path to the php-cs-fixer application.
- php_cs_fixer_additional_args - This is the extra information you want to pass to the php-cs-fixer command. For example which "fixers" you want to run
- phpcs_linter_run - Do you want the PHP linter (syntax errors) to run?
- phpcs_linter_command_on_save - Do you want the command to execute on save?
- phpcs_php_path - The path to the PHP executable. If empty string, use PATH to find it
- phpcs_linter_regex - The regex for the PHP linter output
PHP Mess Detector
- phpmd_run - Do you want the PHPMD to run? Off by default
- phpmd_command_on_save - Do you want the command to execute on save?
- phpmd_executable_path - The path to the phpmd executable. If empty string, use PATH to find it
- phpmd_additional_args - This is the extra information you want to pass to the phpcs command. For example which "rulesets" you want to run
What do I do when I get "No such file or directory" error?
OSError: [Error 2] No such file or directory
- Well, first of all you need to check that you have PHP_CodeSniffer, and if being used, the phpmd application.
- If you have these applications installed, then it sounds like those applications are not in your PATH, or cannot be found in your PATH by the Python runtime, so configure "phpcs_php_path", "phpcs_executable_path", "phpmd_executable_path" and "php_cs_fixer_executable_path" with the actual paths to those applications
Installed php-cs-fixer via Homebrew?
If you have installed php-cs-fixer via homebrew then please make sure that you define "php_cs_fixer_executable_path" to the .phar application and not the wrapper script that is placed in your bin folder, as this will cause odd behaviour.