Test your Markdown files for Standard JavaScript Style™
npm install standard-markdownTest your Markdown files for Standard JavaScript Style™
``sh`
npm install standard-markdown --save
This module works just like standard, but instead of linting javascript files, it lints GitHub-Flavored js and javascript code blocks inside markdown files.
Lint everything in the current directory:
`sh`
standard-markdown
Or lint some other directory:
`sh`
standard-markdown some/other/directory
All files with .md or .markdown extension are linted, and the following directories are ignored:
- .git
-
-
If you want to specify which files to lint / which files to ignore you can use glob patterns
`shThis will lint everything in some/directory except everything in some/directory/api
standard-markdown some/directory /.md !api//.md
$3
This module also provides the ability to automatically fix common syntax issues like extra semicolons, bad whitespacing, etc.
This functionality is provided by standard.
sh
standard-markdown some/directory --fix
`Once the module has attempted to fix all your issues it will run the linter on the generated files so you can see how much it fixed.
Rules
This module disables certain rules that were considered inappropriate for linting JS blocks:
*
*
*
*
* For more examples of what is and isn't allowed, see the
clean and
dirty test fixtures.
Tests
sh
npm install
npm test
`Dependencies
- commander: The complete solution for node.js command-line programs
- globby: Extends
- tap-spec: Formatted TAP output like Mocha's spec reporter
- tape: tap-producing test harness for node and browsers
MIT