gordinskiy/line-length-checker

PHP-CS-Fixer rule to check line length

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

Requires

• php: ^7.4 || ^8.0
• friendsofphp/php-cs-fixer: ^3.35

MIT

• Dmitriy Gordinskiy

README

Custom rule for PHP-CS-Fixer.
Checks that the length of lines does not exceed 120 characters.
Doesn't fix anything.

How it works

Searches for the line that exceed max length limit and mark it by adding comment:
# Line too long

To see which lines violates the rule you should run the command with the--diff flag.

DIff example:

Works only for check command and fix command with --dry-run flag. Does nothing in other cases.

Installation

Install package:

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

Register rule in PHP-CS-Fixer config file:

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

Enable rule in PHP-CS-Fixer config file:

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

Configuration

Default limitation is 120, but it can be configured by max_length option:

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