unplugin-auto-import


Auto import APIs on-demand for Vite, Webpack, Rspack, Rollup and esbuild. With TypeScript support. Powered by unplugin.

---

without

``ts
import { computed, ref } from 'vue'

const count = ref(0)
const doubled = computed(() => count.value * 2)
`

with

`ts
const count = ref(0)
const doubled = computed(() => count.value * 2)
`

---

without

`tsx
import { useState } from 'react'

export function Counter() {
const [count, setCount] = useState(0)
return


}
`

with

`tsx
export function Counter() {
const [count, setCount] = useState(0)
return


}
`

Install

`bash
npm i -D unplugin-auto-import
`

Vite

`ts
// vite.config.ts
import AutoImport from 'unplugin-auto-import/vite'

export default defineConfig({
plugins: [
AutoImport({ / options / }),
],
})
`

Example: playground/




Rollup

`ts
// rollup.config.js
import AutoImport from 'unplugin-auto-import/rollup'

export default {
plugins: [
AutoImport({ / options / }),
// other plugins
],
}
`




Rolldown

`ts
// rolldown.config.js
import AutoImport from 'unplugin-auto-import/rolldown'

export default {
plugins: [
AutoImport({ / options / }),
// other plugins
],
}
`




Webpack

`ts
// webpack.config.js
module.exports = {
/ ... /
plugins: [
require('unplugin-auto-import/webpack')({ / options / }),
],
}
`




Rspack

`ts
// rspack.config.js
module.exports = {
/ ... /
plugins: [
require('unplugin-auto-import/rspack')({ / options / }),
],
}
`




Nuxt

> You don't need this plugin for Nuxt, it's already built-in.

Quasar

`ts
// vite.config.js [Vite]
import AutoImport from 'unplugin-auto-import/vite'
import { defineConfig } from 'vite'

export default defineConfig({
plugins: [
AutoImport({ / options / })
]
})
`

`ts
// quasar.config.js
export default defineConfig(() => {
return {
build: {
vitePlugins: [
['unplugin-auto-import/vite', { / options / }],
]
},
}
})
`




esbuild

`ts
// esbuild.config.js
import { build } from 'esbuild'
import AutoImport from 'unplugin-auto-import/esbuild'

build({
/ ... /
plugins: [
AutoImport({
/ options /
}),
],
})
`




Astro

`ts
// astro.config.mjs
import AutoImport from 'unplugin-auto-import/astro'

