PHP code automatic detection (git/svn integrates PHP_CodeSniffer)

This article mainly introduces the automatic detection of PHP code (git/svn integrated PHP_CodeSniffer), which has certain reference value. Now I share it with you. Friends in need can refer to it

Background

When the company is developing, every time the code is submitted regardless of svn or git, the code will be simply automatically detected. The code logic cannot be checked, but at least the overall coding format can be ensured to be consistent. This function is quite useful. I have always wanted to know how it is implemented. It was not until recently that I started to understand what this automatic detection is.

Research approach

1. Generally, the company’s doc document will record the specific implementation of a certain function of various systems, and there may be more than one document. In the company’s doc No relevant information could be found through various keyword searches on the document

2. I found colleagues in the corresponding department and asked how it was implemented. The colleague replied that it was PHP_CodeSniffer and informed the github link. And clearly informed: Documentation? impossible. Then I added, everything is available on the Internet

3. Finally, I read a few articles on Baidu/Google, and I almost understood the practice

Part

PHP_CodeSniffer installation Reference materials

pear install PHP_CodeSniffer

I directly used the pear method to install it, which is much simpler and more convenient. The extension library installed using pear is basically in the PHP installation directory by default, such as mine: /opt/php-7.1.9/lib/php/PHP/CodeSniffer. You can refer to your own installation directory.
Use PHP_CodeSniffer directly from the command line as follows:

phpcs test.php

Set the code specification format of PHP_CodeSniffer.

# /opt/php-7.1.9/lib/php/PHP/CodeSniffer/src/Standards 
# 这个目录下列出了所有可以设置的格式（PSR1，PSR2，PSR12，Zend，Squiz等）
phpcs --config-set default_standard Zend

svn/git installation

I won’t go into the description here, because it took me some time to install it on the virtual machine, so I referred to the information on the Internet.

Integrate PHP_CodeSniffer into git/svn
Every time an svn project is deployed, there will be a corresponding configuration file, including a hooks folder, which contains pre-commit. In this Just add the phpcs command to the file.
The principle of git is the same, there is a folder with hooks, and pre-commit is included in it.
Difference: Our company's svn is automatically detected during the commit process, while git is detected during git push. I guess it would be best if automatic code detection is integrated into the server where the engineering code is located. The remote host is directly accessed when svn commits. However, when git commits, the code is saved in the local branch, and only when git push is performed, it is submitted to the remote host, so git is an automatic detection operation performed during git push.

Written at the end

By understanding the automatic detection of PHP code, I discovered many problems.

1. I didn’t take the initiative to think about the problem. At the beginning, I just wanted to look up information in the doc instead of thinking about how this function is implemented. When I couldn't find the information in the doc and went straight to my colleagues

2. , when I was working on business needs, I often forgot to continue learning and think about other things. For example, many Linux commands have been forgotten, and the extension library PHP_CodeSniffer is very good. I will study the specific implementation when I have time. Need to think about things often

3. Through this automatic code detection, I found that I don’t understand anything, including pear, PSR, svn/git, yum/apt-get, etc. Even though I have used it before, I did not study it in depth or make corresponding records, so I quickly forgot about it. If you read a little more, you will realize that you know too little.

4. Thanks for the several materials used in this process

The above is the entire content of this article. I hope it will be helpful to everyone's study. For more related content, please pay attention to the PHP Chinese website!

Related recommendations:

Solution to WampServer LAN mobile phone inaccessibility

Use of PHP7.2 Data Structures

The above is the detailed content of PHP code automatic detection (git/svn integrates PHP_CodeSniffer). For more information, please follow other related articles on the PHP Chinese website!