nickcooley / phantomlint Goto Github PK

PhantomLint is an add-on to Phantom.js that recursively dives into a directory and lints your JavaScript files.

An example shell script (test.sh) is provided.

CONFIG OPTIONS:
  - filepaths (Array)
    REQUIRED. An array of relative filepaths to the directories containing JS files

  - exclusions (Array)
    An array of relative filepaths to the directories containing JS files that should be ignored

  - jsLint (String)
    A relative filepath to the local JSLint file to use
    (defaults to ./assets/jslint.js)

  - lintOptions (Object)
    A configuration object to add/override the default options for JS Lint

  - verbose (Boolean)
    Defaults to true.

  - stopOnFirstError (Boolean)
    Defaults to true.

  - logFile (String)
    A relative filepath to where the output error log should go.
    (defaults to ./error_log.txt)


NOTES:
  - The PhantomJS binary included in this repo is the Mac OS X static build