README

此包是一个易于使用的集成编码标准包。它允许您在几秒钟内将您的代码与代码质量方面最受欢迎的工具进行比较，并清楚地了解：您是冠军吗？还是您还需要改进？（如果您正在阅读此内容，您已经是冠军了！）

安装

标准是在开发过程中使用的包，您可以使用 Composer 进行安装。

单个项目内

使用 composer 将包添加为开发依赖项

composer require --dev natepage/standards

您现在可以运行标准工具如下

cd my-project
php vendor/bin/standards

多个项目

如果您同时正在处理多个项目（冠军的情况肯定如此），您可以将包安装为全局依赖项并在所有项目中运行它

composer global require natepage/standards

为了使您的生活更轻松，您可以将标准设置为本地二进制文件，以便从任何地方方便地运行它

# If your operating system doesn't have /usr/local/bin/ create it
mkdir /usr/local/bin

# Create a symlink of standards in your local bin
ln -s ~/.composer/vendor/natepage/standards/bin/standards /usr/local/bin/standards

然后您可以在项目中运行它

cd my-project
standards # Run standards tools

cd my-project2
standards # Run standards tools

工具

默认工具

默认情况下，标准包含一组可立即使用的工具，并提供了一种轻松自定义每个工具不同选项的方式。有关这些工具的更多信息，请直接查看它们的文档。

EasyCodingStandard：以零知识开始使用 PHP CS Fixer 和 PHP_CodeSniffer 的最简单方法
PHPCPD：PHP 代码的复制/粘贴检测器（CPD）
Paratest：PHPUnit 的并行测试
PHPMD：在给定的 PHP 代码库中查找多个潜在问题
PHPStan：PHP 静态分析工具 - 在运行代码之前发现代码中的错误
PHPUnit：在 PHP 应用程序中运行单元测试
SecurityChecker：PHP 安全漏洞监控

使用方法

独立

使用 composer 在现有项目或作为全局依赖项要求包后，您可以使用以下二进制文件从您最喜欢的终端运行工具来对您的代码进行操作

# Using the link created by composer
cd my-project
php vendor/bin/standards

# Using the binary directly
cd my-project
php vendor/natepage/standards/bin/standards

配置

标准通过一系列可配置的选项为您提供所有所需的灵活性。其中大多数都有默认值，您可以根据需要覆盖这些值。

配置文件

如果您想每次运行标准时都覆盖配置，您可以在项目根目录中创建一个 standards.yaml 文件。

命令行输入选项

在运行标准时，您可以在运行时传递输入选项以覆盖任何公开的配置。

standards --only=phpcs,phpmd --phpcs.show-sniff-name=false

要了解更多有关所有可用输入选项的信息，请使用 -h|-help 选项显示完整列表。

natpage / 标准

维护者

详细信息