Home

Awesome

plato

Needs active maintainer

plato was updated to support es6 by @devcrust, but needs an active maintainer to keep it moving forward.

Build Status

Visualize JavaScript source complexity with plato.

Example report on popular projects

Installation

Install the module with: npm install -g plato

Usage

From the commandline

Usage : 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 for JSHint linting
  -e, --eslint : String
      Specify a eslintrc file for ESLint linting
  -t, --title : String
      Title of the report
  -D, --date : String
      Time to use as the report date (seconds, > 9999999999 assumed to be ms)
  -n, --noempty
      Skips empty lines from line count

Example

plato -r -d report src

Extended example

plato -r -d report -l .jshintrc -t "My Awesome App" -x .json routes/*.js

From scripts

var plato = require('plato');

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

var outputDir = './output/dir';
// null options for this example
var options = {
  title: 'Your title here'
};

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

plato.inspect(files, outputDir, options, callback);

Data sources

Contributors

Release History

License

Copyright (c) 2012 Jarrod Overson Licensed under the MIT license.

Bitdeli Badge