Skip to content

docs: add monorepo overrides guide#1535

Merged
fengmk2 merged 9 commits into
mainfrom
docs-overrides-config
May 11, 2026
Merged

docs: add monorepo overrides guide#1535
fengmk2 merged 9 commits into
mainfrom
docs-overrides-config

Conversation

@fengmk2
Copy link
Copy Markdown
Member

@fengmk2 fengmk2 commented May 8, 2026

Note

Medium Risk
Low product risk (docs-only content), but CI risk is moderate because the E2E matrix adds a new external fixture that can introduce flaky failures or longer runtimes.

Overview
Adds a new Monorepo guide documenting how to use root vite.config.ts with lint.overrides and fmt.overrides for package-specific rules/options, including examples for splitting override configs into separate files.

Wires the new guide into the docs sidebar and updates the lint/fmt config docs to point monorepo users at the override approach.

Extends ecosystem CI by adding the vite-plus-monorepo-overrides fixture to repo.json and running it in the E2E workflow (vp check --fix + vp run verify).

Reviewed by Cursor Bugbot for commit 7597248. Configure here.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 8, 2026

Deploy Preview for viteplus-preview ready!

Name Link
🔨 Latest commit 0687466
🔍 Latest deploy log https://app.netlify.com/projects/viteplus-preview/deploys/6a013cb04c86f40008efd327
😎 Deploy Preview https://deploy-preview-1535--viteplus-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Member Author

fengmk2 commented May 8, 2026


How to use the Graphite Merge Queue

Add the label auto-merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@fengmk2 fengmk2 self-assigned this May 8, 2026
Comment thread docs/guide/monorepo.md Outdated
Comment thread docs/guide/monorepo.md Outdated
@fengmk2 fengmk2 force-pushed the docs-overrides-config branch from 51fd085 to d7e039a Compare May 8, 2026 09:45
Comment thread docs/guide/monorepo.md
@fengmk2 fengmk2 force-pushed the docs-overrides-config branch from fdada6f to 4124ede Compare May 9, 2026 01:36
@fengmk2 fengmk2 linked an issue May 9, 2026 that may be closed by this pull request
4 tasks
@fengmk2
Copy link
Copy Markdown
Member Author

fengmk2 commented May 9, 2026

@cursor review

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

Reviewed by Cursor Bugbot for commit 7597248. Configure here.

@fengmk2 fengmk2 marked this pull request as ready for review May 9, 2026 02:19
Copy link
Copy Markdown
Contributor

@leaysgur leaysgur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the document itself looks fine.

I would like to confirm my understanding: we are going to continue always appending -c for vp lint|fmt, right?

In that case:

  • #1378 and #1380 will become unnecessary
  • Since we cannot force the equivalent of -c on the LSP side, we need to prevent lint/fmt from being written in a non-root vite.config.ts
    • We will cover this with lint rules and avoid modifying the oxapps implementation

Is this correct?

Comment thread docs/.vitepress/config.mts Outdated
Comment thread docs/guide/monorepo.md Outdated
Comment thread docs/guide/monorepo.md Outdated
Comment thread docs/guide/monorepo.md Outdated
Copy link
Copy Markdown
Member

@cpojer cpojer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@fengmk2
Copy link
Copy Markdown
Member Author

fengmk2 commented May 11, 2026

I would like to confirm my understanding: we are going to continue always appending -c for vp lint|fmt, right?

There's no final conclusion yet, but we tend to configure lint and fmt only in the root config and see if this recommended solution can meet the vast majority of needs.

Yes, after this document PR is merged, I will close these 2 PRs.

  • Since we cannot force the equivalent of -c on the LSP side, we need to prevent lint/fmt from being written in a non-root vite.config.ts

    • We will cover this with lint rules and avoid modifying the oxapps implementation

Yes, after our oxlint plugin is merged, new rules will be added to intercept it.

fengmk2 and others added 2 commits May 11, 2026 10:03
Co-authored-by: Christoph Nakazawa <xnakazawa@pm.me>
Signed-off-by: MK (fengmk2) <fengmk2@gmail.com>
@fengmk2 fengmk2 force-pushed the docs-overrides-config branch from 9763ae8 to 0687466 Compare May 11, 2026 02:19
@fengmk2 fengmk2 merged commit 70b91ba into main May 11, 2026
79 checks passed
@fengmk2 fengmk2 deleted the docs-overrides-config branch May 11, 2026 03:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to handle monorepos?

3 participants