Skip to content

Conversation

avivkeller
Copy link
Member

Follow-up #8057.

Now that we have a basic package, this PR modifies the rules to use @nodejs/doc-kit's functionality, ensuring that any changes their get reflected in the linter.

Why was this separate from #8057? I wanted a version (1.0.0) which is almost a drop-in replacement for the original linter, without relying on @nodejs/doc-kit, in case something broke.

@avivkeller avivkeller requested review from a team as code owners August 22, 2025 23:32
Copy link

vercel bot commented Aug 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
nodejs-org Ready Ready Preview Aug 24, 2025 7:40pm

@@ -61,6 +63,7 @@ export default (options = {}) => ({
{ yes: 'Unix' },
{ yes: 'Valgrind' },
{ yes: 'V8' },
{ yes: 'npm' },
Copy link
Member Author

Choose a reason for hiding this comment

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

@Ethan-Arrowood is this what you had in mind?

Copy link

codecov bot commented Aug 22, 2025

Codecov Report

❌ Patch coverage is 98.09524% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 76.03%. Comparing base (a9e90a2) to head (d406efc).
⚠️ Report is 2 commits behind head on main.
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
...emark-lint/src/rules/duplicate-stability-nodes.mjs 92.00% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8106      +/-   ##
==========================================
+ Coverage   75.88%   76.03%   +0.15%     
==========================================
  Files         112      114       +2     
  Lines        9433     9503      +70     
  Branches      303      313      +10     
==========================================
+ Hits         7158     7226      +68     
- Misses       2274     2275       +1     
- Partials        1        2       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@avivkeller
Copy link
Member Author

@nodejs/web what other lint rules are needed?

I'm thinking:

  • Typed lists syntax
  • Stability node syntax
  • Alphabetical typed headings

What else?

Copy link
Member

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

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

OOC, when we add new rules, in which repositories are they being applied? doc-kit? So it means Node's core API docs? Shouldn't then any PR to remark-lint actually require nodejs/collaborators as code owners?

@avivkeller
Copy link
Member Author

OOC, when we add new rules, in which repositories are they being applied? doc-kit? So it means Node's core API docs? Shouldn't then any PR to remark-lint actually require nodejs/collaborators as code owners?

My plan is for these to be applied to nodejs/node once the new tooling is adopted (but it is not dependent on, and could land beforehand).

The previous implementation did not have any CODEOWNERS, thus, this is the same, however, that can change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants