automatically generate alias based on path
MIT License
English | 简体中文
automatically generate alias based on path
pnpm add vite-plugin-auto-alias -D
yarn add vite-plugin-auto-alias -D
npm install vite-plugin-auto-alias -D
vite.config.ts / vite.config.js
import autoAlias from 'vite-plugin-auto-alias';
export default defineConfig(({ command, mode }) => {
return {
plugins: [autoAlias()]
};
});
export interface AutoAlias {
/**
* @description the root directory where the alias needs to be generated is src by default
* @default src
*/
root?: string;
/**
* @description prefix for generating aliases
* @default @
*/
prefix?: string;
/**
* @description synchronize the mode of json configuration
* @default all
*/
mode?: 'sync' | 'off';
/**
* @description alias configuration file path
* @default tsconfig.json
*/
aliasPath?: string;
}
sync
,the plugin will search for tsconfig.json
or jsconfig.json
in the root directory of the current project, so please ensure that this file exists in the project. The plugin will automatically generate paths options when running, and then write them to the file without the need for developers to manually add themvite.config.ts / vite.config.js
import autoAlias from 'vite-plugin-auto-alias';
export default defineConfig(({ command, mode }) => {
return {
plugins: [
autoAlias({
// ...
mode: 'sync'
})
]
};
});
tsconfig.json / jsconfig.json
{
"compilerOptions": {
"baseUrl": "./"
// ...
}
}
|-- src
|-- plugins
|-- router
|-- scss
|-- store
|-- utils
|-- views
|-- ....
import xxx from '@plugins/xxx';
import xxx from '@router/xxx';
import xxx from '@scss/xxx';
import xxx from '@store/xxx';
import xxx from '@utils/xxx';
import xxx from '@views/xxx';