ts-plato
Visualize JavaScript/TypeScript source complexity with plato. Based on es6-plato.
The Report
Start in 3 steps.
-
Install.
npm install --save-dev ts-plato
-
Add.
"scripts" : {
"complex": "./node_modules/.bin/ts-plato -r -d ./report src",
}
- Run.
npm run complex
Installation
Install the module with: npm install --save-dev ts-plato
Usage
From scripts
//be sure and set your src, output, and any options.let src = "./scripts/**/*.js";let outputDir = "./artifacts/plato"; let platoArgs = title: "example" eslint: {}; //you can use the reports in the callback. { let overview = plato; let total average = overviewsummary; let output = `total ---------------------- eslint: sloc: maintainability: average ---------------------- eslint: sloc: maintainability: `;} //usage is plato.inspectplato;
Example Gulpfile
let gulp = ;let plato = ; let src = "./scripts/**/*.js";let outputDir = "./artifacts/plato"; let lintRules = rules: indent: 2 "tab" quotes: 2 "single" semi: 2 "always" "no-console": 1 curly: "error" "no-dupe-keys": 2 "func-names": 1 "always" env: ts: true globals: "require" parserOptions: sourceType: "module" ecmaFeatures: jsx: true modules: true ; let complexityRules = {}; let platoArgs = title: "example" eslint: lintRules complexity: complexityRules; { return plato;} gulp;
From the commandline
Usage : ts-plato [options] -d <output_dir> <input files> -h, --help Display this help text. -q, --quiet Reduce output to errors only -v, --version Print the version. -x, --exclude : String File exclusion regex -d, --dir : String *required* The output directory -r, --recurse Recursively search directories -l, --jshint : String Specify a jshintrc file
Example
ts-plato -r -d report src
Note for Windows Users: If you are on Windows, you might want to put your glob in quotes if you use a tool such as cygwin, conemu or some other emulator, and you are also targeting files in directories, otherwise the emulator might incorrectly expand the glob before it is handled internally by ts-plato. For instance, if you want to use
/src/**/*.js
and the results are ignoring the root try'./src/**/*.js'
instead.
Data sources
- Complexity from typhonjs-escomplex
- Lint data from eslint
Contributors
License
Licensed under the MIT license.