Fred Jones

helping you visualize project health

Installation

Install the module with: npm install -g fred-jones

Usage

From the commandline

Usage : fred-jones [options]
  -h, --help                     output usage information
  -V, --version                  output the version number
  -v, --verbose                  Extra verbose output
  -h, --jsHint [value]           Path to jsHint file
  -d, --outputDirectory [value]  Specify output directory relative to execution root
  -x, --excludes <files>         Files to exclude
  -f, --files <files>            Files to process

Example

fred-jones -f "./client/js/**/*.js" -x "./client/js/vendor/**/*"

From scripts

var fredJones = require('fred-jones');

var files = [
  'path/to/javascript/file1.js',
  'path/to/javascript/fileN.js'
];

var options = {
  outputDir: './output/dir'
};

var callback = function (report){
// once done the analysis,
// execute this
};

fredJones.inspect(files, options, callback);

Data sources

• Complexity data by Phil Booth's complexity-report
• Lint data from jshint

Credits

• https://github.com/es-analysis/plato
• @jsoverson

License

MIT License