capuk/coding-standard

此包最新版本(3.0.1)没有提供许可证信息。

基督教反对贫穷的PHP编码标准

3.0.1 2024-05-21 13:53 UTC

README

提供 CAPCS 规则集用于 phpcs

本地安装

使用composer本地安装

composer require --dev capuk/coding-standard

配置PHPCS

以下说明假设composer的bin-dir设置为bin。如果不是这样,则将phpcs路径从bin/phpcs更改为vendor/bin/phpcs

在项目根目录中创建 phpcs.xml,包含

<?xml version="1.0"?>
<ruleset>
    <config name="installed_paths" value="../../capuk/coding-standard/src" />
    <rule ref="CAPCS" />
</ruleset>

phpcs现在默认使用CAPCS规则集,例如

bin/phpcs src/example.php

或者,可以通过命令行配置phpcs

bin/phpcs --config-set installed_paths "../../capuk/coding-standard/src"
bin/phpcs --config-set default_standard CAPCS

请注意,存储这些设置的phpcs配置文件位于phpcs包目录中,并且当composer更新包时可能会被覆盖,因此使用phpcs.xml是配置phpcs的更可靠方式。

全局安装

使用composer全局安装

composer global require capuk/coding-standard ^1.0

对于本地安装,可以通过命令行配置phpcs

phpcs --config-set installed_paths "../../capuk/coding-standard/src"
phpcs --config-set default_standard CAPCS

或者使用上面的phpcs.xml文件,该文件可以位于项目根目录或任何父目录

测试

从项目根目录

composer install
// Run CAPCS against an example PHP file
bin/phpcs src/invalid-example.php