Skip to content

doc: lint according to @node-core/remark-lint - #59590

Closed
avivkeller wants to merge 2 commits into
nodejs:mainfrom
avivkeller:@node-core/remark-lint
Closed

doc: lint according to @node-core/remark-lint#59590
avivkeller wants to merge 2 commits into
nodejs:mainfrom
avivkeller:@node-core/remark-lint

Conversation

@avivkeller

Copy link
Copy Markdown
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
Copy Markdown
Collaborator

Review requested:

  • @nodejs/loaders

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Aug 22, 2025
Comment threaddoc/api/deprecations.md Outdated
Comment threaddoc/api/module.md
CopilotAI 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

CopilotAI left a comment

Copy link
Copy Markdown

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
FileDescription
tools/lint-md/package.jsonUpdated 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.mjsRefactored 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.mdReplaced *** with --- for horizontal rules
doc/contributing/collaborator-guide.mdReplaced *** with --- for horizontal rules
doc/changelogs/CHANGELOG_V15.mdReplaced *** with --- for horizontal rules
doc/changelogs/CHANGELOG_V12.mdReplaced *** with --- for horizontal rules
doc/changelogs/CHANGELOG_IOJS.mdReplaced *** with --- for horizontal rules
doc/api/util.mdRemoved spaces in union type annotations
doc/api/url.mdRemoved spaces in union type annotations
doc/api/type-map.jsonAdded new file mapping type names to documentation URLs for the linter
doc/api/test.mdRemoved spaces in union type annotations
doc/api/stream.mdCollapsed multi-line type annotations to single lines, removed spaces in union types
doc/api/sqlite.mdRemoved spaces in union type annotations, converted link-style references to inline type references, removed self-referential link
doc/api/process.mdRemoved spaces in union type annotations
doc/api/modules.mdRemoved spaces in union type annotations
doc/api/module.mdRemoved duplicate stability node
doc/api/inspector.mdRemoved duplicate stability node
doc/api/https.mdRemoved spaces in union type annotations
doc/api/http2.mdRemoved spaces in union type annotations
doc/api/http.mdRemoved spaces in union type annotations
doc/api/errors.mdExtended short commit hash to full 40-character format
doc/api/dns.mdRemoved spaces in union type annotations
doc/api/diagnostics_channel.mdRemoved spaces in union type annotations
doc/api/deprecations.mdSeparated combined pr-url array into individual version entries with distinct pr-urls
doc/api/crypto.mdRemoved spaces in union type annotations
doc/api/buffer.mdRemoved spaces in union type annotations
doc/README.mdReplaced *** with --- for horizontal rules

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

@avivkeller

Copy link
Copy Markdown
MemberAuthor

Blocked by #57343

@avivkelleravivkeller closed this by deleting the head repository Dec 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@avivkeller@nodejs-github-bot@JakobJingleheimer@aduh95