PHP代碼規范檢測 - SVN服務端配置

代碼質量的檢測插件有很多,這里只拿最基本的PSR做介紹。
長期以來,我們一直再做自己的代碼規范,對新入職的員工進行培訓。然而,效果卻不是特別好。

代碼規范不能順利執行的主要原因有以下幾點:

  • 1:技術行業人員流動性太大
  • 2:培訓后,沒有后續的監督,因此執行情況不樂觀
  • 3:有些有爭議的點,內部制定的規范很難做出讓人信服的標準(比如是用tab還是4個空格,真是一件值得干一架的事)

PSR規范的優勢:

  • 1:PSR由一批行業的知名人士制定,基本能使大多數人信服(解決以上第3個問題)
  • 2:PSR規范自帶了規范檢測程序。代碼只需要經過檢測程序,就可以知道代碼是否符合規范。(解決以上第2個問題)
  • 3:規范檢測程序可以安裝在svn/git服務端,就算開發人員離職。新的開發人員只需要按照PSR規范來執行即可(解決以上第1個問題)

** PSR還自帶了自動修復程序,可以自動修復代碼中不規范的地方。以后再介紹在sublime中配置代碼的自動檢測、修復。以下介紹在svn服務端安裝規范檢測。安裝之后,不符合規范的代碼將不再允許提交。**

PSR檢測程序在SVN服務端的配置(Linux為例):

  • 1:PSR檢測程序“PHP_CodeSniffer”的安裝:
    github地址:https://github.com/squizlabs/PHP_CodeSniffer

    • 安裝方式一(如果linux服務端已經安裝了php的工具pear):

      pear install PHP_CodeSniffer
      

    安裝之后 php/bin目錄會多3個可執行文件: phpcbf、phpcs、scripts/phpcs-svn-pre-commit。svn服務端主要使用的是:scripts/phpcs-svn-pre-commit*

    • 安裝方式二(如果linux服務端已經安裝了composer)
      composer global require "squizlabs/php_codesniffer=*"

會安裝到目錄: ~/.composer/vendor/bin/ 。
但是phpcs-svn-pre-commit不在這個目錄,而是在目錄 ~/.composer/vendor/squizlabs/php_codesniffer/scripts/。下面使用時要注意目錄路徑

  • 2:svn服務端配置hooks

      vim /svndir/projectDir/hooks/pre-commit
    
    #!/bin/bash
    REPOS="$1"
    TXN="$2"

    SVNLOOK="/usr/bin/svnlook"
    PHP="/usr/bin/php"

    LOG=$($SVNLOOK log -t "$TXN" "$REPOS")

    if [ "$LOG" = "" ]; then
          echo "Please input log" 1>&2
          exit 1
    fi

    FILES=$($SVNLOOK changed -t "$TXN" "$REPOS" | awk '/^[AU]/ {print $NF}')

    for FILE in $FILES; do
        CONTENT=$($SVNLOOK cat -t "$TXN" "$REPOS" "$FILE")

        if echo "$CONTENT" | grep -q $'\xEF\xBB\xBF'; then
            echo "Please remove BOM from $FILE" 1>&2
            exit 1
        fi

        if [[ "$FILE" =~ \.(php|html)$ ]]; then
            MESSAGE=$(echo "$CONTENT" | $PHP -l 2>&1)

            if [ $? -ne 0 ]; then
                echo "$MESSAGE" | sed "s/ -/ $FILE/g" 1>&2
                exit 1
            fi
        fi
    done

    /path/to/PHP_CodeSniffer/scripts/phpcs-svn-pre-commit "$REPOS" -t "$TXN" 1>&2 || exit 1

    exit 0

3:特別重要:一定要給pre-commit加可執行權限

    chmod +x /path/pre-commit

4:安裝之后,寫一個不符合PSR規范的代碼,執行svn commit試一下,svn服務端會返回不規范代碼所在行號及代碼的錯誤

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,428評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,024評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,285評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,548評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,328評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,878評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,971評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,098評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,616評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,554評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,725評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,243評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,971評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,361評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,613評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,339評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,695評論 2 370

推薦閱讀更多精彩內容

  • # 「PSR 規范執行」代碼標準執行步驟 # 1. 閱讀PSR規范 閱讀并理解PSR規范,并在代碼編寫過程中自覺執...
    曦妞琳閱讀 641評論 0 0
  • iOS 開發 SVN 版本控制器 更多技術交流請加群 iOS技術聯盟 27512466 SVN是Subversio...
    Sunny_Fight閱讀 8,800評論 7 63
  • 是什么 如果你知道yum、apt-get、npm、bower等命令中的一種或者多種,那么,你也能很快知道compo...
    旱魃一樣閱讀 3,146評論 0 9
  • 說明:姍媽帶娃期間自學畫畫,如果你也想畫,我們一起同行吧。 所需要工具:油性彩色鉛筆、肯特紙、橡皮擦。 步驟如下:...
    貝怡親子漫畫閱讀 376評論 0 1
  • 有人說我們閉上眼睛后發生的事情是在做夢 那會不會我們睜開眼睛后發生的事情才是在做夢呢? 真實的生活與不真實的夢境 ...
    墨香黎閱讀 144評論 0 0