Giter VIP home page Giter VIP logo

plato's Introduction

plato

Build Status

Codeship Status for es-analysis/plato

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

  • 1.3.0 Merged 107,130,128,119,114. Numerous bug fixed.
    • Minor bumped for changes to parsing of files passed. Technically a breaking change but effectively a bug fix + feature so bumping minor.
  • 1.2.1 Bumping versions for jshint and lodash
  • 1.2.0 add ability to disable jshint
  • 1.1.0 fix issue with running casperjs tests
  • 1.0.1 fix issue with first line hashbang
  • 1.0.0 promote to 1.0.0 with bug fixes
  • 0.6.2 Added sortable file list, updated to bootstrap 3
  • 0.6.1 Fixed width overflow issues in file reports
  • 0.6.0 updated major dependency complexity-report
  • 0.5.0 Added historical reports
  • 0.4.7 Updated jshint to 1.1.0 (via #22) to jshint to address #16
  • 0.4.6 Performance improvements on file view
  • 0.4.5 Updated complexity-report to 0.7.0 to prefer the 0-100 based maintainability index
  • 0.4.4 Added quiet mode, exclusion regex, description popovers
  • 0.4.3 Updated dependencies to fix reporting issues
  • 0.4.2 Fixed overview links to files
  • 0.4.1 Fixed jshint option passing
  • 0.4.0 Added summary stats, Casper tests, nodunit tests
    • Breaking : plato api
  • 0.3.1 Added graphs
  • 0.3.0 Formatting changes, refactoring.
    • Breaking : jshint reporting api
  • 0.2.0 added jshint reporting.
    • Breaking : options api, cli api
  • 0.1.0 initial release

License

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

Bitdeli Badge

plato's People

Contributors

alunny avatar bitdeli-chef avatar charmander avatar craig-davis avatar davidlinse avatar dciccale avatar ehmicky avatar enjine avatar felipegs avatar ilanbiala avatar jraller avatar jsoverson avatar kunalkundaje avatar marook avatar matthewkastor avatar mischah avatar nerdgore avatar pedronauck avatar psysp avatar sljavi avatar tjbaker avatar tomhicks-bsf avatar treyhunner avatar victor-homyakov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.