开发规范

    PSR-4 基础目录使用小写，其它依次使用大驼峰法命名，例如。

    其中 composer 配置

    1. "autoload": {
    2.     "psr-4": {
    3.         "App\\" : "application/app",
    4.         "Admin\\" : "application/admin",
    5.         "Common\\" : "common"
    6.     }
    7. }

    不存在类文件，请使用小写目录，其文件也一样:

    1. /data/codes/queryphp/option/
    2. /data/codes/queryphp/option/app.php

    统一代码风格

    在使用前您需要安装 ，这样子才能够进行下面的工作。

    可以通过下面的方式来格式化代码风格:

    1. $cd /data/codes/queryphp
    2. $php-cs-fixer fix --config=.php_cs.dist
    1. /data/codes/queryphp/build/pre-commit.sh
    2. /data/codes/queryphp/vendor/hunzhiwange/framework/build/pre-commit.sh

    应用脚本 /data/codes/queryphp/build/pre-commit.sh

    核心包脚本 /data/codes/queryphp/build/pre-commit.sh

    1. #!/bin/bash
    2. #
    3. # check PHP code syntax error and standard with phpcs
    4. # https://blog.csdn.net/xsgnzb/article/details/52222366?locationNum=4&fps=1
    5. # https://blog.csdn.net/ljihe/article/details/80826071
    6. # =================== how to use ====================
    8. # git commit -h
    9. # ==================== end ==========================
    11. PROJECT=$(git rev-parse --show-toplevel)
    12. cd $PROJECT
    13. SFILES=$(git diff --cached --name-only --diff-filter=ACMR HEAD | grep \\.php)
    15. # Determine if a file list is passed
    16. if [ "$#" -ne 0 ]
    17. then
    18.     exit 0
    19. fi
    21. echo "Checking PHP Lint..."
    23. for FILE in $SFILES
    24. do
    25.     php -l -d display_errors=0 $FILE
    26.     if [ $? != 0 ]
    27.     then
    28.         echo "Fix the php error before commit."
    29.         exit 1
    30.     fi
    31.     FILES="$FILES $PROJECT/$FILE"
    32. done
    35. then
    36.     echo "Running Code Sniffer..."
    38.     isCheck=""
    40.     for FILE in $SFILES
    41.     do
    42.         result=`~/.composer/vendor/bin/php-cs-fixer fix $FILE --config=.php_cs.dist`
    44.         if [ "$result" != "" ]
    45.         then
    46.             echo $result
    47.             isCheck=$result
    48.             git add $FILE
    49.         fi
    50.     done
    52.     if [ "$isCheck" != "" ]
    53.     then
    54.         echo "The file has been automatically formatted."
    55.     fi
    56. fi
    58. git update-index -g
    60. exit $?

      上述脚本就会自动运行帮助你格式化代码,你也可以忽略脚本。

      这样子我们再也不需要浪费时间在无意义的代码风格的讨论上了。