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

  • 1.0.3
  • github.​com
  • github.​com
  • 6 months ago
  • 3 minutes ago
  • 10 months ago

Installs

  • Total 444
  • Win 275
  • Mac 70
  • Linux 99
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 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11
Windows 0 1 0 0 1 2 0 1 0 0 0 0 1 1 0 2 0 0 2 0 0 0 1 0 1 0 2 0 1 1 1 2 1 1 4 0 0 0 0 2 2 2 2 1 1 1
Mac 0 0 0 0 0 0 0 1 1 0 0 0 2 1 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 1 0 1 1 0 0 0 0 0 0 0 1 0 0 0 0 0
Linux 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 2 0 0 0 1 0 0 0 0 0 0 1 0 0 0 0 0 1

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.