yuutahaga/wpcs-psr2

PHP_CodeSniffer 规则集,用于强制执行 WordPress & PSR-2 编码规范

安装: 29

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型:phpcodesniffer-standard

v1.0.3 2019-03-22 11:36 UTC

This package is auto-updated.

Last update: 2024-09-23 00:14:10 UTC


README

PHP_CodeSniffer 规则集,用于强制执行 WordPress & PSR-2 编码规范

简介

一个规则集,结合了 WordPress 编码规范PSR-2。目标是减少与其他 PHP 应用程序编码规范之间的差异,以减轻开发者的压力。

安装

自动安装

composer.json 中添加以下脚本

{
  "scripts": {
    "install-codestandards": ["Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin::run"],
    "post-install-cmd": ["@install-codestandards"]
  }
}
composer require --dev dealerdirect/phpcodesniffer-composer-installer
composer require --dev yutahaga/wpcs-psr2

手动安装

composer require --dev yutahaga/wpcs-psr2
phpcs --config-set installed_paths ./vendor/yutahaga/wpcs-psr2,./vendor/wp-coding-standards/wpcs,other-ruleset

用法

以下是一个 phpcs.xml 的示例

<?xml version="1.0"?>
<ruleset name="My Coding Standards">
  <description>My Coding Standards extends WordPress-Extra and PSR-2</description>

  <rule ref="WordPress-PSR2" />

  <file>./app</file>
  <file>./bootstrap</file>
  <file>./config</file>
  <file>./functions.php</file>

  <exclude-pattern>bootstrap/cache/*.php</exclude-pattern>
  <exclude-pattern>*/*.js</exclude-pattern>
  <exclude-pattern>*/*.css</exclude-pattern>
  <exclude-pattern>*/*.xml</exclude-pattern>
  <exclude-pattern>*/node_modules/*</exclude-pattern>
  <exclude-pattern>*/vendor/*</exclude-pattern>
</ruleset>