remark-preset-lint-node

5.0.0 • Public • Published

remark-preset-lint-node

Build Status

remark preset to configure remark-lint with settings for nodejs/node

Install

npm install remark-preset-lint-node

Test

npm test

Add new language or grammar

Adding the language to the documentation style guide

  1. PR the nodejs/node repo adding the language/grammar to the documentation style guide.

Adding the language to the linter

  1. PR this repo adding the language/grammar.
  2. Bump this package version, publish it.
  3. In node-lint-md-cli-rollup, bump the remark-preset-lint-node dependency.
  4. In the nodejs/node repo, rebuild the Markdown linter (make lint-md-rollup).
  5. PR the nodejs/node repo with the updated linter.

Environment variables

NODE_RELEASED_VERSIONS

On runtime, the linter will check the environment if the NODE_RELEASED_VERSIONS variable is defined; if it's there, it will use the content of the variable as a comma-separated list of allowed version numbers. This list is supposed to be built from the changelog(s), and validates the version numbers for the nodejs-yaml-comments rule.

For better compatibility with the nodejs/node changelogs, there are a few exceptions:

  • Version numbers ^0.0.0 || ^0.1.0 are not validated using the provided list. They are validated using the vx.x.x pattern.
  • REPLACEME placeholder is always valid, regardless if it's in the list or not.

Readme

Keywords

Package Sidebar

Install

npm i remark-preset-lint-node

Weekly Downloads

2,783

Version

5.0.0

License

MIT

Unpacked Size

19.8 kB

Total Files

6

Last publish

Collaborators

  • watilde
  • trott
  • nodejs-foundation