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阅读 211,948评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,371评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,490评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,521评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,627评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,842评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,997评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,741评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,203评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,534评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,673评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,339评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,955评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,770评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,000评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,394评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,562评论 2 349

推荐阅读更多精彩内容

  • # 「PSR 规范执行」代码标准执行步骤 # 1. 阅读PSR规范 阅读并理解PSR规范,并在代码编写过程中自觉执...
    曦妞琳阅读 630评论 0 0
  • iOS 开发 SVN 版本控制器 更多技术交流请加群 iOS技术联盟 27512466 SVN是Subversio...
    Sunny_Fight阅读 8,753评论 7 63
  • 是什么 如果你知道yum、apt-get、npm、bower等命令中的一种或者多种,那么,你也能很快知道compo...
    旱魃一样阅读 3,120评论 0 9
  • 说明:姗妈带娃期间自学画画,如果你也想画,我们一起同行吧。 所需要工具:油性彩色铅笔、肯特纸、橡皮擦。 步骤如下:...
    贝怡亲子漫画阅读 370评论 0 1
  • 有人说我们闭上眼睛后发生的事情是在做梦 那会不会我们睁开眼睛后发生的事情才是在做梦呢? 真实的生活与不真实的梦境 ...
    墨香黎阅读 136评论 0 0