Download the PHP package insolita/yii2-codestat without Composer
On this page you can find all versions of the php package insolita/yii2-codestat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package yii2-codestat
Yii2 Code Statistic
Based on phploc/phploc
Installation
Either run
or add
in require-dev section of your composer.json
file.
Basic Usage
Add in console configuration file, in section modules
scanTargets - array of path, or path aliases that will be scanned recursively exceptTargets - array of path patterns for excluding
For checking whole list of files that will be processed, run
For statistic summary output run
For statistic summary output with show bad resolved files
Show full phploc report per each defined group
Show full phploc report for all matched files
Show full phploc report for custom directory
Show full phploc report for custom file
List available metrics with codes
Advanced Usage
Custom Class Grouping Rules
You can extend or overwrite property 'groupRules', with supported formats
'Group Name' => 'BaseParentClass'
where 'BaseParentClass' should by verified with (\ReflectionClass)->isSubclassOf()
or
Final example
Important! The order of the rules in the list matters, the base classes (\yii\base\Component and \yii\base\Object) should be at the end of the list!
Custom code metrics
Code metrics provided by https://github.com/sebastianbergmann/phploc, has lot of variants, you can define own combination
For actions advanced/common/directory/file you should set metrics property with array of necessary metric names
For summary action you should provide property 'analyseCallback' in module like as
It should return associative array with 'metric name' => 'metric value'
data and will replace internal https://github
.com/Insolita/yii2-codestat/blob/7d0fc3351718b2052624ea091ff8f154fe471aeb/src/lib/CodestatService.php#L154
And also table summary convention - if metric name contains slash "/", for summary row will be counted average value, otherwise sum
All versions of yii2-codestat with dependencies
yiisoft/yii2 Version ~2.0.13
phploc/phploc Version ^5.0
league/climate Version ^3.2