degraciamathieu/php-wording-detector

check your DDD approach by analyzing your variables

v1.0.0 2024-05-12 13:15 UTC

Requires

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

Requires (Dev)

• laravel/pint: ^1.5
• mockery/mockery: ^1.5.1
• phpunit/phpunit: ^10.0

MIT

• De Gracia Mathieu

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

README

php-wording-detector

Simple tool to analyze and split the words contained in your code to check your DDD approach.

Installation

Requires >= PHP 8.1

Phar

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

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

php php-wording-detector --version

Composer

Alternately, you can directly use composer :

composer require degraciamathieu/php-wording-detector --dev

Usage

By default only variables are analyzed :

php php-wording-detector inspect {path}

The --with-method option allows to parse the name of the methods :

php php-wording-detector inspect {path} --with-method

$ php php-wording-detector inspect app/Domains/Activity
❀ PHP Wording Detector ❀
+-------------+-----------------------+-------------+
| total words | total distincts words | average use |
+-------------+-----------------------+-------------+
| 2'166       | 52                    | 42          |
+-------------+-----------------------+-------------+
+--------------+-------+------------+
| words        | usage | percentage |
+--------------+-------+------------+
| activity     | 667   | 31%        |
| data         | 154   | 7%         |
| code         | 150   | 7%         |
| item         | 143   | 7%         |
| query        | 128   | 6%         |
| request      | 88    | 4%         |
| mode         | 85    | 4%         |
| translations | 78    | 4%         |
| id           | 77    | 4%         |
| type         | 63    | 3%         |
| new          | 46    | 2%         |
| product      | 41    | 2%         |
| translation  | 41    | 2%         |
| types        | 40    | 2%         |
| master       | 33    | 2%         |
| filters      | 29    | 1%         |
| language     | 24    | 1%         |
| builder      | 23    | 1%         |
| items        | 22    | 1%         |
| section      | 21    | under 1%   |
+--------------+-------+------------+