refactor: rename global to globals (#565)

bench/test/vue/vitest.config.ts

@@ -6,7 +6,7 @@ export default defineConfig({
     Vue(),
   ],
   test: {
-    global: true,
+    globals: true,
     isolate: false,
     environment: 'happy-dom', // jsdom fails when there are more test files
   },

docs/config/index.md

@@ -57,12 +57,12 @@ Externalize means that Vite will bypass the package to native Node. Externalized
 
 Vite will process inlined modules. This could be helpful to handle packages that ship `.js` in ESM format (that Node can't handle).
 
-### global
+### globals
 
 - **Type:** `boolean`
 - **Default:** `false`
 
-By default, `vitest` does not provide global APIs for explicitness. If you prefer to use the APIs globally like Jest, you can pass the `--global` option to CLI or add `global: true` in the config.
+By default, `vitest` does not provide global APIs for explicitness. If you prefer to use the APIs globally like Jest, you can pass the `--globals` option to CLI or add `globals: true` in the config.
 
 ```ts
 // vite.config.ts
@@ -70,18 +70,18 @@ import { defineConfig } from 'vite'
 
 export default defineConfig({
   test: {
-    global: true,
+    globals: true,
   },
 })
 ```
 
-To get TypeScript working with the global APIs, add `vitest/global` to the `types` filed in your `tsconfig.json`
+To get TypeScript working with the global APIs, add `vitest/globals` to the `types` filed in your `tsconfig.json`
 
 ```json
 // tsconfig.json
 {
   "compilerOptions": {
-    "types": ["vitest/global"]
+    "types": ["vitest/globals"]
   }
 }
 ```

examples/basic/vite.config.ts

@@ -7,6 +7,6 @@ import { defineConfig } from 'vite'
 export default defineConfig({
   test: {
     /* for example, use global to avoid globals imports (describe, test, expect): */
-    // global: true,
+    // globals: true,
   },
 })

examples/lit/vite.config.ts

@@ -5,7 +5,7 @@ import { defineConfig } from 'vite'
 // https://vitejs.dev/config/
 export default defineConfig({
   test: {
-    global: true,
+    globals: true,
     environment: 'happy-dom',
   },
 })

examples/mocks/tsconfig.json

@@ -1,5 +1,5 @@
 {
     "compilerOptions": {
-        "types": ["vitest/global"],
+        "types": ["vitest/globals"],
     }
 }

examples/mocks/vite.config.ts

@@ -5,7 +5,7 @@ import { defineConfig } from 'vite'
 // https://vitejs.dev/config/
 export default defineConfig({
   test: {
-    global: true,
+    globals: true,
     environment: 'node',
   },
 })

examples/react-mui/vite.config.ts

@@ -7,7 +7,7 @@ export default defineConfig(() => {
     },
     test: {
       environment: 'jsdom',
-      global: true,
+      globals: true,
     },
   }
 })

examples/react-storybook-testing/vite.config.ts

@@ -7,7 +7,7 @@ import react from '@vitejs/plugin-react'
 export default defineConfig({
   plugins: [react()],
   test: {
-    global: true,
+    globals: true,
     environment: 'jsdom',
     setupFiles: ['./src/setup.ts'],
   },

examples/react-testing-lib-msw/vite.config.ts

@@ -8,7 +8,7 @@ import { defineConfig } from 'vite'
 export default defineConfig({
   plugins: [react()],
   test: {
-    global: true,
+    globals: true,
     environment: 'jsdom',
     setupFiles: ['./src/setup.ts'],
   },

examples/react-testing-lib/vite.config.ts

@@ -8,7 +8,7 @@ import { defineConfig } from 'vite'
 export default defineConfig({
   plugins: [react()],
   test: {
-    global: true,
+    globals: true,
     environment: 'jsdom',
     setupFiles: './src/test/setup.ts',
   },

examples/react/vitest.config.ts

@@ -4,7 +4,7 @@ import { defineConfig } from 'vite'
 
 export default defineConfig({
   test: {
-    global: true,
+    globals: true,
     environment: 'happy-dom',
   },
 })

examples/svelte/vitest.config.ts

@@ -6,7 +6,7 @@ export default defineConfig({
     svelte({ hot: !process.env.VITEST }),
   ],
   test: {
-    global: true,
+    globals: true,
     environment: 'jsdom',
   },
 })

examples/vitesse/vite.config.ts

@@ -22,7 +22,7 @@ export default defineConfig({
     }),
   ],
   test: {
-    global: true,
+    globals: true,
     environment: 'happy-dom',
   },
 })

examples/vue-jsx/vite.config.ts

@@ -5,7 +5,7 @@ import Jsx from '@vitejs/plugin-vue-jsx'
 export default defineConfig({
   plugins: [Vue(), Jsx()],
   test: {
-    global: true,
+    globals: true,
     environment: 'happy-dom',
     transformMode: {
       web: [/.[tj]sx$/],

examples/vue/vitest.config.ts

@@ -6,7 +6,7 @@ export default defineConfig({
     Vue(),
   ],
   test: {
-    global: true,
+    globals: true,
     environment: 'happy-dom',
   },
 })

examples/vue2/vitest.config.ts

@@ -8,7 +8,7 @@ export default defineConfig({
     ScriptSetup(),
   ],
   test: {
-    global: true,
+    globals: true,
     environment: 'happy-dom',
     setupFiles: [
       'vitest.setup.ts',

packages/vitest/package.json

@@ -27,7 +27,10 @@
     },
     "./*": "./*",
     "./global": {
-      "types": "./global.d.ts"
+      "types": "./globals.d.ts"
+    },
+    "./globals": {
+      "types": "./globals.d.ts"
     },
     "./node": {
       "import": "./dist/node.js",

packages/vitest/src/node/cli.ts

@@ -24,7 +24,8 @@ cli
   .option('--outputFile <filename>', 'write test results to a file when the --reporter=json option is also specified')
   .option('--coverage', 'use c8 for coverage')
   .option('--run', 'do not watch')
-  .option('--global', 'inject apis globally')
+  .option('--globals', 'inject apis globally')
+  .option('--global', 'deprecated, use --globals')
   .option('--dom', 'mock browser api with happy-dom')
   .option('--environment <env>', 'runner environment', { default: 'node' })
   .option('--passWithNoTests', 'pass when no tests found')

packages/vitest/src/node/config.ts

@@ -53,9 +53,13 @@ export function resolveConfig(
   if (options.dom)
     options.environment = 'happy-dom'
 
+  const globals = options?.global ?? options.globals
+
   const resolved = {
     ...deepMerge(options, viteConfig.test || {}),
     root: viteConfig.root,
+    globals,
+    global: globals,
   } as ResolvedConfig
 
   if (viteConfig.base !== '/')

packages/vitest/src/runtime/setup.ts

@@ -16,8 +16,8 @@ export async function setupGlobalEnv(config: ResolvedConfig) {
   setupConsoleLogSpy()
   await setupChai()
 
-  if (config.global)
-    (await import('../integrations/global')).registerApiGlobally()
+  if (config.globals)
+    (await import('../integrations/globals')).registerApiGlobally()
 }
 
 export function setupConsoleLogSpy() {

packages/vitest/src/types/config.ts

@@ -72,9 +72,14 @@ export interface InlineConfig {
   }
 
   /**
-   * Register apis globally
-   *
-   * @default false
+  * Register apis globally
+  *
+  * @default false
+  */
+  globals?: boolean
+
+  /**
+   * @deprecated
    */
   global?: boolean
 

test/global-setup/vitest.config.ts

@@ -4,7 +4,7 @@ import { defineConfig } from 'vite'
 
 export default defineConfig({
   test: {
-    global: true,
+    globals: true,
     globalSetup: [
       './setupFiles/default-export.js',
       './setupFiles/named-exports.js',

test/snapshots/vitest.config.ts

@@ -2,7 +2,7 @@ import { defineConfig } from 'vite'
 
 export default defineConfig({
   test: {
-    global: true,
+    globals: true,
     snapshotFormat: {
       printBasicPrototype: true,
     },

tsconfig.json

@@ -20,6 +20,7 @@
       "~/*": ["./packages/ui/client/*"],
       "vitest": ["./packages/vitest/src/index.ts"],
       "vitest/global": ["./packages/vitest/global.d.ts"],
+      "vitest/globals": ["./packages/vitest/globals.d.ts"],
       "vitest/node": ["./packages/vitest/src/node/index.ts"],
       "vite-node": ["./packages/vite-node/src/index.ts"],
       "vite-node/client": ["./packages/vite-node/src/client.ts"],