Skip to content

refactor(legacy): extract @nodejs/doc-kit-generator-legacy package - #960

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

refactor(legacy): extract @nodejs/doc-kit-generator-legacy package#960
avivkeller wants to merge 1 commit into
refactor/react-kittenfrom
refactor/legacy-kitten

Conversation

@avivkeller

@avivkeller avivkeller commented Jul 30, 2026

Copy link
Copy Markdown
Member

The legacy-format generators (legacy-html, legacy-html-all, legacy-json, and legacy-json-all) have moved into the new @nodejs/doc-kit-generator-legacy package (entering npm at 1.0.0), and are loaded via import specifiers such as @nodejs/doc-kit-generator-legacy/legacy-html.

@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 Aug 4, 2026 2:44am

Request Review

@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
Copilot AI review requested due to automatic review settings July 30, 2026 21:34
@cursor

cursor Bot commented Jul 30, 2026

Copy link
Copy Markdown

PR Summary

High Risk
Major semver bump removes core package exports and requires a new dependency; misconfigured installs will break legacy doc generation at dynamic load time, though generator behavior is largely a move with import path updates.

Overview
Legacy HTML and JSON generators are moved out of @node-core/doc-kit into a new @nodejs/doc-kit-generator-legacy package (legacy-html, legacy-html-all, legacy-json, legacy-json-all). The core package drops the ./legacy-* exports and lists the new package as an optional peer; CLI shorthand names (legacy-html, etc.) still resolve through publicGenerators to @nodejs/doc-kit-generator-legacy/*.

Implementation code and assets live under packages/legacy; generators import shared utilities from @node-core/doc-kit instead of relative core paths. legacyToJSON moves from core utils/generators.mjs into the legacy package (tests relocated accordingly). Tooling paths (c8, ESLint) point at packages/legacy/src/legacy-html/assets.

Breaking: consumers must install @nodejs/doc-kit-generator-legacy and use @nodejs/doc-kit-generator-legacy/legacy-html (etc.) instead of @node-core/doc-kit/legacy-html — marked major in the changeset for both packages.

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

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.

Copilot AI review requested due to automatic review settings August 1, 2026 10:36
@ovflowd
ovflowd force-pushed the refactor/legacy-kitten branch from 9d9d060 to 0f93e3d Compare August 1, 2026 10:36
@codecov

codecov Bot commented Aug 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.65%. Comparing base (eb5ee4a) to head (e2f3047).

Additional details and impacted files
@@                  Coverage Diff                   @@
##           refactor/react-kitten     #960   +/-   ##
======================================================
  Coverage                  89.64%   89.65%           
======================================================
  Files                        198      200    +2     
  Lines                      18480    18493   +13     
  Branches                    1727     1729    +2     
======================================================
+ Hits                       16566    16579   +13     
  Misses                      1907     1907           
  Partials                       7        7           

☔ 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.

@ovflowd

ovflowd commented Aug 1, 2026

Copy link
Copy Markdown
Member

The legacy-format generators (legacy-html, legacy-html-all, legacy-json, and legacy-json-all) have moved into the new @doc-kittens/legacy package, and are loaded via import specifiers such as @doc-kittens/legacy/legacy-html.

nit: can we name it @doc-kittens/legacy-nodejs? (also fine w/ current)

@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 1 potential issue.

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 0f93e3d. Configure here.

Comment thread eslint.config.mjs

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.

Pull request overview

Copilot reviewed 26 out of 45 changed files in this pull request and generated 1 comment.

Comment thread .changeset/legacy-kitten-package.md Outdated
Comment on lines +2 to +3
'@doc-kittens/legacy': major
'@node-core/doc-kit': minor
@avivkeller
avivkeller force-pushed the refactor/legacy-kitten branch from 0f93e3d to d75c211 Compare August 1, 2026 15:26
Copilot AI review requested due to automatic review settings August 3, 2026 17:01
@avivkeller
avivkeller force-pushed the refactor/legacy-kitten branch from d75c211 to 2fdc942 Compare August 3, 2026 17:01

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.

@avivkeller avivkeller changed the title refactor(legacy): extract @doc-kittens/legacy package refactor(legacy): extract @nodejs/doc-kit-legacy package Aug 3, 2026
Copilot AI review requested due to automatic review settings August 4, 2026 02:43
@avivkeller
avivkeller force-pushed the refactor/legacy-kitten branch from 2fdc942 to e2f3047 Compare August 4, 2026 02:43

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.

@avivkeller avivkeller changed the title refactor(legacy): extract @nodejs/doc-kit-legacy package refactor(legacy): extract @nodejs/doc-kit-generator-legacy package Aug 4, 2026
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.

3 participants