PHP CBF
Sublime Text plugin for PHP_CodeSniffer
Details
Installs
- Total 1K
- Win 626
- Mac 196
- Linux 234
May 31 | May 30 | May 29 | May 28 | May 27 | May 26 | May 25 | May 24 | May 23 | May 22 | May 21 | May 20 | May 19 | May 18 | May 17 | May 16 | May 15 | May 14 | May 13 | May 12 | May 11 | May 10 | May 9 | May 8 | May 7 | May 6 | May 5 | May 4 | May 3 | May 2 | May 1 | Apr 30 | Apr 29 | Apr 28 | Apr 27 | Apr 26 | Apr 25 | Apr 24 | Apr 23 | Apr 22 | Apr 21 | Apr 20 | Apr 19 | Apr 18 | Apr 17 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 3 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 2 | 0 | 0 |
Mac | 0 | 0 | 1 | 0 | 0 | 0 | 2 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 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.