Skip to content

Conversation

@avivkeller
Copy link
Member

This PR lints the documentation according to https://www.npmjs.com/package/@node-core/remark-lint, which'll be the linter associated with the new tooling.

The difference which are rectified by this PR:

  • The linter requires one PR URL per change
  • The linter disallows duplicate stability nodes
  • The linter requires full 40-character commits

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/loaders

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Aug 22, 2025
@avivkeller avivkeller force-pushed the @node-core/remark-lint branch from d36730d to 3ca82e2 Compare December 5, 2025 22:54
Copilot AI review requested due to automatic review settings December 5, 2025 22:54
@avivkeller avivkeller marked this pull request as draft December 5, 2025 23:00
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the documentation linting tooling from remark-preset-lint-node to @node-core/remark-lint and fixes various formatting issues identified by the new linter to ensure documentation consistency across the Node.js project.

Key changes:

  • Migrated linting infrastructure to use @node-core/remark-lint with separate API and base linters
  • Standardized horizontal rule syntax from *** to --- throughout documentation
  • Normalized type union syntax by removing spaces (e.g., string | nullstring|null)

Reviewed changes

Copilot reviewed 15 out of 28 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tools/lint-md/package.json Updated dependencies to use @node-core/remark-lint and remark instead of remark-preset-lint-node, remark-parse, remark-stringify, and unified
tools/lint-md/lint-md.mjs Refactored to use new linter API with separate processors for API docs and base docs, imports type-map.json, simplified error reporting logic
doc/contributing/releases.md Replaced *** with --- for horizontal rules
doc/contributing/collaborator-guide.md Replaced *** with --- for horizontal rules
doc/changelogs/CHANGELOG_V15.md Replaced *** with --- for horizontal rules
doc/changelogs/CHANGELOG_V12.md Replaced *** with --- for horizontal rules
doc/changelogs/CHANGELOG_IOJS.md Replaced *** with --- for horizontal rules
doc/api/util.md Removed spaces in union type annotations
doc/api/url.md Removed spaces in union type annotations
doc/api/type-map.json Added new file mapping type names to documentation URLs for the linter
doc/api/test.md Removed spaces in union type annotations
doc/api/stream.md Collapsed multi-line type annotations to single lines, removed spaces in union types
doc/api/sqlite.md Removed spaces in union type annotations, converted link-style references to inline type references, removed self-referential link
doc/api/process.md Removed spaces in union type annotations
doc/api/modules.md Removed spaces in union type annotations
doc/api/module.md Removed duplicate stability node
doc/api/inspector.md Removed duplicate stability node
doc/api/https.md Removed spaces in union type annotations
doc/api/http2.md Removed spaces in union type annotations
doc/api/http.md Removed spaces in union type annotations
doc/api/errors.md Extended short commit hash to full 40-character format
doc/api/dns.md Removed spaces in union type annotations
doc/api/diagnostics_channel.md Removed spaces in union type annotations
doc/api/deprecations.md Separated combined pr-url array into individual version entries with distinct pr-urls
doc/api/crypto.md Removed spaces in union type annotations
doc/api/buffer.md Removed spaces in union type annotations
doc/README.md Replaced *** with --- for horizontal rules

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@avivkeller
Copy link
Member Author

Blocked by #57343

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants