@mapbox/eslint-plugin-docs v1.2.0

eslint-plugin-docs

Eslint rules for docs.mapbox.com sites.

Rules

• @mapbox/docs/map-wrapper (documentation)

Install

npm install @mapbox/eslint-plugin-docs

In the eslint configuration, extend the plugin:

"extends": ["plugin:@mapbox/docs/recommended"]

Developing

To run tests:

npm test

To test eslint plugin (this will lint tests/test-code/eslint-map-wrapper-error.js):

npm run lint-map-wrapper

Use the liquid processor

To lint JavaScript fenced code blocks in markdown files, update the eslint configuration to include:

"overrides": [
    {
      "files": [
        "**/*.md"
      ],
      "processor": "@mapbox/docs/liquid"
    },
    {
      "files": [
        "**/*.md/*.js"
      ],
      // Your rules here for JavaScript
    }
  ]

Update your lint script in package.json to include: eslint --ext .md src/pages.