Skip to content

refactor(node): extract @doc-kittens/node package - #961

Open
avivkeller wants to merge 1 commit into
refactor/legacy-kittenfrom
refactor/node-kitten
Open

refactor(node): extract @doc-kittens/node package#961
avivkeller wants to merge 1 commit into
refactor/legacy-kittenfrom
refactor/node-kitten

Conversation

@avivkeller

@avivkeller avivkeller commented Jul 30, 2026

Copy link
Copy Markdown
Member

And finally, the remaining Node.js-specific generators are now in @doc-kittens/node

@vercel

vercel Bot commented Jul 30, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
api-docs-tooling Ready Ready Preview Jul 30, 2026 9:31pm

Request Review

Copilot AI review requested due to automatic review settings July 30, 2026 21:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@codecov

codecov Bot commented Jul 30, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 62.50000% with 9 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (refactor/legacy-kitten@9d9d060). Learn more about missing BASE report.

Files with missing lines Patch % Lines
packages/node/src/man-page/generate.mjs 0.00% 5 Missing ⚠️
packages/node/src/addon-verify/generate.mjs 0.00% 2 Missing ⚠️
packages/node/src/api-links/index.mjs 0.00% 2 Missing ⚠️
Additional details and impacted files
@@                    Coverage Diff                    @@
##             refactor/legacy-kitten     #961   +/-   ##
=========================================================
  Coverage                          ?   78.43%           
=========================================================
  Files                             ?      214           
  Lines                             ?    19112           
  Branches                          ?     1564           
=========================================================
  Hits                              ?    14990           
  Misses                            ?     4114           
  Partials                          ?        8           

☔ View full report in Codecov by Harness.
📢 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 marked this pull request as ready for review July 30, 2026 21:34
@avivkeller
avivkeller requested a review from a team as a code owner July 30, 2026 21:34
@cursor

cursor Bot commented Jul 30, 2026

Copy link
Copy Markdown

PR Summary

Medium Risk
Breaking change for consumers that imported generators from @node-core/doc-kit subpaths; CLI shorthand behavior is preserved via the lookup table.

Overview
Node-specific generators (api-links, addon-verify, and man-page) are moved out of @node-core/doc-kit into a new @doc-kittens/node package. Core’s generator map now resolves the same CLI/config shorthand names (man-page, addon-verify, api-links) to @doc-kittens/node/* instead of @node-core/doc-kit/*, and those subpath exports are removed from core.

Moved code is updated to depend on @node-core/doc-kit for config, file helpers, metadata types, and threading. estree-util-visit moves with api-links into the node package and is dropped from core’s dependencies. Docs and examples use html instead of web for the redesigned docs target.

Direct imports of @node-core/doc-kit/man-page, api-links, or addon-verify must switch to @doc-kittens/node/... (changeset: major on @doc-kittens/node, minor on @node-core/doc-kit).

Reviewed by Cursor Bugbot for commit 1043c7e. Bugbot is set up for automated code reviews on this repo. Configure here.

@cursor cursor Bot 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.

Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 1043c7e. Configure here.

return dedent`
'use strict';
const common = require('../../common');
const common = require('@node-core/doc-kit/generators/common');

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Wrong require in generated tests

High Severity

updateJsRequirePaths now embeds require('@node-core/doc-kit/generators/common') into generated addon test.js files. Those files run under Node.js's test/addons tree and need the relative ../../common helper for common.buildType, so addon verification will fail to resolve the module.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 1043c7e. Configure here.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

🤦 Find + Replace always has quirks

'addon-verify': '@node-core/doc-kit/addon-verify',
'api-links': '@node-core/doc-kit/api-links',
'addon-verify': '@doc-kittens/node/addon-verify',
'api-links': '@doc-kittens/node/api-links',

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Missing node package manifest

High Severity

The new @doc-kittens/node package is registered in the lockfile and wired up via shorthand aliases, but packages/node/package.json is absent. Without a manifest and exports map, imports such as @doc-kittens/node/man-page cannot resolve, so man-page, addon-verify, and api-links fail to load.

Additional Locations (2)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 1043c7e. Configure here.

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