gordinskiy/line-length-checker

PHP-CS-Fixer 规则用于检查行长度

v0.0.2 2023-11-29 21:32 UTC

This package is auto-updated.

Last update: 2024-08-29 23:01:23 UTC


README

PHP-CS-Fixer 定制的规则。
检查行长度是否不超过120个字符。
不进行任何修复。

工作原理

搜索超过最大长度限制的行,并通过添加注释进行标记
# 行太长

要查看哪些行违反了规则,应该运行带有 --diff 标志的命令。

差异示例

Diff Example

仅对 check 命令和带有 --dry-run 标志的 fix 命令有效。在其他情况下不执行任何操作。

安装

安装包

composer require --dev gordinskiy/line-length-checker

在 PHP-CS-Fixer 配置文件中注册规则

<?php
// ...
return (new PhpCsFixer\Config())
    // ...
    ->registerCustomFixers([
        new Gordinskiy\LineLengthChecker\Rules\LineLengthLimit()
    ])
;

在 PHP-CS-Fixer 配置文件中启用规则

<?php
// ...
return (new PhpCsFixer\Config())
    // ...
    ->setRules([
        'Gordinskiy/line_length_limit' => true,
    ])
;

配置

默认限制为120,但可以通过 max_length 选项进行配置。

<?php
// ...
return (new PhpCsFixer\Config())
    // ...
    ->setRules([
        'Gordinskiy/line_length_limit' => ['max_length' => 115],
    ])
;