refactor(react): extract @nodejs/doc-kit-generator-react package by avivkeller · Pull Request #959 · nodejs/doc-kit

avivkeller · 2026-07-30T21:30:24Z

The React/JSX-based generators (html, renamed from web), jsx-ast, llms-txt, sitemap, and orama-db have moved into the new @nodejs/doc-kit-generator-react package (entering npm at 0.1.0), and are loaded via import specifiers such as @nodejs/doc-kit-generator-react/html.

To avoid breaking existing CLIs, the html generator can still be referred to by the web specifier.

The core package declares the generator packages as optional peer dependencies: the loader emits a clear "install that package" error when a generator package is missing, and the README now documents the install requirement.

Naming follows the @nodejs scope per nodejs/TSC#1178 and the package namespace migration (see discussion in #961).

vercel · 2026-07-30T21:30:26Z

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

Project	Deployment	Actions	Updated (UTC)
api-docs-tooling	Ready	Preview	Aug 4, 2026 2:44am

cursor · 2026-07-30T21:34:02Z

PR Summary

High Risk
Major release with removed @node-core/doc-kit/* exports and a required separate install for modern generators; misconfigured installs or stale web config keys could break CI and downstream sites until migrated to html and the new package.

Overview
This PR splits the React/JSX documentation pipeline out of @node-core/doc-kit into a new @nodejs/doc-kit-generator-react package (packages/react). The generators html (formerly web), jsx-ast, llms-txt, sitemap, and orama-db are relocated there, with matching subpath exports (e.g. @nodejs/doc-kit-generator-react/html).

Core changes: @node-core/doc-kit drops those generator implementations and their heavy dependencies (Vite, Preact, Orama UI, etc.). The built-in generator map now resolves html, jsx-ast, and the other targets to the new package. @nodejs/doc-kit-generator-react is an optional peer dependency so legacy-only workflows can stay on core alone. The web shorthand and -t web remain via deprecatedGenerators, but config keys use html instead of web.

The getRemarkRecma JSX pipeline is removed from core remark.mjs and lives under packages/react/src/jsx-ast/utils/remark.mjs. Docs, beta/www configs, Vercel build, and README examples are updated from web to html and note that the react package must be installed for the modern site.

^{Reviewed by Cursor Bugbot for commit eb5ee4a. Bugbot is set up for automated code reviews on this repo. Configure here.}

Copilot

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

ovflowd · 2026-08-01T10:36:45Z

The React/JSX-based generators (html, renamed from web), jsx-ast, llms-txt, sitemap, and orama-db have moved into the new @doc-kittens/react package, and are loaded via import specifiers such as @doc-kittens/react/html.

@avivkeller ensure documentation is up to date!

codecov · 2026-08-01T10:37:10Z

Codecov Report

❌ Patch coverage is 94.40789% with 17 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.64%. Comparing base (d3306a2) to head (eb5ee4a).

Files with missing lines	Patch %	Lines
...react/src/sitemap/utils/createPageSitemapEntry.mjs	63.15%	7 Missing ⚠️
scripts/build-docs-content.mjs	0.00%	6 Missing ⚠️
www/doc-kit.config.mjs	0.00%	2 Missing ⚠️
beta/doc-kit.config.mjs	0.00%	1 Missing ⚠️
packages/react/src/jsx-ast/utils/remark.mjs	98.75%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #959      +/-   ##
==========================================
+ Coverage   89.61%   89.64%   +0.03%     
==========================================
  Files         197      198       +1     
  Lines       18416    18480      +64     
  Branches     1724     1727       +3     
==========================================
+ Hits        16503    16566      +63     
- Misses       1906     1907       +1     
  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.

Copilot

Pull request overview

Copilot reviewed 45 out of 103 changed files in this pull request and generated no new comments.

Suppressed comments (2)

packages/react/src/sitemap/utils/createPageSitemapEntry.mjs:7

The function accepts a lastmod argument but the JSDoc doesn’t document it, which makes the generated typings/docs incomplete and misleading.
packages/react/package.json:4
packages/react/package.json declares version 0.0.0, but package-lock.json records this workspace as 1.0.0 (see package-lock.json:11385). This inconsistency can cause confusing installs/publishes; the lockfile should reflect the package.json version.

  "version": "0.0.0",

github-actions · 2026-08-01T15:28:47Z