irstea / php-cs-fixer-config
php-cs-fixer 规则集。
3.1.2
2021-06-16 09:39 UTC
Requires
- php: ^7.1 | ^8.0
- ext-json: *
- beberlei/assert: ^3.2
- friendsofphp/php-cs-fixer: ~2.18.0
Requires (Dev)
- maglnet/composer-require-checker: >=2.0
- mikey179/vfsstream: ^1.6.8
- phpunit/phpunit: >=7.5 <10
README
PHP-CS-Fixer 的配置。
注意:从版本 2.0 开始,需要 PHP 7.1。对于旧版本的 PHP,请使用 1.x 版本。
安装
composer require --dev irstea/php-cs-fixer-config
配置
配置在 .php_cs.dist
文件中完成,与 PHP-CS-Fixer 相同,但使用 Irstea\CS\Config
类。
示例
<?php
$finder = PhpCsFixer\Finder::create()
->exclude('vendor')
->exclude('var')
->files()
->name('*.php')
->in('.');
$loader = require __DIR__ . '/vendor/autoload.php';
try {
return Irstea\CS\Config::create()
->setRiskyAllowed(true) // recommandé pour les nouveaux projets, à tester avec de vieux projets.
->setIndent(' ')
->setLineEnding("\n")
->setFinder($finder);
} finally {
// Décharge le loader pour éviter des conflits de version de classes.
$loader->unregister();
}
更多详细信息,请参阅 https://cs.symfony.com/#usage
用法
vendor/bin/php-cs-fixer fix
请参阅 https://cs.symfony.com/#usage
文件头
php-cs-fixer 可以确保所有 PHP 文件都以一个固定的注释开始。这通常用于放置必要的法律声明(特别是许可证声明)。
irstea/php-cs-fixer-config
允许使用带有几个标签的模板
%package%
被替换为 Composer 包名%description%
被替换为 Composer 包描述%yearRange%
被替换为从 git 仓库提交后的发展年份范围
默认情况下,irstea/php-cs-fixer-config
会查询 composer.json
文件中指定的许可证,然后在它的 headers/ 文件夹中查找相应的模板。如果找不到,它会使用一个 默认模板,该模板将引用项目根目录中的 LICENSE 文件。
否则,通过在项目根目录创建一个 .docheader
文件来创建一个自定义的文件头模板。
示例
%package% - %description%
(c) %yearRange% Irstea <dsi.poleis@irstea.fr>
For the full copyright and license information, please view the LICENSE
file that was distributed with this source code.