README

“如果你没有时间把事情做对，你就有时间把事情做错。”

这本质上是一个Composer元软件包，创建了一种快速、简便、便捷的方式安装所有PHP质量保证工具。

内容

通过依赖此软件包，您将获得以下工具

代码检查器/修复器

JSON Lint: PHP的JSON Lint
PHP编码标准修复器: 一个自动修复PHP编码标准问题的工具
PHP Parallel Lint: 以比串行检查更快的速度检查PHP文件的语法，并具有更花哨的输出
PHP_CodeSniffer: 检测违反定义的编码标准

质量支持

GrumPHP: PHP质量保证工具的Githooks
PHP_Depend: PHP的软件度量
PHPCPD: 复制/粘贴检测器
PHPLOC: 快速测量PHP项目的规模
PHPMD: PHP混乱检测器
PhpMetrics: PHP的静态分析工具
SensioLabs安全检查器: 检查已知安全漏洞的依赖项

与测试相关

Codeception: PHP的现代全栈测试框架
ParaTest: PHPUnit的并行测试
PHPUnit: PHP的测试框架

其他

您将获得的其他软件包

Composer版本检查: 检查软件包是否更新到最新的主要版本
Deployer: PHP的部署工具
Deployer食谱: 与Deployer集成的第三方食谱
Phinx: Phinx使得管理PHP应用程序的数据库迁移变得非常容易
PHP_CodeSniffer Composer Installer: 用于安装PHP_CodeSniffer编码标准
PHPCompatibility: PHP_CodeSniffer的PHP兼容性检查
Prestissimo: Composer并行安装插件
Tombstone Analyzer: Tombstones的报告生成

建议

以下软件包被建议

Behat：以场景为中心的BDD框架
ApiGen：为您的PHP项目提供智能且易读的文档
Mockery：一个简单而灵活的PHP模拟对象框架
PHP_CodeBrowser：一个增强代码的代码浏览器，包含来自各种QA工具的信息
phpcov：PHP_CodeCoverage库的命令行前端
phpDocumentor：PHP的文档生成器
phpDox：PHP的文档生成器
Sami：API文档生成器

用法

这是一个简单的元包，可以以两种不同的方式使用；全局安装或按项目安装。

两种方法都有其优点（+）和缺点（-）。

全局安装:

+ 所有工具都存在于系统的任何地方
+ 可以用于任何代码库，甚至是那些不使用Composer的代码库。
- 由于它不是一个项目，版本管理不是管理的，您需要手动更新。

按项目安装:

+ 版本管理（更新/安装）由项目提供
- 工具不可在系统范围内使用。您需要从特定路径运行它们。

这些方法不是互斥的。您可以拥有全局安装的版本，可以在任何地方使用，但仍然可以使用项目提供的版本。

安装

全局安装

以下脚本将为您安装全局Composer，包括QA工具。

bash <(curl -S https://raw.githubusercontent.com/Dealerdirect/php-qa-tools/master/bin/install.sh)

就是这样。这可以放在任何说明中，如README或某人的博客，因为逻辑在shell脚本中。如果您通过https下载脚本，该文件具有标准级别的认证和加密，以防止篡改。我们还使用GPG密钥签名安装，这样您就可以检查下载的发布签名是否与Dealerdirect的公钥匹配。

gpg --keyserver hkp://keys.gnupg.net --recv-keys C4133165DF5EB4BAEABDADCACF1E7823C5339B59
curl -O https://raw.githubusercontent.com/Dealerdirect/php-qa-tools/master/bin/install.sh
curl -O https://raw.githubusercontent.com/Dealerdirect/php-qa-tools/master/bin/install.sh.sig
gpg --verify install.sh.sig
bash install.sh

这显然是一个shell脚本，如果您真的担心它可能包含恶意活动，您可以在运行它之前轻松地查看它。

curl -O https://raw.githubusercontent.com/Dealerdirect/php-qa-tools/master/bin/install.sh
less install.sh
bash instal.sh

如果您已经有一个全局Composer设置，您可以手动包含工具，而无需运行上面的shell脚本。

composer global require "dealerdirect/qa-tools:*"

按项目安装

另一种选择是在每个项目上安装它。

使用Composer（首选方法）

composer require --dev "dealerdirect/qa-tools"

或修改您的composer.json以在require-dev部分包含dealerdirect/qa-tools

{
  "name": "acme/my-project",
  "require": {
    "…": "*"
  },
  "require-dev": {
    "dealerdirect/qa-tools": "*"
  }
}

贡献

这是一个活跃的开源项目。我们始终欢迎那些想使用代码或为其做出贡献的人。

我们为我们的贡献指南建立了单独的文档。

感谢您的参与！😍

作者和贡献者

此存储库的原始想法和设置是由Dealerdirect的员工Franck Nijhof提出的。

要查看所有作者和/或贡献者的完整列表，请查看贡献者页面。

在Dealerdirect工作

Dealerdirect一直在寻找充满活力和勤奋的开发人员和DevOps工程师。

对在Dealerdirect工作感兴趣？那么请确保查看我们的职位空缺。

没有找到合适的职位空缺？只需联系我们！

dealerdirect.com

许可证

MIT 许可协议 (MIT)

特此授予任何人免费获取本软件及其相关文档副本（以下简称“软件”）的权利，以无限制地处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向其提供软件的人进行此类操作，但须遵守以下条件：

dealerdirect / qa-tools

维护者

详细信息