JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 959
  • Score
    100M100P100Q94046F
  • License MIT

Test your Markdown files for Standard JavaScript Style™

Package Exports

  • standard-markdown

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (standard-markdown) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

standard-markdown Build Status

Test your Markdown files for Standard JavaScript Style™

Installation

npm install standard-markdown --save

Usage

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

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

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

Tests

npm install
npm test

Dependencies

  • async: Higher-order functions and common patterns for asynchronous code
  • 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