-
Notifications
You must be signed in to change notification settings - Fork 182
docs: add monorepo overrides guide #1535
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
Draft
fengmk2
wants to merge
5
commits into
main
Choose a base branch
from
docs-overrides-config
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3ba9b19
docs: add monorepo overrides guide
fengmk2 bc59420
ci: add monorepo overrides ecosystem case
fengmk2 740b155
docs: use singular monorepo wording
fengmk2 d7e039a
ci: format monorepo overrides fixture before verify
fengmk2 fd8a427
docs: verify monorepo vitest plugin example
fengmk2 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| # Monorepo | ||
|
|
||
| Vite+ works well in a monorepo when the shared tool configuration lives in the workspace root. Put the root defaults in `vite.config.ts`, then use `overrides` to apply package-specific lint and format settings. | ||
|
|
||
| This is the recommended pattern for shared quality tooling because the root config stays type-safe and composable, while each app or package can still keep its own Vite, Vitest, framework, or runtime files when that is useful. | ||
|
|
||
| The examples below come from the runnable [`vite-plus-monorepo-overrides`](https://github.com/why-reproductions-are-required/vite-plus-monorepo-overrides) fixture. | ||
|
|
||
| ## Root Config With Overrides | ||
|
|
||
| Use `lint.overrides` for Oxlint rules that only apply to some packages: | ||
|
|
||
| ```ts [vite.config.ts] | ||
| import { defineConfig } from 'vite-plus'; | ||
|
|
||
| export default defineConfig({ | ||
| lint: { | ||
| plugins: ['typescript'], | ||
| options: { | ||
| typeAware: true, | ||
| typeCheck: true, | ||
| }, | ||
| rules: { | ||
| 'no-console': ['error', { allow: ['warn', 'error'] }], | ||
| }, | ||
| overrides: [ | ||
| { | ||
| files: ['apps/web/**', 'packages/ui/**'], | ||
| plugins: ['typescript', 'react'], | ||
| rules: { | ||
| 'react/self-closing-comp': 'error', | ||
| }, | ||
| }, | ||
| { | ||
| files: ['apps/api/**'], | ||
| env: { | ||
| node: true, | ||
| }, | ||
| rules: { | ||
| 'no-console': 'off', | ||
| }, | ||
| }, | ||
| { | ||
| files: ['**/*.test.ts', '**/*.spec.ts'], | ||
| plugins: ['typescript', 'vitest'], | ||
| rules: { | ||
| '@typescript-eslint/no-explicit-any': 'off', | ||
| 'vitest/no-disabled-tests': 'error', | ||
| }, | ||
| }, | ||
| ], | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| Globs are resolved from the root `vite.config.ts`, so use workspace paths such as `apps/web/**`, `apps/api/**`, and `packages/ui/**`. | ||
|
|
||
| ::: tip | ||
| When a `lint.overrides` entry sets `plugins`, include the plugins needed for that file group. If you omit `plugins`, the override uses the base `lint.plugins` value. | ||
| ::: | ||
|
|
||
| ## Format Overrides | ||
|
|
||
| Use `fmt.overrides` for file or package-specific Oxfmt options. Formatter overrides put their settings under `options`: | ||
|
|
||
| ```ts [vite.config.ts] | ||
| import { defineConfig } from 'vite-plus'; | ||
|
|
||
| export default defineConfig({ | ||
| fmt: { | ||
| singleQuote: true, | ||
| semi: true, | ||
| overrides: [ | ||
| { | ||
| files: ['apps/api/**'], | ||
| options: { | ||
| printWidth: 120, | ||
| }, | ||
| }, | ||
| { | ||
| files: ['**/*.md'], | ||
| options: { | ||
| proseWrap: 'always', | ||
| }, | ||
| }, | ||
| ], | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| ## Splitting Config Files | ||
|
|
||
| You can still split configuration across your repository. Export normal JavaScript objects from nearby files, import them in the root config, and merge them into the matching override. | ||
|
|
||
| ```ts [tooling/lint/react.ts] | ||
| import type { OxlintOverride } from 'vite-plus/lint'; | ||
|
|
||
| export const reactLint = { | ||
| plugins: ['typescript', 'react'], | ||
| rules: { | ||
| 'react/self-closing-comp': 'error', | ||
| }, | ||
| } satisfies Omit<OxlintOverride, 'files'>; | ||
| ``` | ||
|
|
||
| ```ts [tooling/lint/node.ts] | ||
| import type { OxlintOverride } from 'vite-plus/lint'; | ||
|
|
||
| export const nodeLint = { | ||
| env: { | ||
| node: true, | ||
| }, | ||
| rules: { | ||
| 'no-console': 'off', | ||
| }, | ||
| } satisfies Omit<OxlintOverride, 'files'>; | ||
| ``` | ||
|
|
||
| ```ts [vite.config.ts] | ||
| import { defineConfig } from 'vite-plus'; | ||
|
|
||
| import { nodeLint } from './tooling/lint/node'; | ||
| import { reactLint } from './tooling/lint/react'; | ||
|
|
||
| export default defineConfig({ | ||
| lint: { | ||
| plugins: ['typescript'], | ||
| options: { | ||
| typeAware: true, | ||
| typeCheck: true, | ||
| }, | ||
| overrides: [ | ||
| { | ||
| files: ['apps/web/**', 'packages/ui/**'], | ||
| ...reactLint, | ||
| }, | ||
| { | ||
| files: ['apps/api/**'], | ||
| ...nodeLint, | ||
| }, | ||
| ], | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| This keeps the behavior centralized while letting each team or package own the pieces of config it needs. | ||
|
|
||
| ## App Commands | ||
|
|
||
| The root `vite.config.ts` is most valuable for shared linting, formatting, staged checks, and task definitions. For project-specific development, build, and test behavior, use the setup that best matches each app: | ||
|
|
||
| - Pass a folder to built-in Vite commands when you want to target one app: | ||
|
|
||
| ```bash | ||
| vp dev apps/web | ||
| vp build apps/web | ||
| ``` | ||
|
|
||
| - Keep package-specific scripts in each package when the command differs per app: | ||
|
|
||
| ```json [apps/api/package.json] | ||
| { | ||
| "scripts": { | ||
| "dev": "tsx watch src/index.ts", | ||
| "build": "tsc -p tsconfig.json" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| - Run scripts across the workspace with `vp run`: | ||
|
|
||
| ```bash | ||
| vp run -r build | ||
| vp run -r --parallel dev | ||
| vp run --filter ./apps/web build | ||
| ``` | ||
|
|
||
| See the [Run guide](/guide/run) for recursive, parallel, filtered, and cached workspace tasks. | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make sure the plugins example actually exists and is not fabricated