docs: replace deprecated create-tsrouter-app and create-start-app with @tanstack/cli create#6610
docs: replace deprecated create-tsrouter-app and create-start-app with @tanstack/cli create#66102nofa11 wants to merge 1 commit intoTanStack:mainfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
🚧 Files skipped from review as they are similar to previous changes (7)
📝 WalkthroughWalkthroughDocumentation, tutorials, and example files were updated to replace deprecated scaffold commands with the TanStack CLI ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 Tip CodeRabbit can enforce grammar and style rules using `languagetool`.Configure the |
2nofa11
force-pushed
the
chore/update-deprecated-cli-commands
branch
from
0ce1223 to
f94a940
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/router/quick-start.md (1)
40-53:⚠️ Potential issue | 🟡 MinorFile-based and code-based sections now show identical commands — routing mode differentiation is lost
Both sections now use the exact same
npx@tanstack/clicreate my-app(and the--framework solidvariant), whereas the old scaffolders used--template file-routervs--template code-router(or equivalent). A reader arriving at these two distinct sections expecting different setup paths will find no actionable difference.Since
@tanstack/cli createis interactive, the routing mode choice happens during prompts. Consider consolidating the two sections or adding a note explaining the distinction is selected interactively, for example:✏️ Suggested clarification
### File-Based Route Generation The file-based approach is the recommended option for most projects. ... +> [!NOTE] +> When using `@tanstack/cli create`, you'll be prompted to choose between file-based and code-based routing during setup. There is no separate flag required. + <!-- ::start:tabs variant="package-manager" mode="local-install" --> react: npx `@tanstack/cli` create my-app solid: npx `@tanstack/cli` create my-app --framework solid <!-- ::end:tabs --> ### Code-Based Route Configuration If you prefer to define routes programmatically, you can use the code-based route configuration. ... +> [!NOTE] +> Select "code-router" when prompted by the CLI during setup.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/router/quick-start.md` around lines 40 - 53, The two sections "File-based" and "Code-Based Route Configuration" show identical CLI commands, losing routing-mode differentiation; update the docs by either consolidating the two sections into one with a note that `@tanstack/cli` is interactive and routing mode is chosen during prompts, or explicitly restore distinct examples (e.g., mention the historical flags like --template file-router vs --template code-router or add a clarifying line in the "Code-Based Route Configuration" section stating that the CLI will prompt to choose file vs code router and that no separate non-interactive flag is required); ensure the "Code-Based Route Configuration" heading and the CLI examples (react/solid) include this clarification so readers know how to select code routing when creating a project.docs/start/framework/react/tutorial/fetching-external-api.md (1)
38-38:⚠️ Potential issue | 🟡 MinorChange
--add-onto--add-ons(plural)The prose references the incorrect singular form. The official
@tanstack/cliuses--add-ons(plural) as the flag to specify add-ons (e.g.,npx@tanstack/clicreate my-app --add-ons shadcn,clerk,drizzle). This error also appears indocs/start/framework/react/tutorial/reading-writing-file.mdat a similar line.Proposed fix
-Optionally, you can pass in a `--add-on` flag to get options such as Shadcn, Clerk, Convex, TanStack Query, etc. +Optionally, you can pass in a `--add-ons` flag to get options such as Shadcn, Clerk, Convex, TanStack Query, etc.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/start/framework/react/tutorial/fetching-external-api.md` at line 38, Update the incorrect flag text `--add-on` to the correct plural `--add-ons` in the documentation: replace the `--add-on` string where it appears (e.g., the sentence "Optionally, you can pass in a `--add-on` flag...") with `--add-ons`, and apply the same fix in the analogous occurrence in the reading-writing-file.md file so the docs match the official `@tanstack/cli` usage.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/router/quick-start.md`:
- Around line 40-53: The two sections "File-based" and "Code-Based Route
Configuration" show identical CLI commands, losing routing-mode differentiation;
update the docs by either consolidating the two sections into one with a note
that `@tanstack/cli` is interactive and routing mode is chosen during prompts, or
explicitly restore distinct examples (e.g., mention the historical flags like
--template file-router vs --template code-router or add a clarifying line in the
"Code-Based Route Configuration" section stating that the CLI will prompt to
choose file vs code router and that no separate non-interactive flag is
required); ensure the "Code-Based Route Configuration" heading and the CLI
examples (react/solid) include this clarification so readers know how to select
code routing when creating a project.
In `@docs/start/framework/react/tutorial/fetching-external-api.md`:
- Line 38: Update the incorrect flag text `--add-on` to the correct plural
`--add-ons` in the documentation: replace the `--add-on` string where it appears
(e.g., the sentence "Optionally, you can pass in a `--add-on` flag...") with
`--add-ons`, and apply the same fix in the analogous occurrence in the
reading-writing-file.md file so the docs match the official `@tanstack/cli` usage.
…h new CLI commands
2nofa11
force-pushed
the
chore/update-deprecated-cli-commands
branch
from
f94a940 to
0da98f7
Compare
|
Bundle Size Benchmarks
Trend sparkline is historical gzip bytes ending with this PR measurement; lower is better. |
2 participants
The
create-tsrouter-appandcreate-start-appCLI tools are deprecated.This PR replaces all references with the recommended
npx @tanstack/cli create.Also removed obsolete flags:
--template(not supported in@tanstack/cli create)--tailwind(always enabled since TanStack/cli@337eeba)Docs-only change. No code behavior changes.
Summary by CodeRabbit