typhonjs-escomplex-project

Provides project oriented AST processing for typhonjs-escomplex complexity reports.


Keywords
typhonjs, escomplex, complexity, simplicity, cyclomatic, halstead, maintainability, dependencies, static, analysis, metrics, es6, es7, es8, es9, es10
License
MPL-2.0
Install
npm install typhonjs-escomplex-project@0.1.0

Documentation

typhonjs-escomplex-project

NPM Documentation Code Style License Gitter

Build Status Coverage Dependency Status

Provides project oriented AST processing for typhonjs-escomplex complexity reports. The following JS AST generators are supported / tested: acorn, babel parser, babylon, espree, esprima. Any compliant JS parser that supports Babylon or ESTree AST should work as well.

More information forthcoming. This NPM module can be installed as a dependency in package.json as follows:

"dependencies": {
  "typhonjs-escomplex-project": "^0.1.0"
}

An ES6 example follows:

import escomplexProject from 'typhonjs-escomplex-project';

const modules =
[
   { ast: <some parsed AST>, srcPath: 'a/file/path/1' },
   { ast: <some parsed AST>, srcPath: 'a/file/path/2' }
]);

const results = escomplexProject.analyze(modules);

A CJS example follows:

var escomplexProject = require('typhonjs-escomplex-project');

var modules =
[
   { ast: <some parsed AST>, srcPath: 'a/file/path/1' },
   { ast: <some parsed AST>, srcPath: 'a/file/path/2' }
]);

var results = escomplexProject.analyze(modules);