From bade471dcfd13772847440a8aa1d50e3f174bad2 Mon Sep 17 00:00:00 2001 From: Anthony Fu Date: Mon, 11 Oct 2021 16:07:27 +0800 Subject: [PATCH] refactor: rename `global-imports` to `auto-imports` (#706) --- examples/with-components/nuxt.d.ts | 2 +- .../src/{global-imports.ts => auto-imports.ts} | 12 ++++++------ packages/bridge/src/module.ts | 8 ++++---- packages/bridge/types.d.ts | 2 +- .../identifiers.ts | 0 .../{global-imports => auto-imports}/module.ts | 16 ++++++++-------- .../transform.ts | 2 +- .../{global-imports => auto-imports}/types.ts | 2 +- packages/nuxt3/src/core/nuxt.ts | 4 ++-- ...obal-imports.test.ts => auto-imports.test.ts} | 4 ++-- playground/nuxt.d.ts | 2 +- 11 files changed, 27 insertions(+), 27 deletions(-) rename packages/bridge/src/{global-imports.ts => auto-imports.ts} (74%) rename packages/nuxt3/src/{global-imports => auto-imports}/identifiers.ts (100%) rename packages/nuxt3/src/{global-imports => auto-imports}/module.ts (84%) rename packages/nuxt3/src/{global-imports => auto-imports}/transform.ts (98%) rename packages/nuxt3/src/{global-imports => auto-imports}/types.ts (79%) rename packages/nuxt3/test/{global-imports.test.ts => auto-imports.test.ts} (87%) diff --git a/examples/with-components/nuxt.d.ts b/examples/with-components/nuxt.d.ts index 7f195695f24..aa1c5d21124 100644 --- a/examples/with-components/nuxt.d.ts +++ b/examples/with-components/nuxt.d.ts @@ -5,5 +5,5 @@ /// /// /// -/// +/// export {} diff --git a/packages/bridge/src/global-imports.ts b/packages/bridge/src/auto-imports.ts similarity index 74% rename from packages/bridge/src/global-imports.ts rename to packages/bridge/src/auto-imports.ts index 68a1100e013..3e8aed6c75b 100644 --- a/packages/bridge/src/global-imports.ts +++ b/packages/bridge/src/auto-imports.ts @@ -1,5 +1,5 @@ import { installModule, useNuxt } from '@nuxt/kit' -import globalImports from '../../nuxt3/src/global-imports/module' +import autoImports from '../../nuxt3/src/auto-imports/module' // TODO: implement these: https://github.com/nuxt/framework/issues/549 const disabled = [ @@ -71,10 +71,10 @@ for (const pkg in identifiers) { } } -export async function setupGlobalImports () { +export async function setupAutoImports () { const nuxt = useNuxt() - nuxt.options.globalImports = nuxt.options.globalImports || {} - nuxt.options.globalImports.disabled = nuxt.options.globalImports.disabled || disabled - nuxt.options.globalImports.identifiers = Object.assign({}, defaultIdentifiers, nuxt.options.globalImports.identifiers) - await installModule(nuxt, globalImports) + nuxt.options.autoImports = nuxt.options.autoImports || {} + nuxt.options.autoImports.disabled = nuxt.options.autoImports.disabled || disabled + nuxt.options.autoImports.identifiers = Object.assign({}, defaultIdentifiers, nuxt.options.autoImports.identifiers) + await installModule(nuxt, autoImports) } diff --git a/packages/bridge/src/module.ts b/packages/bridge/src/module.ts index ce7d5f00a1f..8b58ed68d36 100644 --- a/packages/bridge/src/module.ts +++ b/packages/bridge/src/module.ts @@ -5,7 +5,7 @@ import { setupNitroBridge } from './nitro' import { setupAppBridge } from './app' import { setupCAPIBridge } from './capi' import { setupBetterResolve } from './resolve' -import { setupGlobalImports } from './global-imports' +import { setupAutoImports } from './auto-imports' import { setupTypescript } from './typescript' import { setupMeta } from './meta' import { setupTranspile } from './transpile' @@ -21,7 +21,7 @@ export default defineNuxtModule({ capi: {}, transpile: true, scriptSetup: true, - globalImports: true, + autoImports: true, constraints: true, meta: null, // TODO: Remove from 2.16 @@ -47,8 +47,8 @@ export default defineNuxtModule({ if (opts.scriptSetup) { await setupScriptSetup() } - if (opts.globalImports) { - await setupGlobalImports() + if (opts.autoImports) { + await setupAutoImports() } if (opts.vite) { await installModule(nuxt, _require.resolve('nuxt-vite')) diff --git a/packages/bridge/types.d.ts b/packages/bridge/types.d.ts index f36d009cca6..001882833c6 100644 --- a/packages/bridge/types.d.ts +++ b/packages/bridge/types.d.ts @@ -7,7 +7,7 @@ export interface BridgeConfig { app: boolean | {} capi: boolean | {} scriptSetup: boolean - globalImports: boolean + autoImports: boolean transpile: boolean constraints: boolean postcss8: boolean diff --git a/packages/nuxt3/src/global-imports/identifiers.ts b/packages/nuxt3/src/auto-imports/identifiers.ts similarity index 100% rename from packages/nuxt3/src/global-imports/identifiers.ts rename to packages/nuxt3/src/auto-imports/identifiers.ts diff --git a/packages/nuxt3/src/global-imports/module.ts b/packages/nuxt3/src/auto-imports/module.ts similarity index 84% rename from packages/nuxt3/src/global-imports/module.ts rename to packages/nuxt3/src/auto-imports/module.ts index 3f916aa3762..da0eac37cfb 100644 --- a/packages/nuxt3/src/global-imports/module.ts +++ b/packages/nuxt3/src/auto-imports/module.ts @@ -1,12 +1,12 @@ import { addVitePlugin, addWebpackPlugin, defineNuxtModule, addTemplate, resolveAlias, addPluginTemplate } from '@nuxt/kit' import { isAbsolute, relative, resolve } from 'pathe' -import type { Identifiers, GlobalImportsOptions } from './types' +import type { Identifiers, AutoImportsOptions } from './types' import { TransformPlugin } from './transform' import { defaultIdentifiers } from './identifiers' -export default defineNuxtModule({ - name: 'global-imports', - configKey: 'globalImports', +export default defineNuxtModule({ + name: 'auto-imports', + configKey: 'autoImports', defaults: { identifiers: defaultIdentifiers }, setup ({ disabled = [], identifiers }, nuxt) { for (const key of disabled) { @@ -15,7 +15,7 @@ export default defineNuxtModule({ if (nuxt.options.dev) { // Add all imports to globalThis in development mode addPluginTemplate({ - filename: 'global-imports.mjs', + filename: 'auto-imports.mjs', src: '', getContents: () => { const imports = toImports(Object.entries(identifiers)) @@ -44,15 +44,15 @@ export default defineNuxtModule({ } addTemplate({ - filename: 'global-imports.d.ts', + filename: 'auto-imports.d.ts', write: true, - getContents: () => `// Generated by global imports + getContents: () => `// Generated by auto imports declare global { ${Object.entries(identifiers).map(([api, moduleName]) => ` const ${api}: typeof import('${r(moduleName)}')['${api}']`).join('\n')} }\nexport {}` }) nuxt.hook('prepare:types', ({ references }) => { - references.push({ path: resolve(nuxt.options.buildDir, 'global-imports.d.ts') }) + references.push({ path: resolve(nuxt.options.buildDir, 'auto-imports.d.ts') }) }) } }) diff --git a/packages/nuxt3/src/global-imports/transform.ts b/packages/nuxt3/src/auto-imports/transform.ts similarity index 98% rename from packages/nuxt3/src/global-imports/transform.ts rename to packages/nuxt3/src/auto-imports/transform.ts index d9e0ca74172..46925e18435 100644 --- a/packages/nuxt3/src/global-imports/transform.ts +++ b/packages/nuxt3/src/auto-imports/transform.ts @@ -24,7 +24,7 @@ export const TransformPlugin = createUnplugin((map: IdentifierMap) => { const matchRE = new RegExp(`\\b(${Object.keys(map).join('|')})\\b`, 'g') return { - name: 'nuxt-global-imports-transform', + name: 'nuxt-auto-imports-transform', enforce: 'post', transformInclude (id) { const { pathname, search } = parseURL(id) diff --git a/packages/nuxt3/src/global-imports/types.ts b/packages/nuxt3/src/auto-imports/types.ts similarity index 79% rename from packages/nuxt3/src/global-imports/types.ts rename to packages/nuxt3/src/auto-imports/types.ts index 4b4138edfcd..9e0ee41c184 100644 --- a/packages/nuxt3/src/global-imports/types.ts +++ b/packages/nuxt3/src/auto-imports/types.ts @@ -1,7 +1,7 @@ export type IdentifierMap = Record export type Identifiers = [string, string][] -export interface GlobalImportsOptions { +export interface AutoImportsOptions { identifiers?: IdentifierMap disabled?: string[] } diff --git a/packages/nuxt3/src/core/nuxt.ts b/packages/nuxt3/src/core/nuxt.ts index 6cdbb3a1f81..95500fc1626 100644 --- a/packages/nuxt3/src/core/nuxt.ts +++ b/packages/nuxt3/src/core/nuxt.ts @@ -4,7 +4,7 @@ import { loadNuxtConfig, LoadNuxtOptions, Nuxt, NuxtOptions, NuxtConfig, nuxtCtx import pagesModule from '../pages/module' import metaModule from '../meta/module' import componentsModule from '../components/module' -import globalImportsModule from '../global-imports/module' +import autoImportsModule from '../auto-imports/module' import { distDir, pkgDir } from '../dirs' import { version } from '../../package.json' import { initNitro } from './nitro' @@ -69,7 +69,7 @@ export async function loadNuxt (opts: LoadNuxtOptions): Promise { // Temp options.appDir = options.alias['#app'] = resolve(distDir, 'app') options._majorVersion = 3 - options.buildModules.push(pagesModule, metaModule, componentsModule, globalImportsModule) + options.buildModules.push(pagesModule, metaModule, componentsModule, autoImportsModule) options.modulesDir.push(resolve(pkgDir, 'node_modules')) const nuxt = createNuxt(options) diff --git a/packages/nuxt3/test/global-imports.test.ts b/packages/nuxt3/test/auto-imports.test.ts similarity index 87% rename from packages/nuxt3/test/global-imports.test.ts rename to packages/nuxt3/test/auto-imports.test.ts index 04058e089ce..3e8c248cf15 100644 --- a/packages/nuxt3/test/global-imports.test.ts +++ b/packages/nuxt3/test/auto-imports.test.ts @@ -1,7 +1,7 @@ import { expect } from 'chai' -import { TransformPlugin } from '../src/global-imports/transform' +import { TransformPlugin } from '../src/auto-imports/transform' -describe('module:global-imports:build', () => { +describe('module:auto-imports:build', () => { const { transform: _transform } = TransformPlugin.raw({ ref: 'vue', computed: 'bar' }, {} as any) const transform = (code: string) => _transform.call({} as any, code, '') diff --git a/playground/nuxt.d.ts b/playground/nuxt.d.ts index c6ef6c86ba7..a4e90216c20 100644 --- a/playground/nuxt.d.ts +++ b/playground/nuxt.d.ts @@ -3,5 +3,5 @@ /// /// -/// +/// export {}