wpscholar/phpcs-standards-installer

PHP Code Sniffer 标准的自定义 Composer 安装器。

维护者

详细信息

github.com/wpscholar/phpcs-standards-installer

源代码

问题

安装: 291

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 0

开放性问题: 0

类型：composer-plugin

1.0 2018-11-21 07:13 UTC

Requires

GPL-2.0-or-later f6d7c0209327924f9a3c10cd0194faf6092a139a

  • Micah Wood <micah.woop@wpscholar.com>

This package is auto-updated.

Last update: 2024-09-21 21:47:14 UTC

README

一个用于正确注册 PHP Code Sniffer 标准的 Composer 插件。访问PHP Code Sniffer 编码标准教程了解更多关于创建自定义编码标准/规则集的信息。

创建可安装的编码标准

  1. 为您的 PHP Code Sniffer 编码标准创建一个仓库。
  2. 在您的 composer.json 文件中将类型设置为 phpcs-standards。
  3. 在您的 composer.json 文件中将 PHP Code Sniffer 和此安装器作为依赖项。
    "type": "phpcs-standards",
    "require": {
        "squizlabs/php_codesniffer": "^2.9.2",
        "wpscholar/phpcs-standards-installer": "^1.0"
    }

使用方法

  • 要求任何类型为 phpcs-standards 的 Composer 包。
  • 可选地，将任何 PHP Code Sniffer 配置选项添加到您的 composer.json 文件中的 extra 部分
    "require": {
      "wpscholar/phpcs-standards-wpscholar": "^1.0"
    },
    "extra": {
        "phpcs-config": {
            "default_standard": "WPScholar",
            "testVersion": "5.4-"
        }
    }
  • 运行 composer install！

IDE 集成

由于 PHPCS 的某些 IDE 集成无法在项目根目录外注册您的规则集，因此可能会失败。为了纠正这一点，请将 phpcs.xml 放在项目根目录下

<?xml version="1.0"?>
<ruleset name="Project Rules">
	<rule ref="WPScholar" />
</ruleset>