remark preset to configure remark-lint with settings for nodejs/node
npm install remark-preset-lint-node
Add new language or grammar
Adding the language to the documentation style guide
Adding the language to the linter
- PR this repo adding the language/grammar.
- Bump this package version, publish it.
- In the
nodejs/noderepo, rebuild the Markdown linter (
- PR the
nodejs/noderepo with the updated linter.
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
For better compatibility with the nodejs/node changelogs, there are a few exceptions:
- Version numbers
^0.0.0 || ^0.1.0are not validated using the provided list. They are validated using the
REPLACEMEplaceholder is always valid, regardless if it's in the list or not.