degraciamathieu/php-line-length-detector

PHP code smell detector

v0.1.0 2023-07-15 16:09 UTC

Requires

• php: ^8.1
• degraciamathieu/php-file-explorer: 0.4.*
• illuminate/view: ^10.0
• laravel-zero/framework: ^10.0
• nunomaduro/termwind: ^1.15

Requires (Dev)

• mockery/mockery: ^1.5.1
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.0

MIT

• De Gracia Mathieu

• php
• ci
• Metrics
• quality
• smell
• static-analyzer

README

php-line-length-detector

A simple way to analyze the line length of your PHP files.

Installation

Requires >= PHP 8.1

Phar

This tool is distributed as a PHP Archive (PHAR):

wget https://github.com/DeGraciaMathieu/php-line-length-detector/raw/master/builds/php-line-length-detector

php php-line-length-detector --version

Composer

Alternately, you can directly use composer :

composer require degraciamathieu/php-line-length-detector --dev

Usage

php php-line-length-detector inspect {path}

$ php php-line-length-detector inspect app

❀ PHP Line Lenght Detector ❀
+-------------+--------------+--------------+
| total lines | largest line | average line |
+-------------+--------------+--------------+
| 1068        | 197          | 37           |
+-------------+--------------+--------------+
+--------+------------+---------+
| length | occurrence | percent |
+--------+------------+---------+
| > 160  | 2          | 0 %     |
| > 120  | 5          | 0 %     |
| > 80   | 29         | 2 %     |
| > 60   | 111        | 10 %    |
| > 30   | 618        | 57 %    |
+--------+------------+---------+

You can configure thresholds with the --thresholds= option (default : 160,120,80,60,30) :

$ php php-line-length-detector inspect app --thresholds=120,60

❀ PHP Line Lenght Detector ❀
+-------------+--------------+--------------+
| total lines | largest line | average line |
+-------------+--------------+--------------+
| 1068        | 197          | 37           |
+-------------+--------------+--------------+
+--------+------------+---------+
| length | occurrence | percent |
+--------+------------+---------+
| > 120  | 5          | 0 %     |
| > 60   | 111        | 10 %    |
+--------+------------+---------+