grnrbt/php-lint

绿色兔子代码检查配置

维护者

详细信息

github.com/grnrbt/php-lint

主页

源代码

问题

安装: 9

依赖: 0

建议: 0

安全性: 0

星标: 3

关注者: 4

分支: 0

开放问题: 0

dev-master 2017-02-27 13:43 UTC

Requires

MIT b7357fd690c3dc704acf933f8056881e89e94220

  • Artur Krotov <artur.woop@greenrabbit.ru>

phpcscodesnifferCodestylephp lint

This package is not auto-updated.

Last update: 2024-09-15 02:46:24 UTC

README

PHP-Lint 是一个基于 PHP_CodeSniffer 的简化 PHP 代码检查解决方案。

目前它只支持作为 HG 挂钩，GIT 挂钩即将推出。

当前规则集正在开发中。它包括 PSR1、PSR2、PEAR、PHPCompatibility、Yii2 编码标准，以及一些 Squiz 和通用规则。

安装

安装通过 Composer 实现。

在控制台输入

composer require --dev grnrbt/php-lint "*"

或在 composer.json 文件的 require-dev 部分添加以下行。

"grnrbt/php-lint": "*"

使用方法

HG 挂钩
仅检查存储库中的暂存文件，因此可以添加到现有存储库中而不会与旧文件发生问题。

将以下代码添加到 .hg/hgrc 文件或 HG 客户端设置中

[hooks]
pretxncommit.hglint = vendor/bin/lint

在 Windows 上

[hooks]
pretxncommit.hglint = vendor\bin\lint.bat

要跳过检查，请在控制台中使用带有 ENV 参数 NO_VERIFY=1 的提交运行

NO_VERIFY=1 hg ci -u <user> -m <message>

手动运行
您可以从控制台手动运行带有规则集的检查器

$ ./vendor/bin/lint

它将检查暂存文件或运行 CodeSniffer 本身

$ ./vendor/bin/phpcs --extensions=php --standard=/vendor/grnrbt/php-lint/ruleset.xml <dir>

检查选择的目录 <dir>

PHPStorm
如果您正在使用 PhpStorm，您可以通过设置 → 语言和框架 → PHP → Code Sniffer 配置它以使用 CodeSniffer。

自定义规则

您可以通过在项目的根目录中放置文件 ruleset.xml 来覆盖标准规则。在该文件中，您可以将原始文件包含进来并添加自己的规则或禁用已添加到通用规则集中的规则。

<?xml version="1.0"?>
<ruleset name="Custom Standard">
    <description>A custom coding standard</description>

    <exclude-pattern>*/tests/*</exclude-pattern>
    
    <rule ref="/vendor/grnrbt/php-lint/ruleset.xml"/>
    
    <!-- custom rules, overrides -->
</ruleset>

链接