@holy-two/vite-plugin-alias

Illustration

This is a vite plugin that automatically retrieves and sets path aliases from tsconfig.json.

Usage

npm i @holy-two/vite-plugin-alias -D

In vite.config.ts:

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
+ import alias from '@holy-two/vite-plugin-alias'

export default defineConfig({
  plugins: [vue(),
+  alias(),
  ],
})

You just need to configure it like this in tsconfig.json:

{
  "extends": "../tsconfig.json",
  "compilerOptions": {
+    "paths": {
+       "~/*": [
+         "./src/*"
+       ]
+     }
  },
  "include": [
    "src/**/*.vue",
    "src/**/*.ts",
    "vite.config.ts"
  ],
}

@holy-two/vite-plugin-alias will automatically parse the paths set within the paths to define aliases. So you can use ~/components/** (same as ./src/components/**) to access files.

Compatible with TypeScript 6.0+ where compilerOptions.baseUrl is removed (treated as '.'), and compilerOptions.paths values not starting with '.' are treated as './' prefixed.