Difference between revisions of "PHP CodeSniffer (PHPcs)"
m (→Bug Workarounds) |
m (→Installation) |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{TOCright}} | {{TOCright}} | ||
| − | PHP CodeSniffer (PHPcs) is a useful tool for PHP developers. | + | PHP CodeSniffer (PHPcs) is a useful tool for PHP developers <ref>[https://github.com/squizlabs/PHP_CodeSniffer PHP CodeSniffer], PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent. </ref>. |
== Introduction == | == Introduction == | ||
| Line 7: | Line 7: | ||
It is an essential development tool that ensures your code remains clean and consistent. | It is an essential development tool that ensures your code remains clean and consistent. | ||
It can also help prevent some common semantic errors made by developers. | It can also help prevent some common semantic errors made by developers. | ||
| + | |||
| + | == Installation == | ||
| + | The preferred way to install PHPcs is [[PHP Composer]]. | ||
| + | <pre> | ||
| + | $ composer global require "squizlabs/php_codesniffer=*" | ||
| + | </pre> | ||
| + | {| class="wikitableharm" width="1250px" | ||
| + | |- style="vertical-align:top;" | ||
| + | | width="50%" | | ||
| + | Optional on Unix/Mac Operating Systems create a shortcut (Symbolic Link) to the installed version, which is located in the subdirection of the location of the used composer.json. | ||
| + | <br>Most users will create a directory {{FormFCTW|8|blue|bold|.composer}} under the used user {{FormFCTW|8|blue|bold|~}}. | ||
| + | <br>Example {{FormFCTW|8|blue|bold|~/.composer}} directory: | ||
| + | <pre> | ||
| + | -d- cache | ||
| + | -d- vendor | ||
| + | -d- bin | ||
| + | -s- pdepend | ||
| + | -s- php-cs-fixer | ||
| + | -s- phpcs | ||
| + | -s- phpmd | ||
| + | -s- phpstan | ||
| + | -s- phpstan.phar | ||
| + | -f- composer.lock | ||
| + | -f- composer.json | ||
| + | -?- ... | ||
| + | </pre> | ||
| + | * -d- : directory. | ||
| + | * -f- : file. | ||
| + | * -s- : symbolic link or alias. | ||
| + | * -?- : other files. | ||
| + | | width="50%" | | ||
| + | Example {{FormFCTW|8|blue|bold|composer.json}} after installation. | ||
| + | <pre> | ||
| + | 1 { | ||
| + | 2 "require": { | ||
| + | 3 "squizlabs/php_codesniffer": "3.*", | ||
| + | 4 "friendsofphp/php-cs-fixer": "^3.0" | ||
| + | 5 }, | ||
| + | 6 | ||
| + | 7 "require-dev": { | ||
| + | 8 "phpmd/phpmd" : "@stable", | ||
| + | 9 "phpstan/phpstan": "^0.12.87" | ||
| + | 10 } | ||
| + | 11 } | ||
| + | </pre> | ||
| + | Please note: The line 3 shows the added phcs-entry. | ||
| + | |} | ||
== Bug Workarounds == | == Bug Workarounds == | ||
| − | Some users experience warning about not finding the CLI.php file after installing and trying the tools. | + | If you install using the {{FormFCTW|8|blue|bold|composer}} method the following is {{FormFCTW|8|blue|bold|DEPRECATED}}. |
| + | So this only applies to the pear installation before 2019. | ||
| + | <br>Some users experience warning about not finding the CLI.php file after installing and trying the tools. | ||
* Search for the location of the phpcs file. | * Search for the location of the phpcs file. | ||
* open the file with a normal developer text editor. | * open the file with a normal developer text editor. | ||
* Adjust | * Adjust | ||
| − | < | + | <pre> |
if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) { | if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) { | ||
include_once dirname(__FILE__).'/../CodeSniffer/CLI.php'; | include_once dirname(__FILE__).'/../CodeSniffer/CLI.php'; | ||
| Line 19: | Line 68: | ||
include_once 'PHP/CodeSniffer/CLI.php'; | include_once 'PHP/CodeSniffer/CLI.php'; | ||
} | } | ||
| − | </ | + | </pre> |
Into something like: | Into something like: | ||
| − | < | + | <pre> |
if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) { | if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) { | ||
include_once dirname(__FILE__).'/../CodeSniffer/CLI.php'; | include_once dirname(__FILE__).'/../CodeSniffer/CLI.php'; | ||
| Line 29: | Line 78: | ||
include_once 'PHP/CodeSniffer/CLI.php'; | include_once 'PHP/CodeSniffer/CLI.php'; | ||
} | } | ||
| − | </ | + | </pre> |
== See also == | == See also == | ||
Latest revision as of 15:30, 15 May 2021
PHP CodeSniffer (PHPcs) is a useful tool for PHP developers [1].
Introduction
PHPcs is a PHP5 script that tokenises and "sniffs" PHP, JavaScript and CSS files to detect violations of a defined coding standard. It is an essential development tool that ensures your code remains clean and consistent. It can also help prevent some common semantic errors made by developers.
Installation
The preferred way to install PHPcs is PHP Composer.
$ composer global require "squizlabs/php_codesniffer=*"
|
Optional on Unix/Mac Operating Systems create a shortcut (Symbolic Link) to the installed version, which is located in the subdirection of the location of the used composer.json.
-d- cache
-d- vendor
-d- bin
-s- pdepend
-s- php-cs-fixer
-s- phpcs
-s- phpmd
-s- phpstan
-s- phpstan.phar
-f- composer.lock
-f- composer.json
-?- ...
|
Example composer.json after installation. 1 {
2 "require": {
3 "squizlabs/php_codesniffer": "3.*",
4 "friendsofphp/php-cs-fixer": "^3.0"
5 },
6
7 "require-dev": {
8 "phpmd/phpmd" : "@stable",
9 "phpstan/phpstan": "^0.12.87"
10 }
11 }
Please note: The line 3 shows the added phcs-entry. |
Bug Workarounds
If you install using the composer method the following is DEPRECATED.
So this only applies to the pear installation before 2019.
Some users experience warning about not finding the CLI.php file after installing and trying the tools.
- Search for the location of the phpcs file.
- open the file with a normal developer text editor.
- Adjust
if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) {
include_once dirname(__FILE__).'/../CodeSniffer/CLI.php';
else {
include_once 'PHP/CodeSniffer/CLI.php';
}
Into something like:
if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) {
include_once dirname(__FILE__).'/../CodeSniffer/CLI.php';
} else if (is_file('/usr/local/pear/share/pear/PHP/CodeSniffer/CLI.php')) {
include_once '/usr/local/pear/share/pear/PHP/CodeSniffer/CLI.php';
} else {
include_once 'PHP/CodeSniffer/CLI.php';
}
See also
- Pear PHPcs, Pear installation for PHPcs.
Reference
- ↑ PHP CodeSniffer, PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
