How to use PHP_CodeSniffer to check code specifications (detailed explanation)

Some students may not have heard of this thing yet. Let me give you a brief introduction:

PHP_CodeSniffer is a code style detection tool. It contains two types of scripts, phpcs and phpcbf (GitHub address).

phpcs The script defines a series of code specifications for PHP, JavaScript, CSS files (usually using the official Code specification standards, such as PSR2 of PHP), can detect code that does not comply with code specifications and issue a warning or error (the error level can be set).

phpcbf The script can automatically correct the parts of the code format that do not comply with the standards. For example, the PSR2 specification requires a blank line at the end of each PHP file. Then running this script will automatically add a blank line at the end.

Installation

It is recommended to use composer to install:

composer global require "squizlabs/php_codesniffer=*"

After installation, it will be in Two soft links are generated in bin under the global Vendor directory:

phpcbf -> ../squizlabs/php_codesniffer/bin/phpcbf
phpcs -> ../squizlabs/php_codesniffer/bin/phpcs

If you don’t know where the global Vendor directory is, use Just issue this command:

composer global config bin-dir --absolute

Command line usage

At this point, you can actually use these two commands happily:

Oh, but if you want to use these two commands globally, you should make a soft link and put it in /usr/local/bin~

$ phpcs test.php

FILE: /Users/stephen/Develop/Code/test.php
--------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------
 2 | ERROR | [ ] Missing file doc comment
 3 | ERROR | [x] TRUE, FALSE and NULL must be lowercase; expected "false" but found "FALSE"
--------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------

Time: 45ms; Memory: 4Mb

$ phpcbf test.php

PHPCBF RESULT SUMMARY
----------------------------------------------------------------------
FILE                                                  FIXED  REMAINING
----------------------------------------------------------------------
/Users/stephen/Develop/Code/test.php                  1      1
----------------------------------------------------------------------
A TOTAL OF 1 ERROR WERE FIXED IN 1 FILE
----------------------------------------------------------------------

Time: 49ms; Memory: 4Mb

Integration in Sublime Text

##Installing plug-ins

Prerequisite

Package Control To install it properly, you definitely don’t have this The problem (inexplicable self-confidence, escape)

Install the

phpcs plug-in, and then open the Settings - User and Settings - Default of this plug-in. , copy all the contents of the latter to the former.

Configuration plug-in

Configure the following configuration items:

Execution path of

php in the current environment

"phpcs_php_prefix_path": "/usr/bin/php",

The execution path of

phpcs in the current environment

"phpcs_executable_path": "~/.composer/vendor/bin/phpcs",

Additional parameters added when executing the script are generally based on the

PSR2 code specification. You can also You can choose PSR1, PEAR, etc.

"phpcs_additional_args": {
    "--standard": "PSR2",
    "-n": ""
},

The execution path of

phpcbf in the current environment

"phpcbf_executable_path": "/Users/stephen/.composer/vendor/bin/phpcbf",

Start saving and execute

cbf Script function

"phpcbf_on_save": true,

Now you can play happily. After editing the file with the

.php suffix and saving it, it will automatically reply to correct the irregularities in the code.

This plug-in also has other places where code specifications can be set, such as

PHP Mess Detector settings, PHP Linter settings, PHP Scheck settings

I will study several others next time, it is enough for me at the moment, escape)

Integrated in PhpStrom

Configure Code Sniffer

Configure

phpcs in Settings -> Languages ​​& Frameworks -> PHP -> Code Sniffer

Click

Configuration: Local Next to ..., configure the path where the phpcs execution script of the current environment is located. There is a Validate button next to it. For verification, just leave the other two parameters as default. Let’s talk about it a little here.

Maxumum number of messages per file[1...100]: Each file displays the maximum number of messages that do not comply with the code specifications. Generally, 50 messages appear, so you have a lot of work to do. I have done it. In fact, 10 is enough, especially for people like me who are code-obsessed and in the late stages of obsessive-compulsive disorder. One is enough. . .

Tool process timeout, sec[1...30]: Timeout for script execution

Enable verification

Turn it on in Settings -> Editor -> Inspections

Find the PHP -> PHP Code Sniffer validation option, check it, and configure it in detail on the right side

I changed the Options -> Show warnings as: Error is turned on. Of course, you can also choose Warning. If the prompt level is higher, you can force yourself. There is nothing wrong with it~

Coding standard Still choose PSR2, if you can’t find it For this option, remember to click the refresh button next to it.

Automatic repair

I have been looking for a long time but I didn’t find that

PhpStrom has an available option that supports phpcbf, so I can only pass External Tools is implemented.

Add it in Settings -> Tools -> External Tools. Here is an example of mine, which can basically be copied:)

ParameterValueNamephpcbfDescriptionAutomatically correct coding standard violations.ProgramphpcbfParameters--standard= PSR2 "$FileDir$/$FileName$"

You can now find it in Tools -> External Tools on the menu bar and use it happily.

Brother Liang, this is very inconvenient. . .

Then add a shortcut key. . .

Add shortcut keys in Settings -> Keymap -> External Tools -> phpcbf. I set Option F, or Alt F## on Windows. #.

Honey extension

was not used before

phpcbf, the code is automatically repaired using php-cs -fixer, but later I found that the functions of the two are similar, so I gave up php-cs-fixer based on the principle of missing one package if possible.

If you are interested, you can expand your understanding by yourself~

Recommended: "

PHP Video Tutorial"

The above is the detailed content of How to use PHP_CodeSniffer to check code specifications (detailed explanation). For more information, please follow other related articles on the PHP Chinese website!