Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 5.1 KB

README.md

File metadata and controls

80 lines (57 loc) · 5.1 KB
Raw

SublimeLinter-contrib-php-cs-fixer

Build Status

This linter plugin for SublimeLinter provides an interface to php-cs-fixer. It will be used with files that have the “php” syntax. Note that php-cs-fixer is not a linter as such. It was built as a fixer. At time of writing, its output doesn't allow for proper linting because it doesn't contain line numbers and nice, human friendly help messages. However, when used with default settings, this SublimeLinter plugin will run php-cs-fixer on the file you are currently editing, thus fixing it in real-time, rather than requiring you to call php-cs-fixer manually. For the time being (as long as there is no linter friendly output), applied fixers are shown on the first line of the fixed file.

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 php-cs-fixer is installed on your system. To install php-cs-fixer, do the following:

  1. Install composer.

    curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

  2. Install php-cs-fixer by typing the following in a terminal:

    composer global require php-cs-fixer

Note: This plugin requires php-cs-fixer 1.11 or later.

Linter configuration

In order for php-cs-fixer to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured php-cs-fixer, you can proceed to install the SublimeLinter-contrib-php-cs-fixer plugin if it is not yet installed.

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 php-cs-fixer. Among the entries you should see SublimeLinter-contrib-php-cs-fixer. 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.

In addition to the standard SublimeLinter settings, SublimeLinter-contrib-php-cs-fixer provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be used inline.

Setting Description Inline Setting Inline Override
--dry-run When set, no fixing is actually performed.
--config-file .php.cs Name of config file to use. SublimeLinter walks up the directory tree starting from the currently linted file and will use the first occurrence of the specified file name it finds.

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 modifications 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.
  • Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!