Run JSHint against code snippets within Markdown slides
This plugin requires Grunt
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-codeblock-jshint --save-dev
In your project's Gruntfile, add a section named
'codeblock-jshint' to the data object passed into
The path to a custom JSHint reporter, or else a custom reporter function to use when logging the output from JSHint
An object specifying JSHint rules that will be used when validating the code tokens
In this example, the default reporter is used, and all markdown files within the provided directory are scanned for code blocks to lint.
In this example, two different directories of markdown files are scanned, and results from one of them are logged with a custom JSHint reporter
In this example, several non-default JSHint options are passed in and will be used when checking the specified files.
Lint and test your code using the
npm test command. In lieu of a formal styleguide, JSHint and JSCS are in place to ensure code style consistency. Add unit tests for any new or changed functionality.
jshintOptionsoption now enables custom JSHint configuration options to be specified
langoption is now configurable with a regex or string