{"id":22537,"library":"vite-aliases","title":"vite-aliases","description":"Vite plugin for automatic alias generation based on folder structure. Current stable version is 0.11.8, requiring Vite 6.x (peer dependency). Release cadence is irregular with minor patches. Key differentiator: eliminates manual alias configuration by scanning src directory and creating aliases like @components, @utils automatically. Supports TypeScript, configurable depth, prefix, and duplicate handling. v0.11+ changed default prefix from @ to ~ and replaced useTypescript option with auto-detection. ESM-only; no CommonJS support.","status":"active","version":"0.11.8","language":"javascript","source_language":"en","source_url":"https://github.com/subwaytime/vite-aliases","tags":["javascript","vite","vue","alias","aliases","auto","generation","typescript"],"install":[{"cmd":"npm install vite-aliases","lang":"bash","label":"npm"},{"cmd":"yarn add vite-aliases","lang":"bash","label":"yarn"},{"cmd":"pnpm add vite-aliases","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency - plugin requires Vite 6.x","package":"vite","optional":false}],"imports":[{"note":"Package is ESM-only, require() will fail. Default export is not available.","wrong":"const ViteAliases = require('vite-aliases')","symbol":"ViteAliases","correct":"import { ViteAliases } from 'vite-aliases'"},{"note":"No default export; must use named import.","wrong":"import ViteAliases from 'vite-aliases'","symbol":"ViteAliases (default import attempt)","correct":"import { ViteAliases } from 'vite-aliases'"},{"note":"ViteAliases is a function that returns a plugin object, not a class.","wrong":"new ViteAliases()","symbol":"Plugin invocation","correct":"ViteAliases({ prefix: '@' })"}],"quickstart":{"code":"// vite.config.js\nimport { ViteAliases } from 'vite-aliases'\n\nexport default {\n  plugins: [\n    ViteAliases({\n      dir: 'src',\n      prefix: '~',\n      deep: true,\n      depth: 1,\n      createLog: false,\n      adjustDuplicates: false,\n      useAbsolute: false,\n      useIndexes: false,\n      useConfig: true,\n      dts: false,\n      silent: false,\n      root: process.cwd()\n    })\n  ]\n}","lang":"typescript","description":"Shows a complete ViteAliases plugin configuration with all available options."},"warnings":[{"fix":"Explicitly set prefix: '@' in options to preserve old behavior.","message":"Default prefix changed from '@' to '~' in v0.11.1. Existing projects relying on '@' prefix will break.","severity":"breaking","affected_versions":">=0.11.1"},{"fix":"Use 'dts: true' or rely on auto-detection.","message":"Option 'useTypescript' was removed in v0.11.0; renamed to 'dts' with auto-detection. Using 'useTypescript' has no effect.","severity":"deprecated","affected_versions":">=0.11.0"},{"fix":"Add \"type\": \"module\" to package.json or use .mjs extension for config file.","message":"ESM-only since v0.10.0. The package no longer supports CommonJS require().","severity":"breaking","affected_versions":">=0.10.0"},{"fix":"Set adjustDuplicates: true to automatically generate camelCased aliases.","message":"Duplicate folder names cause an error unless 'adjustDuplicates' is enabled.","severity":"gotcha","affected_versions":"all"},{"fix":"Avoid relying on logfile output; monitor terminal output instead.","message":"Logfile generation via 'createLog' and 'logPath' may be phased out in future releases; recommended to use Vite's built-in logging.","severity":"deprecated","affected_versions":">=0.11.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Change to: import { ViteAliases } from 'vite-aliases'","cause":"Using default import instead of named import.","error":"TypeError: vite_aliases_1.ViteAliases is not a function"},{"fix":"Install with 'npm install vite-aliases -D' and ensure package.json has \"type\": \"module\"","cause":"Missing installation or ESM configuration incorrect.","error":"Error: Cannot find module 'vite-aliases'"},{"fix":"Upgrade Vite to version 6.x, or downgrade vite-aliases to an older version.","cause":"Peer dependency requires Vite 6.x. Using older Vite versions fails.","error":"The 'ViteAliases' plugin is not compatible with Vite 5."}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}