JSHint Plugin for DocPad

Install

npm install --save docpad-plugin-jshint

Configure

For information on customizing your plugin configuration you can refer to the DocPad FAQ

Ignore Files

ignoreFiles: ['path/file.js']

ignoreFiles accepts an array of file paths to ignore while hinting.

Ignore Paths

ignorePaths: ['path/']

ignorePaths accepts an array of directory paths to ignore while hinting.

Ignore Minified Files

ignoreMinified: boolean

ignoreMinified accepts a boolean which determines whether files ending in .min.js are ignored. The default is true.

Globals

globals: {var: boolean}

globals is an object of global variables, with keys as names and a boolean value to determine if they are assignable.

It's recommended you define these in a .jshintrc file instead of config options to make your preferences more portable.

JSHint options

hintOptions is an object where you can pass any of JSHint's options

It's recommended you define these in a .jshintrc file instead of config options to make your preferences more portable.

History

You can discover the history inside the History.md file

Contributing

You can discover the contributing instructions inside the Contributing.md file

License

Licensed under the incredibly permissive MIT License Copyright © 2013+ Jimmy King [email protected]