Skip to content

Conversation

avivkeller
Copy link
Member

Fixes: #328
Fixes: #350

Linting is being moved to a separate package, @node-core/remark-lint

(As an alternative to this PR, we could also have this package depend on remark-lint, but I feel like it's easy enough for consumers to be responsible for that)

Blocked by nodejs/nodejs.org#8057

@Copilot Copilot AI review requested due to automatic review settings August 20, 2025 00:13
@avivkeller avivkeller requested a review from a team as a code owner August 20, 2025 00:13
Copy link

vercel bot commented Aug 20, 2025

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

Project Deployment Preview Updated (UTC)
api-docs-tooling Ready Ready Preview Aug 20, 2025 0:21am

Copy link
Contributor

@Copilot 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 removes the linting functionality from the @node-core/doc-kit package as part of moving linting capabilities to a separate @node-core/remark-lint package. This simplifies the doc-kit package by focusing solely on documentation generation.

  • Removes all linter-related code including rules, reporters, and context
  • Updates the markdown parser to remove linter parameter and calls
  • Removes linter CLI commands and options from the command-line interface
  • Updates build scripts to remove --skip-lint flags since linting is no longer included

Reviewed Changes

Copilot reviewed 29 out of 37 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/parsers/markdown.mjs Removes linter parameter and linting call from createParser function
src/linter/ Complete removal of linter directory with all rules, reporters, context, and utilities
package.json Removes linter-specific dependencies (@actions/core, unist-util-find, unist-util-find-before)
README.md Updates documentation to remove lint command and related options
scripts/vercel-build.sh Removes --skip-lint flag from build script
.github/workflows/generate.yml Removes --skip-lint flag from CI workflow

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link

codecov bot commented Aug 20, 2025

Codecov Report

❌ Patch coverage is 44.44444% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.77%. Comparing base (02d53de) to head (1044123).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
bin/cli.mjs 0.00% 3 Missing ⚠️
bin/commands/generate.mjs 0.00% 1 Missing ⚠️
bin/utils.mjs 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #415      +/-   ##
==========================================
- Coverage   74.22%   71.77%   -2.45%     
==========================================
  Files         118       96      -22     
  Lines       10994     9368    -1626     
  Branches      696      578     -118     
==========================================
- Hits         8160     6724    -1436     
+ Misses       2831     2642     -189     
+ Partials        3        2       -1     

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@avivkeller avivkeller merged commit d4b2833 into main Aug 22, 2025
27 of 29 checks passed
@avivkeller avivkeller deleted the remove-linting branch August 22, 2025 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc-kit vs remark-preset-lint-node Disable Lint by default
3 participants