bigwing/phpcs-composer

安装: 37

依赖: 1

建议者: 0

安全: 0

星星: 1

关注者: 2

分支: 0

开放问题: 0

类型:phpcodesniffer-standard

dev-master 2020-08-07 18:35 UTC

This package is auto-updated.

Last update: 2024-09-08 03:51:31 UTC


README

Composer 库,提供即插即用安装和配置 WPCSPHPCompatibilityWP,为 WordPress 开发设置合理的默认值,几乎无需配置。

Support Level MIT License

安装

通过 Composer 安装库

$ composer require --dev bigwing/phpcs-composer:dev-master

就这样!

用法

使用以下命令检查您的 PHP 文件

$ ./vendor/bin/phpcs .

如果依赖 Composer,编辑 composer.json 文件,添加以下内容

	"scripts": {
		"lint": [
			"phpcs . --standard=BigWing-WP"
		],
	}

然后通过以下方式检查

$ composer run lint

持续集成

PHPCS 配置与持续集成解决方案兼容。默认情况下,该库加载 BigWing-WP 规则集,并检查 PHP 7.2 或更高版本的语法错误。

要覆盖默认的 PHP 版本检查,设置 --runtime-set testVersion 7.2- 配置选项。例如,对于 PHP 版本 7.4 及以上

$ ./vendor/bin/phpcs --runtime-set testVersion 7.4-

有关指定 PHP 版本的信息,请参阅 更多内容

请注意,您只能从命令行覆盖 PHP 版本检查。

IDE 集成

PHPCS 的某些 IDE 集成无法注册 BigWing-WP 规则集。为了纠正这个问题,请在项目根目录放置 .phpcs.xml.dist

<?xml version="1.0"?>
<ruleset name="Project Rules">
	<rule ref="BigWing-WP" />
</ruleset>

支持级别

内部: BigWing 正在为内部项目开发此功能,我们预计在可预见的未来将继续工作,包括将测试保持到最新的 WordPress 版本。欢迎提交错误报告、功能请求、问题以及 pull 请求。

感谢和致谢