jparkinson1991 / phpcodesniffer-standards
自定义 PHP_Codesniffer 标准
1.4.0
2021-06-07 12:06 UTC
Requires
Requires (Dev)
- roave/security-advisories: dev-master
This package is auto-updated.
Last update: 2024-09-07 19:31:57 UTC
README
本软件包提供了用于与 squizlabs/PHP_CodeSniffer 一起使用的自定义和调整过的 编码标准
编码标准
本软件包提供了以下标准:
JPSR-12
对 PSR-12 编码标准的调整版本,进行了一些小的修改。 查看文档
入门指南
使用本软件包提供的标准与使用 composer 在项目中要求一样简单。
先决条件
如果使用的是旧版本的 PHP_CodeSniffer,本软件包需要 squizlabs/php_codesniffer ^3.0。如果您使用的 PHP_CodeSniffer 版本较旧,将无法安装这些标准。
安装
本软件包基于 dealerdirect/phpcodesniffer-composer-installer 构建,因此安装过程与以下步骤相同:
$ composer require jparkinson1991/phpcodesniffer-standards
在项目中要求此软件包后,它将被安装并可用于与 PHP_CodeSniffer 一起使用。
$ ./vendor/bin/phpcs -i
The installed coding standards are PEAR, Zend, PSR2, MySource, Squiz, PSR1, PSR12 and JPSR12
使用方法
使用本软件包提供的标准与使用 PHP_Codesniffer 默认标准的方式相同。以 JPSR12 为例。
$ ./vendor/bin/phpcs --standard JPSR12
// phpcs.xml
<rule ref="JPSR12"/>
版本控制
使用 SemVer 进行版本控制。有关可用的版本,请参阅 此存储库的标签。
作者
- Josh Parkinson - Hacking and slashing
许可证
本项目受 GNU GPLv3 许可证许可 - 有关详细信息,请参阅 LICENSE 文件
鸣谢
- dealerdirect 编码标准安装插件
- Drupal 多关键字控制结构嗅探器
- PHP-FIG PSR-12
- squizlabs PHP_Codesniffer