feat!: rename defineConfigWithNuxt to defineVitestConfig

README.md

@@ -38,9 +38,9 @@ export default defineNuxtConfig({
 3. Then create a `vitest.config.mjs` with the following content:
 
 ```js
-import { defineConfigWithNuxt } from 'nuxt-vitest/config'
+import { defineVitestConfig } from 'nuxt-vitest/config'
 
-export default defineConfigWithNuxt({
+export default defineVitestConfig({
   // any custom vitest config you require
 })
 ```
@@ -55,22 +55,22 @@ Or you can add `@vitest-environment nuxt` in your test file as a comment to opt-
 
 ```js
 // @vitest-environment nuxt
-import { test } from 'nuxt-vitest'
+import { test } from 'vitest'
 
 test('my test', () => {
   // ... test with Nuxt environment!
 })
 ```
 
-Finally, you can set `envoironment: 'nuxt'`, to enable Nuxt environment for **all tests**.
+Finally, you can set `environment: 'nuxt'`, to enable Nuxt environment for **all tests**.
 
 ```js
 // vitest.config.ts
-import { defineConfigWithNuxt } from 'nuxt-vitest'
+import { defineVitestConfig } from 'nuxt-vitest/config'
 
-export default defineConfigWithNuxt({
+export default defineVitestConfig({
   test: {
-    envoironment: 'nuxt'
+    environment: 'nuxt'
   }
 })
 ```

packages/nuxt-vitest/src/config.ts

@@ -8,7 +8,7 @@ interface GetVitestConfigOptions {
 }
 
 // https://github.com/nuxt/framework/issues/6496
-async function getNuxtAndViteConfig(rootDir = process.cwd()) {
+async function startNuxtAndGetViteConfig(rootDir = process.cwd()) {
   const { loadNuxt, buildNuxt } = await import('@nuxt/kit')
   const nuxt = await loadNuxt({
     cwd: rootDir,
@@ -46,10 +46,10 @@ async function getNuxtAndViteConfig(rootDir = process.cwd()) {
   return promise
 }
 
-export async function getVitestConfig(
+export async function getVitestConfigFromNuxt(
   options?: GetVitestConfigOptions
 ): Promise<InlineConfig & { test: VitestConfig }> {
-  if (!options) options = await getNuxtAndViteConfig()
+  if (!options) options = await startNuxtAndGetViteConfig()
 
   return {
     ...options.viteConfig,
@@ -88,10 +88,10 @@ export async function getVitestConfig(
   }
 }
 
-export function defineConfigWithNuxt(config: InlineConfig = {}) {
+export function defineVitestConfig(config: InlineConfig = {}) {
   return defineConfig(async () => {
-    // When Nuxt module calls `startVitest`, we don't need to call `getVitestConfig` again
+    // When Nuxt module calls `startVitest`, we don't need to call `getVitestConfigFromNuxt` again
     if (process.env.__NUXT_VITEST_RESOLVED__) return config
-    return mergeConfig(await getVitestConfig(), config)
+    return mergeConfig(await getVitestConfigFromNuxt(), config)
   })
 }

packages/nuxt-vitest/src/index.ts

@@ -1,2 +1,2 @@
-export { defineConfigWithNuxt as defineConfigWithNuxtEnv } from './config'
+export { defineVitestConfig } from './config'
 export { default } from './module'

packages/nuxt-vitest/src/module.ts

@@ -1,7 +1,7 @@
 import { defineNuxtModule, installModule, logger, resolvePath } from '@nuxt/kit'
 import type { UserConfig as VitestConfig } from 'vitest'
 import { mergeConfig, InlineConfig as ViteConfig } from 'vite'
-import { getVitestConfig } from './config'
+import { getVitestConfigFromNuxt } from './config'
 import { getPort } from 'get-port-please'
 
 export interface NuxtVitestOptions {
@@ -49,7 +49,7 @@ export default defineNuxtModule<NuxtVitestOptions>({
       const rawViteConfig = mergeConfig({}, await rawViteConfigPromise)
 
       const viteConfig = mergeConfig(
-        await getVitestConfig({ nuxt, viteConfig: rawViteConfig }),
+        await getVitestConfigFromNuxt({ nuxt, viteConfig: rawViteConfig }),
         <ViteConfig>{
           server: {
             middlewareMode: false,

playground/vitest.config.ts

@@ -1,6 +1,6 @@
-import { defineConfigWithNuxt } from 'nuxt-vitest/config'
+import { defineVitestConfig } from 'nuxt-vitest/config'
 
-export default defineConfigWithNuxt({
+export default defineVitestConfig({
   test: {
     dir: 'tests',
     coverage: {