litonarefin / wp-php-cs-fixer
WordPress的PHP CS Fixer
This package is auto-updated.
Last update: 2024-08-30 01:32:43 UTC
README
一组针对PHP CS Fixer的定制修复器,特别适用于WordPress。这是由weDevs的创始人兼CTO Tareq Hasan修改的tareq1988/wp-php-cs-fixer版本。
一组针对PHP CS Fixer的定制修复器,特别适用于WordPress。
php-cs-fixer是什么?
php-cs-fixer或PHP Coding Standards Fixer是由Symfony的超级棒的人创造的超级棒的工具。
它帮助您的PHP代码/仓库遵循您团队定义的特定编码标准。
WordPress修复器是什么?
WordPress使用与世界其他地方略有不同的编码标准。它还没有遵循PSR标准。
这个WordPress特定修复器的目的是允许WordPress开发者根据WordPress编码标准标准化他们的代码。
可用的修复器
- 括号内的空格:此修复器确保在定义函数、if/else块或具有括号的控制结构时,在开始括号之后和结束括号之前存在一个空格。规则名称:
PixarLabs/space_inside_parenthesis
。 - 类开头后的空白行:PSR标准要求类开头的大括号在新行上,WordPress遵循相同的行标准。这确保在开头大括号之后存在一个空白行(等于两个
\n
)。规则名称:PixarLabs/blank_line_after_class_opening
。
安装
PHP CS Fixer:可以通过运行以下命令安装自定义修复器
composer require --dev litonarefin/wp-php-cs-fixer
使用方法
在您的PHP CS Fixer配置文件(.php-cs-fixer.dist.php
)中注册修复器并使用它们
<?php // add the custom fixers + require_once __DIR__ . '/vendor/litonarefin/wp-php-cs-fixer/loader.php'; $finder = PhpCsFixer\Finder::create() ->exclude('node_modules') ->exclude('vendors') ->exclude('assets') ->in( __DIR__ ) ; $config = new PhpCsFixer\Config(); $config + ->registerCustomFixers([ + new PixarLabs\Fixer\SpaceInsideParenthesisFixer(), + new PixarLabs\Fixer\BlankLineAfterClassOpeningFixer() + ]) + ->setRules( PixarLabs\Fixer\Fixer::rules() ) ->setFinder( $finder ) ; return $config;
PixarLabs\Fixer\Fixer::rules()
函数简化了WordPress特定规则的使用。但是,如果您想要更多的控制,并且有不同的口味,您可以将从PixarLabs\Fixer\Fixer
类中复制/粘贴的规则粘贴到.php_cs
文件中,如果您想要的话。
示例文件
示例.php_cs.example
文件应该是您插件的良好起点。只需将文件拖放到您的插件文件夹中,将其重命名为.php-cs-fixer.dist.php
即可。
命令行
要检查特定文件,请从您喜欢的终端或命令行软件运行php-cs-fixer fix your-file-name
。配置好一切后,从您喜欢的终端或命令行软件运行php-cs-fixer fix
。