PHP代碼自動檢測(git/svn集成PHP_CodeSniffer)

背景

在公司開發的時候,每次無論svn仍是git提交代碼的時候都會對代碼進行簡單的自動檢測。檢查不了代碼邏輯,可是最起碼能保證總體的編碼格式保持一致。這個功能仍是挺有用的,一直想了解下是怎麼實現的,直到最近想起來纔開始瞭解這個自動檢測是怎麼回事。php

研究途徑

  1. 通常公司的doc文檔上會記錄各類系統的某個功能的具體實現,並且極可能不止一個文檔,在公司的doc文檔上各類關鍵字搜索都找不到相關資料
  2. 找到對應部門的同事詢問是如何實現的。同事給了答覆是PHP_CodeSniffer而且告知了github連接。而且明確告知:文檔?不可能的。而後加了一句,網上什麼都有
  3. 最後就本身在Baidu/Google了幾篇文章,差很少就瞭解了

實踐部分

PHP_CodeSniffer的安裝 參考資料html

pear install PHP_CodeSniffer

我直接使用了pear方式安裝,簡單方便不少。使用pear安裝的擴展庫基本上默認在php的安裝目錄下,好比個人:/opt/php-7.1.9/lib/php/PHP/CodeSniffer。你們能夠參考下本身的安裝目錄。
命令行直接使用PHP_CodeSniffer以下:linux

phpcs test.php

設置PHP_CodeSniffer的代碼規範格式。git

# /opt/php-7.1.9/lib/php/PHP/CodeSniffer/src/Standards 
# 這個目錄下列出了全部能夠設置的格式(PSR1,PSR2,PSR12,Zend,Squiz等)
phpcs --config-set default_standard Zend

svn/git安裝github

這裏不展開描述了,因爲我在虛擬機上安裝也花了一些時間,都是參考網上的資料。svn

將PHP_CodeSniffer集成到git/svn中
每部署一個svn項目,都會對應的配置文件,其中有個hooks文件夾,其中有pre-commit,在這個文件中加上phpcs 的命令就行了。
git的原理是同樣的,都是有個hooks的文件夾,其中都有pre-commit。
差異:咱們公司svn是在commit的過程當中進行的自動檢測,git是在git push的時候進行檢測操做的。猜測應該自動代碼檢測確定是集成在工程代碼所在的服務端是最好的。svn commit的時候就直接訪問的遠程主機。可是git commit的時候是將代碼保存在本地分支,只有git push的時候纔是提交到遠程主機,因此git就是在git push的時候進行的自動檢測操做。學習

寫在最後

經過了解PHP代碼的自動檢測,發現了不少問題。ui

  1. 本身沒有主動去思考問題,最開始的時候就是想去doc上查找資料,而不是先想一想這個功能是如何作到的。再到在doc上沒找到資料直接去找了同事
  2. 一直在作業務需求的時候,經常忘記了繼續學習,思考其餘東西。好比linux命令不少都已經忘記了,還有就是PHP_CodeSniffer這個擴展庫很不錯,以後有時間再研究下具體實現。須要常常思考問題
  3. 經過此次的代碼自動檢測發現本身什麼都不懂,pear,PSR,svn/git,yum/apt-get等等不少都不懂,即便以前用過,可是沒有深刻研究過,也沒有作對應的記錄,因此很快就忘記了。看的稍微多一點就會意識到本身瞭解的太少太少了
  4. 感謝這個過程當中使用的幾個資料

參考文檔
PHP_CodeSniffer安裝編碼

相關文章
相關標籤/搜索