Registry / devops / vite-plugin-alias

vite-plugin-alias

library0.1.1jsnpmunverified

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.

devops

npm install vite-plugin-alias

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-ALIAS

vite-plugin-alias

devopsjavascriptv0.1.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Alias

✓ import Alias from 'vite-plugin-alias'

✗ const Alias = require('vite-plugin-alias')

The package exports a default function; ESM import is recommended. CJS require may work but is not officially supported.

ViteAliasesOptions

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

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

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

useAlias

✓ Not applicable; the plugin does not export a hook named useAlias.

✗ import { useAlias } from 'vite-plugin-alias'

This symbol does not exist; the only export is the default function and the type ViteAliasesOptions.

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() ] })

Debug

Known issues

gotchaThe 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.

affects: >=0.0.1

deprecatedOlder 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.

affects: <0.0.7

gotchaThe 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.

affects: >=0.0.1

Errors

Common errors & fixes

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

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'.

TypeError: Alias is not a function

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: [vite] Internal server error: The requested module 'vite-plugin-alias' does not provide an export named 'ViteAliasesOptions'

Trying to import the type as a runtime export.

fix

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

Upgrade

Version history

0.1.1latest on npm

Audit

Dependencies

viterequiredPeer dependency required for the plugin to function

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/elonehoo/vite-plugin-alias ↗

packagehttps://www.npmjs.com/package/vite-plugin-alias ↗