export default defineConfig({
integrations: [
AutoImport({
/ options /
})
],
})
`




Configuration

`ts
AutoImport({
// targets to transform
include: [
/\.[tj]sx?$/, // .ts, .tsx, .js, .jsx
/\.vue$/,
/\.vue\?vue/, // .vue
/\.vue\.[tj]sx?\?vue/, // .vue (vue-loader with experimentalInlineMatchResource enabled)
/\.md$/, // .md
],

// global imports to register
imports: [
// presets
'vue',
'vue-router',
// custom
{
'@vueuse/core': [
// named imports
'useMouse', // import { useMouse } from '@vueuse/core',
// alias
['useFetch', 'useMyFetch'], // import { useFetch as useMyFetch } from '@vueuse/core',
],
'axios': [
// default imports
['default', 'axios'], // import { default as axios } from 'axios',
],
'[package-name]': [
'[import-names]',
// alias
['[from]', '[alias]'],
],
},
// example type import
{
from: 'vue-router',
imports: ['RouteLocationRaw'],
type: true,
},
],

// Array of strings of regexes that contains imports meant to be filtered out.
ignore: [
'useMouse',
'useFetch'
],

// Enable auto import by filename for default module exports under directories
defaultExportByFilename: false,

// Options for scanning directories for auto import
dirsScanOptions: {
filePatterns: ['*.ts'], // Glob patterns for matching files
fileFilter: file => file.endsWith('.ts'), // Filter files
types: true // Enable auto import the types under the directories
},

// Auto import for module exports under directories
// by default it only scan one level of modules under the directory
dirs: [
'./hooks',
'./composables', // only root modules
'./composables/**', // all nested modules
// ...

{
glob: './hooks',
types: true // enable import the types
},
{
glob: './composables',
types: false // If top level dirsScanOptions.types importing enabled, just only disable this directory
}
// ...
],

// Filepath to generate corresponding .d.ts file.
// Defaults to './auto-imports.d.ts' when typescript is installed locally.
// Set false to disable.
dts: './auto-imports.d.ts',

// The mode for generating the .d.ts file.
// 'overwrite': overwrite the whole existing .d.ts file with the new type definitions.
// 'append': only append the new type definitions to the existing .d.ts file, means the existing type definitions will be kept.
// Default to 'append'
dtsMode: 'append',

// Preserve the original file extensions in the generated .d.ts file.
// Set to true to keep the extensions for .ts and .tsx files.
// Default to false
dtsPreserveExts: false,

// Array of strings of regexes that contains imports meant to be ignored during
// the declaration file generation. You may find this useful when you need to provide
// a custom signature for a function.
ignoreDts: [
'ignoredFunction',
/^ignore_/
],

// Auto import inside Vue template
// see https://github.com/unjs/unimport/pull/15 and https://github.com/unjs/unimport/pull/72
vueTemplate: false,

// Auto import directives inside Vue template
// see https://github.com/unjs/unimport/pull/374
vueDirectives: undefined,

// Custom resolvers, compatible with unplugin-vue-components
// see https://github.com/antfu/unplugin-auto-import/pull/23/
resolvers: [
/ ... /
],

// Include auto-imported packages in Vite's optimizeDeps options
// Recommend to enable
viteOptimizeDeps: true,

// Inject the imports at the end of other imports
injectAtEnd: true,

// Generate corresponding .eslintrc-auto-import.json file.
// eslint globals Docs - https://eslint.org/docs/user-guide/configuring/language-options#specifying-globals
eslintrc: {
enabled: false, // Default false
// provide path ending with .mjs or .cjs to generate the file with the respective format
filepath: './.eslintrc-auto-import.json', // Default ./.eslintrc-auto-import.json
globalsPropValue: true, // Default true, (true | false | 'readonly' | 'readable' | 'writable' | 'writeable')
},

// Generate corresponding .biomelintrc-auto-import.json file.
// biomejs extends Docs - https://biomejs.dev/guides/how-biome-works/#the-extends-option
biomelintrc: {
enabled: false, // Default false
filepath: './.biomelintrc-auto-import.json', // Default ./.biomelintrc-auto-import.json
},

// Save unimport items into a JSON file for other tools to consume
dumpUnimportItems: './auto-imports.json', // Default false
})
`

Refer to the type definitions for more options.

Presets

See src/presets.

Package Presets

We only provide presets for the most popular packages, to use any package not included here you can install it as dev dependency and add it to the packagePresets array option:
`ts
AutoImport({
/ other options /
packagePresets: ['detect-browser-es'/ other local package names /]
})
`

You can check the Svelte example for a working example registering detect-browser-es package preset and auto importing detect function in App.svelte.

Please refer to the unimport PackagePresets jsdocs for more information about options like ignore or cache.

Note: ensure local packages used have package exports configured properly, otherwise the corresponding modules exports will not be detected.

TypeScript

In order to properly hint types for auto-imported APIs:








1. Enable options.dts so that auto-imports.d.ts file is automatically generated 2. Make sure auto-imports.d.ts is not excluded in tsconfig.json

`ts AutoImport({ dts: true // or a custom path }) `

For better navigation support when working with auto-imported APIs, consider using the @dxup/unimport package.

ESLint

> 💡 When using TypeScript, we recommend to disable no-undef rule directly as TypeScript already check for them and you don't need to worry about this.

If you have encountered ESLint error of no-undef:






1. Enable eslintrc.enabled

`ts AutoImport({ eslintrc: { enabled: true, // <-- this }, }) `

2. Update your eslintrc: Extending Configuration Files

`ts // .eslintrc.js module.exports = { extends: [ './.eslintrc-auto-import.json', ], } `

FAQ

$3

From v0.8.0, unplugin-auto-import uses unimport underneath. unimport is designed to be a lower-level tool (it also powered Nuxt's auto import). You can think unplugin-auto-import is a wrapper of it that provides more user-friendly config APIs and capabilities like resolvers. Development of new features will mostly happen in unimport from now.

$3

You can think of this plugin as a successor to vue-global-api, but offering much more flexibility and bindings with libraries other than Vue (e.g. React).

###### Pros

- Flexible and customizable
- Tree-shakable (on-demand transforming)
- No global population

###### Cons

- Relying on build tools integrations (while vue-global-api` is pure runtime) - but hey, we have supported quite a few of them already!

Sponsors

License

MIT License © 2021-PRESENT Anthony Fu