README.md

SublimeLinter-phpcs

This linter plugin for SublimeLinter provides an interface to phpcs. It will be used with files that have the "PHP", "HTML" and "HTML5" syntax.

Installation

SublimeLinter must be installed in order to use this plugin.

Please use Package Control to install the linter plugin.

Before using this plugin, ensure that phpcs is installed on your system, preferably somewhere in your PATH. To install phpcs, follow the instructions on https://github.com/squizlabs/PHP_CodeSniffer#installation.

Settings

• SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html
• Linter settings: http://sublimelinter.com/en/latest/linter_settings.html

Use the "args" setting to configure the coding standard, and/or to display the sniff codes for each error:

{
    "args": [
        "--standard=PEAR", // code standard
        "-s"               // display sniff codes
    ]
}

Per-project Standards

You can set up your project settings to use a specific standard using the following:

{
    "settings": {
        "SublimeLinter.linters.phpcs.args": "--standard='${folder}/phpcs.xml'"
    }
}