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

Sublime​Linter-phpcs

by SublimeLinter ST3

SublimeLinter plugin for PHP, using phpcs.

Details

Installs

  • Total 47K
  • Win 24K
  • OS X 13K
  • Linux 10K
Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6
Windows 10 34 38 38 57 43 59 37 42 60 83 96 41 42 23 15 20 33 25 44 30 19 21 27 32 25 37 25 17 17 42 32 28 39 37 20 17 45 34 40 39 49 15 17 37 36
OS X 2 15 33 50 47 50 48 37 49 70 137 210 62 15 6 6 16 9 23 13 17 8 2 10 15 17 13 9 17 6 9 15 24 12 16 10 6 25 16 16 14 12 11 7 12 15
Linux 5 18 20 16 28 13 38 16 14 25 43 42 16 11 5 7 11 10 17 13 18 6 3 13 7 9 16 9 6 8 10 8 13 11 12 1 5 8 5 10 18 11 3 6 14 10

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-phpcs

Build Status

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 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must 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. Once phpcs is installed, you can proceed installing the SublimeLinter-phpcs plugin if you did not already do this (the order does not matter).

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type phpcs. Among the entries you should see SublimeLinter-phpcs. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

Project Specific Executable

It is possible to specify the phpcs executable that should be used to lint your code on a per-project level.

Example:

{
    "SublimeLinter": {
        "linters": {
            "phpcs": {
                "cmd": "${project}/vendor/bin/phpcs"
            }
        }
    }
}

Per-project Standards

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

{
    "SublimeLinter": {
        "linters": {
            "phpcs": {
                "standard": "${project}/phpcs.xml"
            }
        }
    }
}

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.

Thank you for helping out!