jscomplexity's Introduction

JScomplexity

JS cyclomatic complexity report generator.

Command-line tool and module that generates a report of Javascript files complexity. It is based on escomplex module's results.

In 'html' mode, command-line tool will create an .html file report containing graphical representation of files complexity and lines of code count.

Installation

npm install -g jscomplexity

Module usage

var jscomplexity = require('jscomplexity');

// jscomplexity() returns a promise (using bluebird)
jscomplexity('/glob/pattern/to/js/*' [, globOptions]).then(console.log);

// you can also use CPS style
jscomplexity('/glob/pattern/to/js/*', {}, function(err, result){
  if(err) {
    return console.log(err);
  }
  console.log(result);
});

Command-line usage

Usage: jscomplexity [options]

  Options:

    -h, --help                 output usage information
    -V, --version              output the version number
    -p, --pattern <pattern>    glob pattern - default is current directory
    -o, --output <filename>    (optional) customize html report filename - default is 'jscomplexity-report.html'
    -r, --reporter <reporter>  (optional) specify a reporter: 'terminal', 'html' or 'all' - default is 'terminal'

⚠️ Linux/OSX compliant only (I haven't tested it on Windows).

CLI Example : jscomplexity -p '{src/*.js,src/**/*.js,!src/config/**}'

Sample outputs (gremlins.js)

Terminal

HTML report

Grunt task

See grunt-jscomplexity-threshold module.

jscomplexity's People

Contributors

Stargazers

Watchers

jscomplexity's Issues

HTML report hangs in Firefox and Chrome

I'm running jscomplexity 2.0.0, and the HTML reports hang while rendering in the browser. Eventually, FF comes back w/a message that the script: http://cdnjs.cloudflare.com/ajax/libs/graphael/0.5.0/g.raphael-min.js may be busy or have stopped responding. I can only regain control of the browser by stopping the script.

The 3 scripts and 1 css on cloudflare all load w/a 200 status.

Running FF 44.0.2. Chrome 49.0.2623.87 64bit. On a mac. Same thing happens in Safari 9.1.