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

PHP CBF

by andremacola ST3

Sublime Text plugin for PHP_CodeSniffer

Labels php, phpcs, formatting

Details

Installs

  • Total 186
  • Win 116
  • Mac 26
  • Linux 44
Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11
Windows 0 0 0 1 1 0 2 1 1 0 0 1 2 2 2 1 1 2 3 0 3 0 1 0 2 0 2 0 1 1 0 0 3 1 1 2 0 2 0 1 1 2 0 0 0 1
Mac 1 1 3 0 0 0 0 1 0 0 0 0 0 0 0 0 0 1 0 1 0 1 0 0 0 0 1 0 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1
Linux 0 0 1 0 1 0 1 1 0 0 1 0 1 1 0 0 0 1 0 0 1 0 0 0 3 5 6 5 0 1 0 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0

Readme

Source
raw.​githubusercontent.​com

PHP_CBF for Sublime Text ¾

This is a lightweight ST Package to fix your php files with PHP Codebeautifier aka phpcbf. It is based on the original PHP_CodeSniffer package without the phpcs.

The advantage of this plugin is that it acts directly in the Sublime Text buffer, avoiding file reloading thus being faster.

For linting your code, please use Sublimelinter-phpcs. It is a more modern package for the purpose.

Installation

Package Control

This package is available through Package Control.

Package Control ‣ Install Package ‣ PHP CBF

Cloning the repository

  • Clone the PHP_CBF Sublime Text Plugin in to ST3/ST4 Packages directory.
git clone https://github.com/andremacola/PHP_CBF PHP_CBF
  • Packages directory locations:
Mac: /Users/{user}/Library/Application Support/Sublime Text 3/Packages
Windows: C:\Users\{user}\AppData\Roaming\Sublime Text 3\Packages
Linux: ~/.config/sublime-text-3/Packages

Configuration

Configuration files can be opened via Preferences > Package Settings > PHP_CBF.

Make sure the php_path and phpcbf_path paths are correct. E.g.

"phpcs_path": "/usr/local/bin/phpcs",
"phpcbf_path": "/usr/local/bin/phpcbf",

phpcs_standard

This settings can be the name of a single standard or a list of folder/project names and the standard to be used for each project. E.g.

"phpcs_standard": "Squiz"
// sublime-project
"settings": {
    "PHP_CBF": {
        "fix_on_save": true,
        "phpcs_standard": "~/my_project/phpcs.xml"
    }
}

additional_args

Array containing additional arguments to pass to the PHPCS/PHPCBF scripts.

fix_on_save

If set to true then buffer will be checked and fixed on each save.

Usage

There are one shortcut that can be used for Sublime PHP_CBF plugin: - ALT + SHIFT + S: Runs PHPCBF command for the open buffer.

These commands are also available in Tools > PHP_CBF menu.

Known Issues

If your project is configured to work with tabs, but for some reason ST is configured to indent with spaces (see conf in the bottom right corner), PHPCBF maybe start a loop saving process if fix_on_save is enabled.