alexxnica / standard-markdown

:memo: Test your Markdown files for Standard JavaScript Style™

standard-markdown

Test your Markdown files for Standard JavaScript Style™

Installation

npm install standard-markdown --save

Usage

Linting

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:

standard-markdown

Or lint some other directory:

standard-markdown some/other/directory

All files with .md or .markdown extension are linted, and the following directories are ignored:

• .git
• node_modules
• vendor

If you want to specify which files to lint / which files to ignore you can use glob patterns

# This will lint everything in some/directory except everything in some/directory/api
standard-markdown some/directory **/*.md !api/**/*.md

# You also don't need to specify CWD to use globs
# This will only lint markdown file in the current directory
standard-markdown *.md

This module disables certain rules that were considered not appropriate for linting JS blocks in markdown. See #2 for more information.

Currently we disable the following rules:

• no-undef
• no-unused-vars
• no-lone-blocks
• no-labels

For more examples of what is and isn't allowed, see the clean and dirty test fixtures.

Fixing

This module also provides the ability to automatically fix common syntax issues like extra semicolons, bad whitespacing, etc. This functionality is provided by standard.

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.

Tests

npm install
npm test

Dependencies

• async: Higher-order functions and common patterns for asynchronous code
• commander: The complete solution for node.js command-line programs
• globby: Extends glob with support for multiple patterns and exposes a Promise API
• lodash.flatten: The lodash method _.flatten exported as a module.
• lodash.range: The lodash method _.range exported as a module.
• standard: JavaScript Standard Style

Dev Dependencies

• tap-spec: Formatted TAP output like Mocha's spec reporter
• tape: tap-producing test harness for node and browsers

License

MIT