README

编码规范

该仓库包含配置 PHP Code Sniffer 和 PHP Mess Detector 所需的所有文件。

使用 composer 安装

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

composer require "philippwitzmann/codingstandard" "~2"

用法

从终端（命令行界面）

PHP Code Sniffer

要执行 PHP Code Sniffer，请按以下步骤操作。

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

PHP Mess Detector

要执行 PHP Mess Detector，请按以下步骤操作。

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

PHPStan

要执行 PHPStan，请按以下步骤操作。

./vendor/bin/phpstan analyse ./path/to ./your/sources

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

如何贡献

如果您想对这个规范做出贡献，以下是操作方法。

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

致谢

没有来自 PHP Code Sniffer 和 PHP Mess Detector 的出色团队，以及当然，在源代码文件中注明的作者们的巨大努力，这是不可能的。还可以查看来自 Sparhandy 的此规范的原始版本。

philippwitzmann / codingstandard

维护者

详细信息