Run JSCS 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-jscs --save-dev
In your project's Gruntfile, add a section named
'codeblock-jscs' to the data object passed into
The path to a custom JSCS reporter, or else a custom reporter function to use when logging the output from JSCS
An object specifying JSCS 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. Since there are no JSCS "defaults," you must provide a JSCS options object (in this case reading in from a
In this example, two different directories of markdown files are scanned, and the results from each are determined with different JSCS presets
In this example, a preset is overridded with the specified JSCS options.
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.