mnapoli/sniff

此包已被弃用且不再维护。未建议替代包。

一个简单的PHP代码检查和修复工具

维护者

详细信息

github.com/mnapoli/sniff

源代码

问题

安装: 48

依赖: 0

建议者: 0

安全: 0

星标: 14

关注者: 3

分支: 0

开放问题: 2

0.1.3 2017-04-30 18:30 UTC

Requires

Requires (Dev)

MIT 342506bfff9ed77a06a531bea5f05ae9fe591ca4

This package is auto-updated.

Last update: 2020-01-19 10:54:33 UTC

README

这是一个简单的PHP代码检查器，基于 PHP-CS-Fixer 构建。

此项目已被 Pretty 取代

Build Status

为什么？

PHP-CS-Fixer 可以验证和修复代码的格式。

Sniff 是一个命令，用于封装 php-cs-fixer 以使其更容易使用和配置。

它简化为一个简单的 .sniff.json 文件和 3 个命令

$ sniff validate

验证您的代码是否符合编码标准。在 CI 中，它可以在每个 pull request 或 commit 时运行。

$ sniff diff

验证您的代码是否符合编码标准，并输出必要的差异来修复错误。在应用修复前进行审查非常有用。

$ sniff fix

修复您的代码以使其符合编码标准。

安装

composer require mnapoli/sniff

您可以使用以下命令调用该命令：

$ vendor/bin/sniff

您也可以使用 Composer 全局安装它，以便能够使用 sniff 调用它

  • composer global require mnapoli/sniff
  • 将 ~/.composer/bin 路径添加到您的 PATH

配置

Sniff 使用 .sniff.json 文件进行配置

{
    "paths": [
        "src",
        "tests"
    ],
    "rules": {
        "@PSR2": true
    },
    "allow-risky": true
}
  • paths （必需）：要分析的目录或文件列表
  • rules （默认：@PSR2）：要启用的规则列表（以下详细介绍）
  • allow-risky （默认：否）：允许您设置是否运行风险规则（风险规则是可能改变代码行为的规则）

规则列表的完整详细信息请参阅 PHP-CS-Fixer 的文档。

以下是一个示例，启用了 PSR-2 + Symfony 编码标准，以及一些自定义选项

{
    "paths": [ ... ],
    "rules": {
        "@PSR2": true,
        "@Symfony": true,
        "array_syntax": {
            "syntax": "short"
        },
        "blank_line_before_return": false
    }
}

贡献

要运行测试

$ composer tests

致谢

此项目仅是 PHP-CS-Fixer 的一小部分包装，衷心感谢该工具的贡献者。

Sniff 受到 Coke 的极大启发，Coke 是 PHP Code Sniffer 的一个很好的包装器。

许可

Sniff 在 MIT 许可证 下授权。