摘要:它包含兩類腳本,和地址腳本對文件定義了一系列的代碼規范通常使用官方的代碼規范標準,比如的,能夠檢測出不符合代碼規范的代碼并發出警告或報錯可設置報錯等級。腳本能自動修正代碼格式上不符合規范的部分。
Last-Modified: 2019年5月10日13:59:27
參考鏈接PHP開發規范之使用phpcbf腳本自動修正代碼格式
在PhpStorm中使用PSR2編碼規范phpcbf腳本自動修正代碼格式
使用 PHP-CS-Fixer 的可以看這篇文章: https://learnku.com/laravel/t...
介紹PHP_CodeSniffer 是一個代碼風格檢測工具。它包含兩類腳本,phpcs 和 phpcbf(GitHub地址)
phpcs
phpcs 腳本對 PHP、JavaScript、CSS 文件定義了一系列的代碼規范(通常使用官方的代碼規范標準,比如 PHP 的 PSR2),能夠檢測出不符合代碼規范的代碼并發出警告或報錯(可設置報錯等級)。
phpcbf
phpcbf 腳本能自動修正代碼格式上不符合規范的部分。比如 PSR2 規范中對每一個 PHP 文件的結尾都需要有一行空行,那么運行這個腳本后就能自動在結尾處加上一行空行。
php-cs-fixer安裝該工具不包含在 PHP_CodeSniffer 中, 是在另一個獨立的項目 https://github.com/FriendsOfP...
php-cs-fixer 修復不規范代碼 作用等同于 phpcbf 只不過規則好像稍有區別
composer global require "squizlabs/php_codesniffer=*"
安裝后會在全局的 Vendor目錄下的 bin 中生成兩個軟鏈接:
phpcbf -> ../squizlabs/php_codesniffer/bin/phpcbf phpcs -> ../squizlabs/php_codesniffer/bin/phpcs
使用 命令行模式查看全局 Vendor 目錄位置:
composer global config bin-dir --absolute
將 phpcs 和 phpcbf 的目錄加入環境變量
設置默認代碼標準
為了避免每次手動指定標準, 直接設置默認的代碼標準為 PSR-2
phpcs --config-set default_standard PSR2 phpcbf --config-set default_standard PSR2
檢測代碼文件
phpcs test.php
此時命令行會提示發現的問題列表, 帶 [x] 的表示可以被 phpcbf 修正
若需要每次執行時指定代碼格式標準, 則加上 –standard=
phpcs --standard=PSR2 test.php
修正代碼
phpcbf test.php
此時會修正問題列表中帶 [x] 的問題
PHPStorm 讓編輯器使用PSR-2標準1、打開PhpStorm的設置頁(File->Setting),到Editor->Code Style->PHP頁PHP中選擇風格為 PSR1/2
2、到Code Sniffer頁,路徑是Setting->Languages and Frameworks->PHP->Quality Tools->Code Sniffer,設置phpcs的路徑
Composer全局的vendor目錄inphpcs.bat
3、到Inspections頁,路徑Setting->Editor->Inspections,右側的 PHP,勾選下面的兩個 PHP,選擇使用 PSR2
現在使用PhpStorm的格式化,將會自動格式化成psr-2的風格
經過上面的操作,PhpStorm代碼格式化的規則基本與phpcs的規則基本一致了,但也有一小部分不一致,所以后面還要用到phpcs和phpcbf
如果每次都在終端去執行花費時間可不少,為了提高工作效率,可以在PhpStorm集成phpcbf、phpcs檢測規范的功能
設置路徑:Tools -> External Tools
集成phpcbfProgram是你的PHP根目錄下的文件,windows是.bat文件
Arguments是--standard=PSR2 $FileDir$/$FileName$,記得指定代碼標準
Working directory是$ProjectFileDir$,也可以直接填
下面的Open console for tool output是指打印檢測的信息到控制臺上,phpcs檢測的我們要看,phpcbf就不用了,所以不用勾選
怎么使用呢?
工具欄的Tools->External Tools就可以看到我們剛才添加的兩個小工具,直接點擊就可以用了
點擊操作很麻煩, 那就加一個快捷鍵吧:
在 Settings -> Keymap -> External Tools -> phpcbf 中進行添加快捷鍵操作
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/31415.html
摘要:腳本對文件定義了一系列的代碼規范通常使用官方的代碼規范標準,比如的,能夠檢測出不符合代碼規范的代碼并發出警告或報錯可設置報錯等級。比如規范中對每一個文件的結尾都需要有一行空行,那么運行這個腳本后就能自動在結尾處加上一行空行。 showImg(https://segmentfault.com/img/remote/1460000011338137); 有些同學可能還沒聽過這東西,大概介紹...
摘要:背景在公司開發的時候,每次不管還是提交代碼的時候都會對代碼進行簡單的自動檢測。并且明確告知文檔不可能的。猜想應該自動代碼檢測肯定是集成在工程代碼所在的服務端是最好的。寫在最后通過了解代碼的自動檢測,發現了很多問題。 背景 在公司開發的時候,每次不管svn還是git提交代碼的時候都會對代碼進行簡單的自動檢測。檢查不了代碼邏輯,但是最起碼能保證整體的編碼格式保持一致。這個功能還是挺有用的,...
摘要:標準規范簡介是的簡寫,由組織制定的規范,是開發的實踐標準。具體標準有有了統一編碼風格規范,更有利于查看和學習各個框架或類庫,不不需要每次都適應新的編碼風格。同時在開發團隊內部使用統一的編碼規范更有利于代碼審查版本控制團隊內部交流。 PHP 標準規范 PSR PSR 簡介 PSR 是 PHP Standard Recommendations 的簡寫,由 PHP FIG 組織制定的 PHP...
摘要:使用進行代碼規范化管理是一個優秀的代碼風格檢測工具定義了一系列的代碼規范通常使用官方的代碼規范標準,比如的能夠檢測出不符合代碼規范的代碼并發出警告或報錯可設置報錯等級常被用作團隊開發時維護編碼風格以及標準。 PHPStorm IDE使用CodeSniffer進行代碼規范化管理 PHP_CodeSniffer是一個優秀的代碼風格檢測工具,定義了一系列的代碼規范(通常使用官方的代碼規范標準...
摘要:的編碼規范雖然沒有像那樣集中,有這樣的統一標準見我的這篇文章,但也是有規律可循的。最簡單的莫過于直接使用,但是真的實在太弱了,所以目前業界比較流行的是使用,簡稱。在代碼規范方面,沒有所謂的個人喜好,而只有項目規范。所以目前以及都開始遵循。 php的編碼規范雖然沒有像javascript那樣集中,有eslint這樣的統一標準(見我的這篇文章),但也是有規律可循的。最簡單的莫過于直接使用p...
閱讀 1261·2023-04-25 19:10
閱讀 1140·2021-09-10 10:50
閱讀 3028·2021-09-02 15:21
閱讀 1383·2019-08-30 15:52
閱讀 1681·2019-08-30 13:56
閱讀 2077·2019-08-30 12:53
閱讀 1870·2019-08-28 18:22
閱讀 2115·2019-08-26 13:47