bigbank/phpcs

此包的最新版本（2.1.0）没有可用的许可证信息。

Bigbank 对 phpcs 的规则

维护者

详细信息

github.com/bigbank-as/phpcs

主页

源代码

问题

安装次数: 9,664

依赖者: 0

建议者: 0

安全性: 0

星标: 2

关注者: 4

分支: 1

公开问题: 1

2.1.0 2016-01-29 10:15 UTC

Requires

Unknown License 27fa478ef2fe584ede917d0813ff3289324e3c69

static analysisstandardsphpcsCode stylebigbank

This package is not auto-updated.

Last update: 2024-09-14 19:31:00 UTC

README

Latest Stable Version on Packagist Software License Total Downloads

PHP_CodeSniffer 是一个 PHP 脚本，它将 PHP 文件标记化以检测违反定义的编码标准的违规行为。它是确保您的代码保持清洁和一致性的基本开发工具。它还可以帮助防止开发者犯下的某些常见语义错误。

这是一个基于 PSR-2（PSR-2）并与之兼容的 Bigbank 定制的 PHP_CodeSniffer 标准。

安装

独立使用

通过 IDE 或手动从 CLI 使用。

  • 克隆仓库
  • 安装 Composer 依赖项： composer install

现在您应该可以从命令行运行 phpcs

$ vendor/bin/phpcs --standard=src/CodeSniffer/Standards/Bigbank <target-file>

PhpStorm 集成

  • 设置 phpcs 可执行文件的路径：文件 -> 设置 -> PHP -> Code Sniffer。将其设置为 <this-repo>/vendor/bin/phpcs
  • 激活 phpcs 检查（按项目）：文件 -> 设置 -> 检查 -> PHP -> PHP Code Sniffer 验证。勾选复选框以激活检查。将编码标准设置为自定义并选择标准目录：<this-repo>/src/CodeSniffer/Standards/Bigbank。

PhpStorm 将现在自动检查您的代码并突出显示错误所在的行。您还可以通过使用 代码 -> 检查代码 来对自定义作用域运行检查。

CI 服务器

通过 Travis 或 Bamboo 等自动化工具使用。

  • 在 composer.json 的 require-dev 部分中要求 bigbank/phpcs
  • 配置 CI 服务器以将 phpcs 作为其静态分析的一部分运行

抑制警告

您可以使用注解手动将代码的部分标记为 phpcs 忽略。

  • @codingStandardsIgnoreStart
  • @codingStandardsIgnoreEnd
  • @codingStandardsIgnoreFile - 标记整个文件为忽略

自动修复错误

您可以自动修复某些错误（例如，文件末尾没有空行），批量（数十个文件）。更多内容，请参阅 自动修复错误。

链接

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

许可证

PHP_CodeSniffer 由 Squiz Labs 开发并拥有。此自定义标准根据 Apache 2.0 许可证（Apache-2.0）许可。有关更多信息，请参阅 许可证文件。