php如何添加php-psr2语法规范检测

任何语言的语法规范至关重要,特别是在团队协作过程中。

以下以php的laravel框架为主,通过gitpre-commit钩子(hooks)来实现php语法规范检测。

其流程无非是

  1. 添加语法检测器
  2. 添加配置pre-commit(在git执行git commit操作开始前所执行的脚本)

开始

  1. 使用composer安装php_codesniffer

    composer global require "squizlabs/php_codesniffer=*" --dev
    
  2. 添加pre-commit
    使用s0enke大神的git-hooks ,将pre-commit (文件名没有任何后缀)下载到本地项目的.git/hooks/

  3. 配置pre-commit

    修改pre-commit配置信息如下:

    // 检测程序
    PHPCS_BIN=./vendor/bin/phpcs
    // 检测php语法标准
    PHPCS_CODING_STANDARD=PSR2
    /// 忽略检测文件
    PHPCS_IGNORE="*.blade.php,*.js,*.css"
    

    修改pre-commit权限(很重要)

    chmod -R 755 .git/hooks/pre-commit
    

其他

  1. Php-psr2规范检测
  1. pre-commit文件代码(为了方便读者使用)

    #!/bin/bash
    # PHP CodeSniffer pre-commit hook for git
    #
    # @author Soenke Ruempler <soenke@ruempler.eu>
    # @author Sebastian Kaspari <s.kaspari@googlemail.com>
    #
    # see the README
    
    PHPCS_BIN=./vendor/bin/phpcs
    PHPCS_CODING_STANDARD=PSR2
    PHPCS_IGNORE="*.blade.php,*.js,*.css"
    TMP_STAGING=".tmp_staging"
    
    # parse config
    CONFIG_FILE=$(dirname $0)/config
    if [ -e $CONFIG_FILE ]; then
        . $CONFIG_FILE
    fi
    
    # simple check if code sniffer is set up correctly
    if [ ! -x $PHPCS_BIN ]; then
        echo "PHP CodeSniffer bin not found or executable -> $PHPCS_BIN"
        exit 1
    fi
    
    # stolen from template file
    if git rev-parse --verify HEAD
    then
        against=HEAD
    else
        # Initial commit: diff against an empty tree object
        against=897dfbffbfe18a52174d999c6d83bd16219d6e08
    fi
    
    # this is the magic: 
    # retrieve all files in staging area that are added, modified or renamed
    # but no deletions etc
    FILES=$(git diff-index --name-only --cached --diff-filter=ACMR $against -- )
    
    if [ "$FILES" == "" ]; then
        exit 0
    fi
    
    # create temporary copy of staging area
    if [ -e $TMP_STAGING ]; then
        rm -rf $TMP_STAGING
    fi
    mkdir $TMP_STAGING
    
    # match files against whitelist
    FILES_TO_CHECK=""
    for FILE in $FILES
    do
        echo "$FILE" | egrep -q "$PHPCS_FILE_PATTERN"
        RETVAL=$?
        if [ "$RETVAL" -eq "0" ]
        then
            FILES_TO_CHECK="$FILES_TO_CHECK $FILE"
        fi
    done
    
    if [ "$FILES_TO_CHECK" == "" ]; then
        exit 0
    fi
    
    # execute the code sniffer
    if [ "$PHPCS_IGNORE" != "" ]; then
        IGNORE="--ignore=$PHPCS_IGNORE"
    else
        IGNORE=""
    fi
    
    if [ "$PHPCS_SNIFFS" != "" ]; then
        SNIFFS="--sniffs=$PHPCS_SNIFFS"
    else
        SNIFFS=""
    fi
    
    if [ "$PHPCS_ENCODING" != "" ]; then
        ENCODING="--encoding=$PHPCS_ENCODING"
    else
        ENCODING=""
    fi
    
    if [ "$PHPCS_IGNORE_WARNINGS" == "1" ]; then
        IGNORE_WARNINGS="-n"
    else
        IGNORE_WARNINGS=""
    fi
    
    # Copy contents of staged version of files to temporary staging area
    # because we only want the staged version that will be commited and not
    # the version in the working directory
    STAGED_FILES=""
    for FILE in $FILES_TO_CHECK
    do
      ID=$(git diff-index --cached $against $FILE | cut -d " " -f4)
    
      # create staged version of file in temporary staging area with the same
      # path as the original file so that the phpcs ignore filters can be applied
      mkdir -p "$TMP_STAGING/$(dirname $FILE)"
      git cat-file blob $ID > "$TMP_STAGING/$FILE"
      STAGED_FILES="$STAGED_FILES $TMP_STAGING/$FILE"
    done
    
    OUTPUT=$($PHPCS_BIN -s $IGNORE_WARNINGS --standard=$PHPCS_CODING_STANDARD $ENCODING $IGNORE $SNIFFS $STAGED_FILES)
    RETVAL=$?
    
    # delete temporary copy of staging area
    rm -rf $TMP_STAGING
    
    if [ $RETVAL -ne 0 ]; then
        echo "$OUTPUT" | less
    fi
    
    exit $RETVAL
    

原文地址:http://www.fidding.me/article/48

happy coding!!!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,635评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,628评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,971评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,986评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,006评论 6 394
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,784评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,475评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,364评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,860评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,008评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,152评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,829评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,490评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,035评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,156评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,428评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,127评论 2 356

推荐阅读更多精彩内容