refactor(react): extract @nodejs/doc-kit-react package - #959
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
PR SummaryHigh Risk Overview The site generator is Downstream configs, README, beta/www builds, and content scripts are updated from Reviewed by Cursor Bugbot for commit 137230e. Bugbot is set up for automated code reviews on this repo. Configure here. |
316965a to
fbba838
Compare
@avivkeller ensure documentation is up to date! |
Codecov Report❌ Patch coverage is 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. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
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
lastmodargument but the JSDoc doesn’t document it, which makes the generated typings/docs incomplete and misleading.
packages/react/package.json:4 packages/react/package.jsondeclares version0.0.0, butpackage-lock.jsonrecords this workspace as1.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",
fbba838 to
f8d1d66
Compare
|
| File | Main | PR | Change |
|---|---|---|---|
assets/style-C71voUGG.css |
145.41 KB | — | -145.41 KB (-100.0%) |
assets/style-CsEaebAV.css |
— | 145.41 KB | +145.41 KB |
assets/SearchBox-DhMZ_1pl.js |
84.66 KB | — | -84.66 KB (-100.0%) |
assets/SearchBox-C0a64dpP.js |
— | 84.66 KB | +84.66 KB |
assets/dist-DZxVZ9qZ.js |
30.40 KB | — | -30.40 KB (-100.0%) |
assets/dist-nI7qzw7G.js |
— | 30.40 KB | +30.40 KB |
assets/SideBar-DsKFL2o5.js |
25.23 KB | — | -25.23 KB (-100.0%) |
assets/SideBar-DsJWuKyV.js |
— | 25.23 KB | +25.23 KB |
assets/runtime-DntzJoZw.js |
19.67 KB | — | -19.67 KB (-100.0%) |
assets/runtime-BbB1TyvK.js |
— | 19.67 KB | +19.67 KB |
assets/Combination-vlXV4tgm.js |
16.10 KB | — | -16.10 KB (-100.0%) |
assets/Combination-CrZkajvM.js |
— | 16.10 KB | +16.10 KB |
assets/Layout-DH6LFOEc.js |
16.02 KB | — | -16.02 KB (-100.0%) |
assets/Layout-DqX2ZAy6.js |
— | 16.02 KB | +16.02 KB |
assets/compat.module-JrDPG4EO.js |
13.98 KB | — | -13.98 KB (-100.0%) |
assets/compat.module-Ct9DuSmt.js |
— | 13.98 KB | +13.98 KB |
assets/ThemeToggle-CSgq0zM4.js |
13.56 KB | — | -13.56 KB (-100.0%) |
assets/ThemeToggle-Dd_vDJ_l.js |
— | 13.56 KB | +13.56 KB |
assets/dist-Dt82E3HG.js |
10.17 KB | — | -10.17 KB (-100.0%) |
assets/dist-5WtKIcjl.js |
— | 10.17 KB | +10.17 KB |
assets/Tooltip-Cvt84Qwb.js |
7.86 KB | — | -7.86 KB (-100.0%) |
assets/Tooltip-ipzmyMsi.js |
— | 7.86 KB | +7.86 KB |
assets/dist-BkZS49n4.js |
6.95 KB | — | -6.95 KB (-100.0%) |
assets/dist-BivGroMb.js |
— | 6.95 KB | +6.95 KB |
assets/withIsland-CmW1O1cx.js |
5.05 KB | — | -5.05 KB (-100.0%) |
assets/withIsland-DuZQzWmL.js |
— | 5.05 KB | +5.05 KB |
assets/dist-on76HIEw.js |
3.91 KB | — | -3.91 KB (-100.0%) |
assets/dist-CAnQkfqv.js |
— | 3.91 KB | +3.91 KB |
assets/CodeTabs-CK0r_lts.js |
3.80 KB | — | -3.80 KB (-100.0%) |
assets/CodeTabs-BRI_YGSz.js |
— | 3.80 KB | +3.80 KB |
assets/CodeBox-BTJdWSHF.js |
3.33 KB | — | -3.33 KB (-100.0%) |
assets/CodeBox-BEh2wnEi.js |
— | 3.33 KB | +3.33 KB |
assets/404-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/addons-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/all-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/assert-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/async_context-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/async_hooks-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/buffer-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/child_process-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/cli-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/cluster-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/console-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/crypto-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/debugger-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/deprecations-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/dgram-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/diagnostics_channel-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/dns-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/documentation-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/domain-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/dtls-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/embedding-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/environment_variables-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/errors-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/esm-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/events-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/ffi-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/fs-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/globals-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/http-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/http2-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/https-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/index-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/inspector-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/intl-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/module-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/modules-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/n-api-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/net-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/os-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/packages-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/path-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/perf_hooks-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/permissions-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/process-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/punycode-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/querystring-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/quic-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/readline-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/repl-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/report-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/single-executable-applications-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/sqlite-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/stream-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/stream_iter-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/string_decoder-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/synopsis-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/test-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/timers-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/tls-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/tracing-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/tty-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/typescript-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/url-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/util-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/v8-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/vfs-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/vm-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/wasi-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/webcrypto-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/webstreams-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/worker_threads-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/zlib-BMju8SbF.js |
2.27 KB | — | -2.27 KB (-100.0%) |
assets/404-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/addons-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/all-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/assert-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/async_context-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/async_hooks-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/buffer-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/child_process-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/cli-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/cluster-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/console-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/crypto-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/debugger-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/deprecations-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/dgram-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/diagnostics_channel-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/dns-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/documentation-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/domain-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/dtls-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/embedding-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/environment_variables-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/errors-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/esm-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/events-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/ffi-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/fs-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/globals-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/http-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/http2-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/https-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/index-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/inspector-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/intl-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/module-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/modules-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/n-api-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/net-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/os-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/packages-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/path-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/perf_hooks-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/permissions-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/process-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/punycode-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/querystring-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/quic-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/readline-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/repl-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/report-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/single-executable-applications-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/sqlite-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/stream-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/stream_iter-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/string_decoder-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/synopsis-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/test-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/timers-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/tls-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/tracing-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/tty-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/typescript-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/url-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/util-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/v8-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/vfs-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/vm-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/wasi-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/webcrypto-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/webstreams-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/worker_threads-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/zlib-WYQ72TTB.js |
— | 2.27 KB | +2.27 KB |
assets/FunctionSignature--vYPqp0N.js |
2.19 KB | — | -2.19 KB (-100.0%) |
assets/FunctionSignature-BGXOBmIf.js |
— | 2.19 KB | +2.19 KB |
assets/Banner-CQ9Eo5AQ.js |
2.07 KB | — | -2.07 KB (-100.0%) |
assets/Banner-Cdcs1sL3.js |
— | 2.07 KB | +2.07 KB |
assets/ChangeHistory-CbCNh6Qy.js |
1.71 KB | — | -1.71 KB (-100.0%) |
assets/ChangeHistory-Hwwa1XLG.js |
— | 1.71 KB | +1.71 KB |
assets/DataTag-BMdePJww.js |
841.00 B | — | -841.00 B (-100.0%) |
assets/DataTag-Dfs6R-Pf.js |
— | 841.00 B | +841.00 B |
assets/classnames-DjbEmXLp.js |
752.00 B | — | -752.00 B (-100.0%) |
assets/classnames-PAVDuj4E.js |
— | 752.00 B | +752.00 B |
assets/Badge-YKuOTjvS.js |
604.00 B | — | -604.00 B (-100.0%) |
assets/Badge-Bt4Rt2uL.js |
— | 604.00 B | +604.00 B |
assets/AlertBox-B8e6kpol.js |
588.00 B | — | -588.00 B (-100.0%) |
assets/AlertBox-CDGzLaV-.js |
— | 588.00 B | +588.00 B |
assets/ArrowUpRightIcon-DiaKOSdz.js |
587.00 B | — | -587.00 B (-100.0%) |
assets/ArrowUpRightIcon-xdn9vbgG.js |
— | 587.00 B | +587.00 B |
assets/CodeBracketIcon-DiKGgkp_.js |
520.00 B | — | -520.00 B (-100.0%) |
assets/CodeBracketIcon-D8y2dMIO.js |
— | 520.00 B | +520.00 B |
assets/dist-BnRoTATj.js |
484.00 B | — | -484.00 B (-100.0%) |
assets/dist-Br2v1rdF.js |
— | 484.00 B | +484.00 B |
assets/ChevronDownIcon-96oumonC.js |
476.00 B | — | -476.00 B (-100.0%) |
assets/ChevronDownIcon-rC_qcmcX.js |
— | 476.00 B | +476.00 B |
assets/jsx-runtime-CVMjMUuh.js |
460.00 B | — | -460.00 B (-100.0%) |
assets/jsx-runtime-juWiB0sU.js |
— | 460.00 B | +460.00 B |
assets/relativeOrAbsolute-O0_P1F_C.js |
304.00 B | — | -304.00 B (-100.0%) |
assets/relativeOrAbsolute-BTlcaPVs.js |
— | 304.00 B | +304.00 B |
all.html |
31.41 MB | 31.41 MB | -200.00 B (-0.0%) |
assets/Blockquote-C5AU-c-u.js |
168.00 B | — | -168.00 B (-100.0%) |
assets/Blockquote-CzuYJbkH.js |
— | 168.00 B | +168.00 B |
Performance estimate (single CI run)
- Generation time: 2.4% faster (86.43 s → 84.39 s)
- Peak memory: 5.2% lower (4.88 GB → 4.63 GB)
bmuenzenmeyer
left a comment
There was a problem hiding this comment.
blocking until we align on the scope name per #961
f8d1d66 to
137230e
Compare
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Want fixes drafted automatically? Bugbot Autofix can create code changes for findings. A team admin can enable Autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 137230e. Configure here.
| "piscina": "^5.3.0", | ||
| "preact": "^10.29.7", | ||
| "preact-render-to-string": "^6.7.0", | ||
| "reading-time": "^1.5.0", |
There was a problem hiding this comment.
Core missing react package dependency
High Severity
publicGenerators now resolves html, orama-db, llms-txt, sitemap, and jsx-ast to @nodejs/doc-kit-react/*, but @node-core/doc-kit neither depends on nor peer-depends on that package. After publish, npx doc-kit generate -t html (and the deprecated web alias) fail with a module-not-found unless consumers separately install @nodejs/doc-kit-react, which README examples never mention.
Additional Locations (2)
Reviewed by Cursor Bugbot for commit 137230e. Configure here.


The React/JSX-based generators (
html, renamed fromweb),jsx-ast,llms-txt,sitemap, andorama-dbhave moved into the new@nodejs/doc-kit-reactpackage, and are loaded via import specifiers such as@nodejs/doc-kit-react/html.To avoid breaking existing CLIs, the
htmlgenerator can be referred to by thewebspecifier.