antfu/unplugin-auto-import
Unplugin Auto Import
unplugin-auto-import is a build-time import automation plugin and AST-based code transformer. It analyzes source code to identify missing identifiers and automatically injects the required import statements during the bundling process.
The project functions as a cross-bundler build plugin, providing a unified abstraction layer that ensures consistent behavior across Vite, Webpack, and Rollup. It utilizes a pattern-based module resolver to scan local directories via glob patterns and employs a TypeScript declaration generator to maintain type definition files for IDE autocompletion.
Its capability surface includes automated import management through predefined API presets and local module discovery for components and utilities. It also handles linting configuration automation by synchronizing auto-imported globals with tools like ESLint to prevent undefined variable errors during static analysis.
Features
- Automatic Import Injections - Automatically injects required import declarations into source files during the build process to eliminate manual imports.
- Build Tools and Bundlers - Integrates with various bundlers to automate dependency management and source code transformation.
- AST-Based Source Transformations - Modifies source code by replacing or adding nodes in the abstract syntax tree to resolve missing identifiers.
- Cross-Build-Tool Plugins - Provides a single plugin API that abstracts over multiple build tools like Vite, Rollup, and Webpack.
- AST-Based Source Injections - Implements automated modification of the abstract syntax tree to inject required import statements during the build process.
- Import Statement Resolution - Automates the identification and generation of import statements based on used identifiers in the source code.
- Cross-Bundler Plugin Abstractions - Provides a unified abstraction layer ensuring consistent behavior across Vite, Webpack, and Rollup.
- Syntax Tree Transformers - Parses source code into a structural tree to identify missing identifiers and inject import statements.
- Build-Time Auto-Import Resolvers - Analyzes source code to automatically inject missing import statements during the bundling process.
- Source Code Export Discovery - Scans specified local folders and glob patterns to detect and automatically import available functions and types.
- Module Discovery - Scans local directories via glob patterns to identify and register available exports for automatic inclusion.
- Glob Pattern Resolvers - Implements glob pattern resolution to scan local directories and identify modules for automatic import registration.
- Linting Configurations - Syncs auto-imported globals with linting tools to prevent false-positive undefined variable errors.
- TypeScript Declaration Generators - Automatically produces .d.ts type definition files to enable IDE autocompletion for dynamically injected global variables.
- Auto-Import Type Declarations - Generates declaration files to provide accurate type checking and editor suggestions for auto-imported functions.
- Build Optimization - Streamlines the development experience by automating dependency resolution and module injection during the build.
- Virtual Modules - Intercepts import requests to provide dynamically generated code content that does not exist as physical files.
- Linter Global Variable Definitions - Registers custom global identifiers to prevent undefined-variable warnings in static analysis tools.
- API Preset Mappings - Uses predefined configuration lists to map common library functions to their corresponding module import paths.
- Glob-Based Module Discovery - Uses glob matching to scan the local filesystem and register available exports for the project dependency graph.
- Local Plugin Discovery - Scans local filesystem paths using glob patterns to find and load local components and utilities.
- Import Presets - Maps common library functions to global imports using predefined presets or custom package configurations.
- Auto-Import Global Definitions - Generates configuration that defines auto-imported APIs as globals to prevent false-positive linting errors.
- Development Helpers - On-demand API auto-importing for cleaner code.
