Skip to content

tools: update remark configuration

Rodrigo Muino Tomonari requested to merge github/fork/ChALkeR/remark-update into master
Checklist
  • make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
  • commit message follows commit guidelines
Affected core subsystem(s)

tools

Description of change

Update remark configuration:

  1. Specify the plugin name as 'remark-lint/', as new remark-cli refused to find it when cwd is different from the directory where node_modules are put. Trailing slash fixes this, as the plugin name gets treated as a path, so require works on it.
  2. Explicitly specify the list of rules we want to enable, as the new remark-lint is opt-in and doesn't come with any rules by default.
  3. Reorder the rules alphabetically.

Previous work in #7729.

This change is extracted from #8551, as the tooling might take more time to land and would probably be not backported, and this config update is required to file further doc cleanups in order to avoid conflicts in this config file. Also, I am planning to backport at least some of the doc cleanups.

/cc @trott, @addaleax, @nodejs/documentation

Merge request reports

Loading