feat: Pass through vite configLoader option to createViteServer #7574

janis-me · 2025-02-27T10:03:44Z

Description

(this is a draft to verify the implementation. It lacks tests)

This PR

Upgrades vite to 6.2.0 (Mirrors chore(deps): vite 6.2.0 #7568)
Passes through the vite configLoader option to all createViteServer calls
Solves issue Support for vite ModuleRunner or other configLoader alternative #7552

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
Ideally, include a test that fails without this PR but passes with it.
Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

Run the tests with pnpm test:ci.

Documentation

If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

Mirrors vitest-dev#7568

This exposes the option to the CLI, passes it to `ViteInlineConfig`s where needed and adds some docstrings to InlineConfig etc.

netlify · 2025-02-27T10:07:17Z

✅ Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`59630b5`
🔍 Latest deploy log	https://app.netlify.com/sites/vitest-dev/deploys/67e3b10fb6cd050008f4efef
😎 Deploy Preview	https://deploy-preview-7574--vitest-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

janis-me · 2025-02-27T10:09:26Z

packages/vitest/src/node/config/resolveConfig.ts

@@ -160,6 +160,7 @@ export function resolveConfig(
  }

  resolved.clearScreen = resolved.clearScreen ?? viteConfig.clearScreen ?? true
+  resolved.configLoader = resolved.configLoader ?? viteConfig.inlineConfig.configLoader ?? 'bundle'


I am actually unsure about this part. Not sure if this is needed?

As I commented in #7574 (review), configLoader is something meaningful before resolving config, so it's likely we don't need to care about and thus should be removed.

hi-ogawa · 2025-03-01T02:11:18Z

Hey, thanks for the PR 👋 Not sure if it's intentional, but why close? If you want to contribute, opening a PR here is correct instead of on your fork janis-me#1.

janis-me · 2025-03-01T05:31:30Z

Hey, thanks for the PR 👋 Not sure if it's intentional, but why close? If you want to contribute, opening a PR here is correct instead of on your fork janis-me#1.

Hey!

I closed the one to vitest, because I didn't write any tests yet and just wanted to show my "idea" first. But I can re-open It with tests if you are mostly fine with the implementation

hi-ogawa · 2025-03-01T05:37:46Z

Okay, don't worry about leaving an unfinished PR here. You can make it as draft and also fine to ask for the feedback through comments. 👍

hi-ogawa

Typing might be a bit tricky. We don't want UserConfig.configLoader to be available since that means it's allowing defineConfig({ test: { configLoader: "..." } }), but that doesn't work since configLoader is used to load the config.

We probably want to add only CliOptions.configLoader and typing needs to be tweaked on createVitest and initializeProject side.

vitest/packages/vitest/src/node/cli/cli-api.ts

Line 14 in e2c570b

export interface CliOptions extends UserConfig {

Also, configLoader is only available for certain Vite version, so it would be nice if we can detect that by infering the type from import("vite").InlineConfig["configLoader"] or something.

hi-ogawa

I pushed a simple test case.

hi-ogawa · 2025-03-03T02:30:46Z

packages/vitest/src/node/config/resolveConfig.ts

@@ -160,6 +160,7 @@ export function resolveConfig(
  }

  resolved.clearScreen = resolved.clearScreen ?? viteConfig.clearScreen ?? true
+  resolved.configLoader = resolved.configLoader ?? viteConfig.inlineConfig.configLoader ?? 'bundle'


As I commented in #7574 (review), configLoader is something meaningful before resolving config, so it's likely we don't need to care about and thus should be removed.

hi-ogawa · 2025-03-03T02:32:47Z

packages/vitest/src/node/cli/cli-config.ts

+  configLoader: {
+    description:
+      'Use `bundle` to bundle the config with esbuild or `runner` (experimental) to process it on the fly (default: `bundle`)',
+    argument: '<loader>',
+  },


documentation should also mention this is only available from newer Vite version.

Before, it was defined in the `InlineConfig` and thus `UserConfig` interfaces, which would not have worked when the option was passed to e.g `defineConfig(...)`

…` and `configLoader` option

janis-me · 2025-03-03T08:18:26Z

Typing might be a bit tricky. We don't want UserConfig.configLoader to be available since that means it's allowing defineConfig({ test: { configLoader: "..." } }), but that doesn't work since configLoader is used to load the config.

Good catch! I updated the PR to only include configLoader in the CliOptions interface. This means that I needed to change the parameter of createVitest and also needed to add configLoader to InitializeProjectOptions['test']. In both cases, I used vite's InlineConfig["configLoader"] for the type. I hope those should result in never if the vite version is below 6.1.0.

I also noticed, that in browser mode, the config is loaded correctly with the ModuleRunner, but afterwards the browser mode seems to be using the default ESM loader. I probably have to adjust the browser package as well. Looking into that.

Also, thanks for adding the test! I will extend on these to also test more 'complex' configurations.

janis-me · 2025-03-03T13:06:01Z

I also noticed, that in browser mode, the config is loaded correctly with the ModuleRunner, but afterwards the browser mode seems to be using the default ESM loader.

The issue here is, that the createBrowserServer function is passed a TestProject instance, and that instance's options object doesn't set configLoader. I am unsure how to fix this, as TestProject is used in many different ways. I can see that the TestProject class is instanciated by calling initializeProject at

vitest/packages/vitest/src/node/workspace/resolveWorkspace.ts

Lines 75 to 79 in 1a88b1b

    
           projectPromises.push(concurrent(() => initializeProject( 
        
             index, 
        
             vitest, 
        
             { ...options, root, configFile, test: { ...options.test, ...cliOverrides } }, 
        
           )))

So would I need to add configLoader to the overridesOptions? cliOptions in the resolveWorkspace function are typed as UserConfig though, not CliOptions.

vitest/packages/vitest/src/node/workspace/resolveWorkspace.ts

Lines 30 to 35 in 1a88b1b

    
           const overridesOptions = [ 
        
             'logHeapUsage', 
        
             'allowOnly', 
        
             'sequence', 
        
             'testTimeout', 
        
             'pool',

I might not be qualified for working on this feature after all xD

hi-ogawa

Thanks for looking into it 👍 I simplified a bit by passing vite.config.inlineConfig.configLoader to child vite servers, so we don't need to track the config on our typing, but this should essentially give the desired result.

docs/.vitepress/scripts/cli-generator.ts

janis-me · 2025-03-05T16:16:25Z

Thanks a lot for carrying me through this.

Is there something left I can help with? It seems like the test is failing for me, I can investigate why that might be.

pkg-pr-new · 2025-03-05T23:48:29Z

@vitest/browser

npm i https://pkg.pr.new/@vitest/browser@7574

@vitest/coverage-istanbul

npm i https://pkg.pr.new/@vitest/coverage-istanbul@7574

@vitest/expect

npm i https://pkg.pr.new/@vitest/expect@7574

@vitest/coverage-v8

npm i https://pkg.pr.new/@vitest/coverage-v8@7574

@vitest/mocker

npm i https://pkg.pr.new/@vitest/mocker@7574

@vitest/pretty-format

npm i https://pkg.pr.new/@vitest/pretty-format@7574

@vitest/runner

npm i https://pkg.pr.new/@vitest/runner@7574

@vitest/snapshot

npm i https://pkg.pr.new/@vitest/snapshot@7574

@vitest/spy

npm i https://pkg.pr.new/@vitest/spy@7574

@vitest/ui

npm i https://pkg.pr.new/@vitest/ui@7574

@vitest/utils

npm i https://pkg.pr.new/@vitest/utils@7574

vite-node

npm i https://pkg.pr.new/vite-node@7574

@vitest/web-worker

npm i https://pkg.pr.new/@vitest/web-worker@7574

vitest

npm i https://pkg.pr.new/vitest@7574

@vitest/ws-client

npm i https://pkg.pr.new/@vitest/ws-client@7574

commit: 7eee6bf

hi-ogawa · 2025-03-05T23:52:49Z

Is there something left I can help with? It seems like the test is failing for me, I can investigate why that might be.

This will be merged when releasing next minor 3.1. Tests passed on CI, so maybe your local setup issue? If you want to verify if this change works on your project, you may try pkg-pr-new #7574 (comment).

sheremet-va · 2025-03-25T18:13:18Z

Can you resolve merge conflicts?

janis-me · 2025-03-26T07:49:59Z

Done. Note that the lockfile change only consists of the lines

      '@vitest/test-dep-linked':
        specifier: link:./deps/linked
        version: link:deps/linked

which is expected. See 59630b5 for the commit. Hope it looks okay

janis-me added 3 commits February 27, 2025 10:10

chore(deps): vite 6.2.0

7fe1756

Mirrors vitest-dev#7568

feat(dev): Pass through vite configLoader option

26dd30e

This exposes the option to the CLI, passes it to `ViteInlineConfig`s where needed and adds some docstrings to InlineConfig etc.

feat(dev): Support configLoader option for browser mode

489633b

janis-me mentioned this pull request Feb 27, 2025

Support for vite ModuleRunner or other configLoader alternative #7552

Closed

4 tasks

janis-me commented Feb 27, 2025

View reviewed changes

janis-me changed the title ~~Feature: Add vite config loader (FORK, WIP)~~ feat(dev):: Pass through vite configLoader option to createViteServer Feb 28, 2025

janis-me changed the title ~~feat(dev):: Pass through vite configLoader option to createViteServer~~ feat(dev): Pass through vite configLoader option to createViteServer Feb 28, 2025

janis-me closed this Feb 28, 2025

janis-me reopened this Mar 1, 2025

janis-me and others added 3 commits March 1, 2025 13:50

Merge branch 'vitest-dev:main' into feature/vite-config-loader

3c523c9

Merge branch 'main' into feature/vite-config-loader

585f970

chore: cleanup lockfile

af374a4

hi-ogawa changed the title ~~feat(dev): Pass through vite configLoader option to createViteServer~~ feat: Pass through vite configLoader option to createViteServer Mar 3, 2025

hi-ogawa reviewed Mar 3, 2025

View reviewed changes

test: add test

68ff1c5

hi-ogawa reviewed Mar 3, 2025

View reviewed changes

janis-me added 2 commits March 3, 2025 09:08

feat(dev): Allow configLoader option to be passed to CLI only

ff4a563

Before, it was defined in the `InlineConfig` and thus `UserConfig` interfaces, which would not have worked when the option was passed to e.g `defineConfig(...)`

docs: Update documentation related to the changed `createVitestServer…

f2bdac7

…` and `configLoader` option

hi-ogawa added 6 commits March 4, 2025 17:45

wip: pass main vite server's configLoader to child vite servers

6766be9

test: test workspace and browser

46046e0

Merge branch 'main' into feature/vite-config-loader

69a432e

refactor: let createVitest accept CliOptions

45c4fcb

docs: update

5834a53

chore: tweak ts trick

ec15204

hi-ogawa previously approved these changes Mar 4, 2025

View reviewed changes

sheremet-va requested changes Mar 4, 2025

View reviewed changes

docs/.vitepress/scripts/cli-generator.ts Show resolved Hide resolved

sheremet-va previously approved these changes Mar 4, 2025

View reviewed changes

hi-ogawa added this to the 3.1.0 milestone Mar 5, 2025

hi-ogawa added the cr-tracked label Mar 5, 2025

Merge branch 'main' into feature/vite-config-loader

59630b5

janis-me dismissed stale reviews from sheremet-va and hi-ogawa via 59630b5 March 26, 2025 07:47

chore(vitest): Fix order of devDependencies in cli package

7eee6bf

sheremet-va approved these changes Mar 26, 2025

View reviewed changes

sheremet-va merged commit 2a8520a into vitest-dev:main Mar 26, 2025
13 of 14 checks passed

sheremet-va mentioned this pull request Mar 27, 2025

vitest fails to start if volume is mounted read-only #4901

Closed

6 tasks

renovate bot mentioned this pull request Apr 7, 2025

fix(deps): update all non-major dependencies Tchoupinax/s3-prometheus-exporter#190

Merged

1 task

This was referenced Apr 21, 2025

fix(deps): update non-major dependencies orriborri/sump-it#25

Merged

fix(deps): update all non-major dependencies mainmatter/sheepdog#308

Merged

renovate bot mentioned this pull request May 7, 2025

fix(deps): update all non-major dependencies daku10/github-merge-guardian#120

Merged

1 task

renovate bot mentioned this pull request Jun 16, 2025

chore(deps): update all non-major dependencies escapace/snaproll#153

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: Pass through vite configLoader option to createViteServer #7574

feat: Pass through vite configLoader option to createViteServer #7574

Uh oh!

janis-me commented Feb 27, 2025 •

edited by hi-ogawa

Loading

netlify bot commented Feb 27, 2025 •

edited

Loading

janis-me Feb 27, 2025

hi-ogawa Mar 3, 2025

hi-ogawa commented Mar 1, 2025

janis-me commented Mar 1, 2025

hi-ogawa commented Mar 1, 2025

hi-ogawa left a comment

hi-ogawa left a comment

hi-ogawa Mar 3, 2025

hi-ogawa Mar 3, 2025

janis-me commented Mar 3, 2025

janis-me commented Mar 3, 2025 •

edited

Loading

hi-ogawa left a comment

Uh oh!

janis-me commented Mar 5, 2025

pkg-pr-new bot commented Mar 5, 2025 •

edited

Loading

hi-ogawa commented Mar 5, 2025

sheremet-va commented Mar 25, 2025

janis-me commented Mar 26, 2025

Uh oh!

Uh oh!

feat: Pass through vite configLoader option to createViteServer #7574

feat: Pass through vite configLoader option to createViteServer #7574

Uh oh!

Conversation

janis-me commented Feb 27, 2025 • edited by hi-ogawa Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

Tests

Documentation

Changesets

netlify bot commented Feb 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for vitest-dev ready!

janis-me Feb 27, 2025

Choose a reason for hiding this comment

hi-ogawa Mar 3, 2025

Choose a reason for hiding this comment

hi-ogawa commented Mar 1, 2025

janis-me commented Mar 1, 2025

hi-ogawa commented Mar 1, 2025

hi-ogawa left a comment

Choose a reason for hiding this comment

hi-ogawa left a comment

Choose a reason for hiding this comment

hi-ogawa Mar 3, 2025

Choose a reason for hiding this comment

hi-ogawa Mar 3, 2025

Choose a reason for hiding this comment

janis-me commented Mar 3, 2025

janis-me commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

hi-ogawa left a comment

Choose a reason for hiding this comment

Uh oh!

janis-me commented Mar 5, 2025

pkg-pr-new bot commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

hi-ogawa commented Mar 5, 2025

sheremet-va commented Mar 25, 2025

janis-me commented Mar 26, 2025

Uh oh!

janis-me commented Feb 27, 2025 •

edited by hi-ogawa

Loading

netlify bot commented Feb 27, 2025 •

edited

Loading

janis-me commented Mar 3, 2025 •

edited

Loading

pkg-pr-new bot commented Mar 5, 2025 •

edited

Loading