Vite Plugin Alias

0.1.1 verified Mon Apr 27 auth: no javascript

vite-plugin-alias is a Vite plugin that automatically generates aliases for your project. Version 0.1.1 is the latest stable release, with updates that add support for Vite 4 and fix build issues. It automatically maps directory structures to import aliases, reducing manual configuration. Compared to alternatives like vite-aliases, it has a similar API but is maintained by elonehoo and includes TypeScript types. The release cadence is irregular but includes bug fixes and compatibility updates.

Common errors

error Error: Cannot find module 'vite-plugin-alias' ↓

cause Package not installed or devDependencies not installed correctly.

fix

Run 'npm install --save-dev vite-plugin-alias' or 'pnpm install --save-dev vite-plugin-alias'.

error TypeError: Alias is not a function ↓

cause Improper import; using named import instead of default import.

fix

Use 'import Alias from "vite-plugin-alias"' instead of 'import { Alias } from "vite-plugin-alias"'.

error Error: [vite] Internal server error: The requested module 'vite-plugin-alias' does not provide an export named 'ViteAliasesOptions' ↓

cause Trying to import the type as a runtime export.

fix

Use 'import type { ViteAliasesOptions } from "vite-plugin-alias"' or simply rely on inference.

Warnings

gotcha The plugin may conflict with existing manual alias configuration in vite.config.ts, causing unexpected behavior. ↓

fix Remove any manual 'resolve.alias' entries if using this plugin, or customize the plugin options to avoid overlap.

deprecated Older versions (before 0.0.7) did not support Vite 4; users may experience compatibility issues. ↓

fix Upgrade to version 0.0.7 or later to add Vite 4 support.

gotcha The plugin automatically resolves aliases based on folder structure; it may incorrectly map directories that are not intended to be aliases. ↓

fix Use the 'prefix' or 'deep' options to control which directories are scanned and how aliases are named.

Install

npm install vite-plugin-alias

yarn add vite-plugin-alias

pnpm add vite-plugin-alias

Imports

Alias
wrong
```
const Alias = require('vite-plugin-alias')
```
correct
```
import Alias from 'vite-plugin-alias'
```
The package exports a default function; ESM import is recommended. CJS require may work but is not officially supported.

ViteAliasesOptions

wrong

import { ViteAliasesOptions } from 'vite-plugin-alias'

correct

import type { ViteAliasesOptions } from 'vite-plugin-alias'

Options type is exported as a named type import, not a runtime value.

useAlias
wrong
```
import { useAlias } from 'vite-plugin-alias'
```
correct
```
Not applicable; the plugin does not export a hook named useAlias.
```
This symbol does not exist; the only export is the default function and the type ViteAliasesOptions.

Quickstart

Shows how to install and configure vite-plugin-alias in a Vite project using TypeScript.

// vite.config.ts
import { defineConfig } from 'vite'
import Alias from 'vite-plugin-alias'

export default defineConfig({
  plugins: [
    Alias()
  ]
})