README

简介

Canary为stickee Laravel项目提供代码检查和静态分析。

它包括

stickee的PHP CS Fixer配置，以遵守我们的代码风格
stickee的Larastan配置，用于分析您的代码
stickee的Rector配置，用于重构您的代码
运行包含工具的快捷方式
安装命令

Husky和Lint Staged

Lint Staged可以用于检查暂存文件，而Husky可以用于管理调用它的预提交钩子。

安装命令会复制示例配置，但在运行它之前您必须安装这些工具。

安装

mkdir -p tools/canary
composer require --working-dir=tools/canary stickee/canary
tools/canary/vendor/bin/canary install

为什么我们要将工具安装到自己的目录中？

您应该提交这个新目录和安装的配置文件。

使用方法

Canary提供了一个统一的、解耦的平台，用于利用我们stickee大量使用的强大的代码检查和静态分析工具。

选项

为了通过选项，您必须在它们后面写上--。

tools/canary/vendor/bin/canary analyse -- -c phpstan.ci.neon --error-format=github

命令

`analyse`

PHPStan

tools/canary/vendor/bin/canary analyse -- -c phpstan.dist.neon

此命令将对您的整个项目执行静态分析。

它应该在pre-commit钩子中运行。

有关详细信息，请参阅stickee/larastan-config。

`fix`

PHP CS Fixer

tools/canary/vendor/bin/canary fix -- --config .php-cs-fixer.dist.php

此命令将尝试修复一些小的代码风格问题。

它可以针对单个文件运行。

它应该在pre-commit钩子中针对暂存文件运行。

有关详细信息，请参阅stickee/php-cs-fixer-config。

`suggest`

Rector在--dry-run模式下

tools/canary/vendor/bin/canary suggest

此命令将在终端中显示作为差异的建议改进。

任何建议的改进都必须手动执行或可以运行improve命令来自动执行。

有关详细信息，请参阅stickee/rector-config。

`improve`

Rector

tools/canary/vendor/bin/canary improve

此命令将尝试通过重构您的代码来改进它。

任何改进的代码在提交之前必须进行检查。

它可以针对单个文件运行。

它不应该作为pre-commit钩子的一部分运行。

有关详细信息，请参阅stickee/rector-config。

注意

您可能会发现将这些建议作为Git补丁添加很有用。

您可以使用编辑器中的Git集成或将改进作为补丁暂存。

git add <file> -p

贡献

欢迎贡献！Canary 使用 Laravel Zero 编写。对任何合并的开源工具的改进应直接指向它们各自的仓库。

我们鼓励您提供测试，这些测试使用的是 Pest 测试框架编写的。

许可证

Canary 是开源软件，根据 MIT 许可证许可。

stickee / canary

维护者

详细信息