FormidableLabs/fred-jones

Name: fred-jones

Owner: Formidable

Description: null

Created: 2015-04-01 17:27:23.0

Updated: 2015-04-24 07:46:49.0

Pushed: 2015-04-24 07:46:49.0

Homepage: null

Size: 2844

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Fred Jones

helping you visualize project health

Installation

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

Usage

From the commandline

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

Example

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

From scripts

fredJones = require('fred-jones');

files = [
ath/to/javascript/file1.js',
ath/to/javascript/fileN.js'


options = {
tputDir: './output/dir'


callback = function (report){
nce done the analysis,
xecute this


Jones.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