README

Sparhandy 编码标准

此仓库包含根据我们的编码标准配置 PHP Code Sniffer 和 PHP Mess Detector 所需的所有文件。

使用 composer 安装

目前您必须使用 dev-master 版本。

composer require "sparhandy/codingstandard" "dev-master"

使用方法

从终端（命令行界面）

PHP Code Sniffer

要执行为 sparhandy 编码标准配置的 PHP Code Sniffer，请按照以下步骤操作。

./vendor/bin/phpcs --extensions=php --standard=./vendor/sparhandy/codingstandard/src/phpcs/Production/ruleset.xml ./path/to ./your/sources 

PHP Mess Detector

要执行为 sparhandy 编码标准配置的 PHP Mess Detector，请按照以下步骤操作。

./vendor/bin/phpmd ./path/to ./your/sources text ./vendor/sparhandy/codingstandard/src/phpmd/phpmd.xml --suffixes php

Travis-CI 配置

要在您的 Travis-Ci 配置文件中使用，请根据以下示例进行修改，并将其保存到根目录下的 .travis.yml 中。

language: php

php:
  - 5.4
  - 5.5
  - 5.6
  - 7.0

matrix:
  allow_failures:
    - php: 7.0

before_script:
  - composer self-update

install: travis_retry composer update

script:
  - ./vendor/bin/phpmd ./path/to ./your/sources text ./configuration/phpmd/phpmd.xml --suffixes php
  - ./vendor/bin/phpcs --extensions=php --standard=./configuration/phpcs/Production/ruleset.xml ./path/to ./your/sources

如何贡献

如果您想为标准做出贡献，以下是操作方法。

• 从 Sparhandy/CodingStandard 创建一个分支。
• 从 master 创建您的分支并提交您的更改。
• 将您的分支推送到您的分支。
• 在 GitHub 上创建一个拉取请求。
• 与我们就您的拉取请求进行讨论。
• 然后我们的开发者将合并或关闭拉取请求。

致谢

如果没有 PHP Code Sniffer（https://github.com/squizlabs/PHP_CodeSniffer）和 PHP Mess Detector（https://github.com/phpmd/phpmd）的好人们的巨大努力以及当然是在源文件中注释的作者的努力，这一切都是不可能的。