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 3:16pm

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

PR Summary

High Risk
Major packaging and naming change: @node-core/doc-kit removes generator exports and requires installing @nodejs/doc-kit-generator-react for modern HTML/search outputs; misconfigured installs or configs still using web keys need the deprecated alias or migration to html.

Overview
This PR splits React/JSX generators out of @node-core/doc-kit into a new @nodejs/doc-kit-generator-react package and renames the public web generator to html.

@node-core/doc-kit drops subpath exports and heavy deps (Preact, Vite, Orama UI, etc.) for html, jsx-ast, llms-txt, sitemap, and orama-db. Shorthand targets in generators/index.mjs now resolve to @nodejs/doc-kit-generator-react/*. web remains a deprecated CLI/config alias mapping to the same html implementation. Core adds an optional peer dependency on the React package. The JSX→Recma remark pipeline moves out of core remark.mjs into packages/react/src/jsx-ast/utils/remark.mjs.

@nodejs/doc-kit-generator-react hosts the moved generators under packages/react/, depends on @node-core/doc-kit for config, metadata types, and shared utilities, and exports html, jsx-ast, llms-txt, orama-db, and sitemap (plus html/bundlers/vite).

Docs and tooling switch config keys and -t examples from web to html, note the extra install for redesigned docs, and update beta/www build configs and content assembly to pick up generator READMEs from packages/*/src/*/.

^{Reviewed by Cursor Bugbot for commit 60d4518. 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.63%. Comparing base (e47d0ce) to head (60d4518).

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.60%   89.63%   +0.03%     
==========================================
  Files         197      198       +1     
  Lines       18418    18482      +64     
  Branches     1724     1727       +3     
==========================================
+ Hits        16503    16566      +63     
- Misses       1908     1909       +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