docs: Install vite as a devDependency #5547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

schiller-manuel merged 1 commit into TanStack:main from onlywei:docs-vite-devdep

Oct 23, 2025

Merged

docs: Install vite as a devDependency #5547

schiller-manuel merged 1 commit into TanStack:main from onlywei:docs-vite-devdep

Oct 23, 2025

Conversation

@onlywei

Copy link

Contributor

@onlywei onlywei commented Oct 20, 2025 •

edited by coderabbitai bot

Loading

Summary by CodeRabbit

Documentation
- Updated React build-from-scratch setup guide with reorganized installation instructions that separate development dependencies for improved setup clarity.

@onlywei


 docs: Install vite as a devDependency

2fac361

@github-actions github-actions bot added the documentation label

Oct 20, 2025

@nx-cloud

Copy link

nx-cloud bot commented Oct 20, 2025 •

edited

Loading

View your CI Pipeline Execution ↗ for commit 2fac361

Command	Status	Duration	Result
`nx affected --targets=test:eslint,test:unit,tes...`	✅ Succeeded	<1s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	1s	View ↗

☁️ Nx Cloud last updated this comment at 2025年10月20日 15:22:12 UTC

@coderabbitai

Copy link

Contributor

coderabbitai bot commented Oct 20, 2025 •

edited

Loading

Walkthrough

Documentation updates reorganize installation instructions to move vite and @vitejs/plugin-react from main dependency blocks into separate devDependency installation sections within the React build-from-scratch guide.

Changes

Cohort / File(s)	Summary
Documentation restructuring `docs/start/framework/react/build-from-scratch.md`	Separated tooling dependencies (`vite`, `@vitejs/plugin-react`) into dedicated devDependency install blocks, maintaining the same overall functionality with clarified dependency classification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

TanStack/router#5211: Implements the same docs-level refactoring to move vite and @vitejs/plugin-react into separate devDependency install blocks.

Suggested reviewers

schiller-manuel
brenelz

Poem

🐰 Dev tools tucked in their rightful place,
Vite and plugins now keep separate pace,
Dependencies sorted with careful design,
Build instructions now perfectly align! 🔧✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "docs: Install vite as a devDependency" is clear, specific, and directly related to the changeset. It accurately describes the primary documentation update moving vite from a dependency to a devDependency. While the raw summary indicates that @vitejs/plugin-react was also moved to devDependencies, the title appropriately focuses on vite, which appears to be highlighted first in the changes. The guidance explicitly states that titles don't need to cover every detail of the changeset, and this title clearly communicates the main intent of the documentation update.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7ba07e3 and 2fac361.

📒 Files selected for processing (1)

docs/start/framework/react/build-from-scratch.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Files:

docs/start/framework/react/build-from-scratch.md

docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

docs/start/framework/react/build-from-scratch.md

🔇 Additional comments (3)

docs/start/framework/react/build-from-scratch.md (3)

55-62: Clear reorganization of build tool dependencies.

The separation of vite into a dedicated devDependency section is well-structured and the explanatory text makes the intent clear. The command syntax is correct.

70-74: Well-organized React plugin installation.

The separation of @vitejs/plugin-react into a devDependency section is logical and the documentation preserves helpful context about alternative plugin options on line 76. The npm i -D flag is correctly used.

54-82: Clean documentation update with improved dependency categorization.

The reorganization clearly distinguishes runtime dependencies from development tools, which aids clarity for users following this guide. The instruction sequence remains logical, and all subsequent configuration sections (vite.config.ts, TypeScript setup) correctly reference the properly categorized dependencies.

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

@pkg-pr-new

Copy link

pkg-pr-new bot commented Oct 20, 2025

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5547

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5547

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5547

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5547

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5547

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5547

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5547

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5547

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5547

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5547

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5547

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5547

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5547

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5547

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5547

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5547

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5547

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5547

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5547

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5547

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5547

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5547

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5547

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5547

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5547

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5547

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5547

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5547

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5547

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5547

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5547

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5547

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5547

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5547

commit: 2fac361

@schiller-manuel schiller-manuel merged commit e596798 into TanStack:main

Oct 23, 2025

6 checks passed

Labels

documentation

2 participants

@onlywei @schiller-manuel

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: Install vite as a devDependency #5547

docs: Install vite as a devDependency #5547

Uh oh!

Conversation

@onlywei onlywei commented Oct 20, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

Summary by CodeRabbit

Uh oh!

nx-cloud bot commented Oct 20, 2025 •

edited

Loading

Uh oh!

Uh oh!

coderabbitai bot commented Oct 20, 2025 •

edited

Loading

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

pkg-pr-new bot commented Oct 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

docs: Install vite as a devDependency #5547

docs: Install vite as a devDependency #5547

Uh oh!

Conversation

@onlywei onlywei commented Oct 20, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

nx-cloud bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

pkg-pr-new bot commented Oct 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

@onlywei onlywei commented Oct 20, 2025 •

edited by coderabbitai bot

Loading

nx-cloud bot commented Oct 20, 2025 •

edited

Loading

coderabbitai bot commented Oct 20, 2025 •

edited

Loading