10up / phpcs-composer
10up的PHP CodeSniffer规则集
3.0.0
2023-12-14 15:37 UTC
Requires
Requires (Dev)
- dealerdirect/phpcodesniffer-composer-installer: *
- phpcompatibility/php-compatibility: dev-develop as 9.99.99
- dev-master
- dev-trunk
- 3.0.0
- 3.0.0-RC4
- 3.0.0-RC3
- 3.0.0-RC2
- 3.0.0-RC1
- 2.0.1
- dev-fix/install-documentation
- dev-release/3.0.0
- dev-wpcs-3-0
- dev-feature/add-tests-to-3.0.0-branch
- dev-feature/php-8-2
- dev-feature/include-missing-wordpress-db-rules
- dev-do/38-enable-nonce-sniff
- dev-update/adding-sniffs
- dev-feature/php-8-1
- dev-feature/ignore-dist
- dev-feature/php-7-4
- dev-fix/readme-package
This package is auto-updated.
Last update: 2024-09-14 23:47:20 UTC
README
Composer库,提供WPCS和PHPCompatibilityWP的即插即用安装和配置,为WordPress开发设置合理的默认值,几乎无需配置。
安装
通过Composer安装库
$ composer require --dev 10up/phpcs-composer:"^3.0"
就这样!
使用方法
使用以下命令检查您的PHP文件
$ ./vendor/bin/phpcs .
如果依赖Composer,请编辑composer.json
文件,添加以下内容
"scripts": { "lint": [ "phpcs ." ], }
然后通过以下方式检查
$ composer run lint
持续集成
PHPCS配置与持续集成解决方案兼容。默认情况下,该库加载10up-Default
规则集,并检查PHP 8.2或更高版本的语法错误。
要覆盖默认的PHP版本检查,设置--runtime-set testVersion 7.0-
配置选项。例如,对于PHP版本7.2及以上
$ ./vendor/bin/phpcs --runtime-set testVersion 7.2-
有关指定PHP版本更多信息,请参阅此处。
请注意,您只能从命令行覆盖PHP版本检查。
IDE集成
一些PHPCS的IDE集成未能注册10up-Default
规则集。为了纠正这一点,请将.phpcs.xml.dist
放置在项目根目录
<?xml version="1.0"?> <ruleset name="Project Rules"> <rule ref="10up-Default" /> </ruleset>
支持级别
活跃: 10up正在积极开发此项目,我们预计将在可预见的未来继续工作,包括将测试更新到最新版本的WordPress。欢迎提交错误报告、功能请求、问题和拉取请求。