docs: generate API reference for the React server adapters - #2308
Open
irfanfandi wants to merge 1 commit into
Open
docs: generate API reference for the React server adapters#2308irfanfandi wants to merge 1 commit into
irfanfandi wants to merge 1 commit into
Conversation
…entation - Added new reference entries for Next.js, Remix, and Start in the configuration file. - Created documentation for Next.js, including classes, variables, and functions. - Added documentation for Remix, covering similar structures as Next.js. - Enhanced Start reference documentation with new classes, variables, and functions. - Updated TypeScript configuration for all three packages to include paths for `@tanstack/react-form`.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (21)
📝 WalkthroughWalkthroughAdded Typedoc generation support and API reference pages for the Next.js, Remix, and Start React adapters. Updated documentation TypeScript paths and navigation entries for the new references. ChangesReact adapter documentation
Estimated code review effort: 2 (Simple) | ~15 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
View your CI Pipeline Execution ↗ for commit 8ddd7da
☁️ Nx Cloud last updated this comment at |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2308 +/- ##
==========================================
- Coverage 90.35% 0.00% -90.36%
==========================================
Files 38 11 -27
Lines 1752 99 -1653
Branches 444 29 -415
==========================================
- Hits 1583 0 -1583
+ Misses 149 85 -64
+ Partials 20 14 -6 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The three React server adapters have never had reference docs generated. This registers them, and links them from the sidebar.
Refs #2075.
Root cause
scripts/generate-docs.tsregistered 7 of the 14 packages that ship atsconfig.docs.json. The three server adapters were not among them, so these exports have never had a reference page:react-form-nextjsuseTransform,createServerValidate,initialFormState,ServerValidateErrorreact-form-remixreact-form-startgetFormDataThis is why #2075's link 404s.
useTransformis not part of@tanstack/react-form— it lives in each adapter package, and none of them were fed to TypeDoc.Three things that were not obvious
Registering the packages alone generates nothing. Their
tsconfig.docs.jsonmapped only@tanstack/form-core, so TypeDoc failed on every@tanstack/react-formimport and emitted zero files:Worth flagging: the run still printed
✅ All markdown files have been processed!and exited 0.generateReferenceDocsskips a package whenapp.convert()returns undefined, and itrms the output directory before converting — so a broken docs tsconfig silently empties a framework's reference tree while CI stays green. That lives in@tanstack/config, so it is out of scope here, but I am happy to open an issue there if useful.Each adapter needs its own output directory. All three export a
useTransformand aServerValidateError; nextjs and remix also both exportcreateServerValidateandinitialFormState. A shared directory would overwrite two of the three adapters with no warning.react-storeis excluded alongsidereact-form. The adapters re-exportuseStoreanduseSelectorfrom it, which the React reference already documents — without the exclusion each adapter added a third duplicate of both pages.On #2075 specifically
The URL in that issue,
framework/react/reference/functions/useTransform, will still 404 after this PR, and I would rather say so up front than have a reviewer find it.useTransformis declaredexport const useTransform: (fn, deps?) => ..., so TypeDoc classifies it as a Variable, not a Function. The canonical pages are:framework/react/reference/nextjs/variables/useTransformframework/react/reference/remix/variables/useTransformframework/react/reference/start/variables/useTransformThe old path was never valid — it came from a
docs/config.jsonentry pointing at a page TypeDoc had no way to produce (removed in #2278). If you would prefer a redirect for the old URL instead of, or in addition to, the new pages, say the word.Sidebar
Three entries, mirroring the existing
React Referencerather than listing all 16 pages — the React section curates 6 entries out of 24 generated pages, and each adapter'sindex.mdalready links to every one of its children, so nothing is orphaned.Verification
test:docstest:docswith a deliberately broken new nav entryAPI Reference > react > Next.js Referenceprettier/eslint/tsc --noEmitsherif/knip@tanstack/react-starthint is pre-existing onmain)generate-docsrun twicegithub.com/TanStack/formNo changeset:
tsconfig.docs.jsonsits outside each package's publishedfiles(["dist", "src"]), so nothing shipped changes.Summary by CodeRabbit