关于VUE3的路径别名的配置(vite + webstorm)

文章介绍了在使用I-view的工程框架后,如何配置Vue2和Vite项目中的路径别名,以便在WebStorm编辑器中正确识别@符号。涉及的关键步骤包括在vue.config.js或vite.config.js中配置alias,修改tsconfig.json文件,以及针对WebStorm的额外设置。对于已配置好的项目,可能需要创建jsconfig.json或tsconfig.json来保持路径别名的生效。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >


在使用I-view提供的工程框架后,发现我的@路径在webstorm编辑器中无法被识别了,所以要记录下这次问题。

在项目中配置路径别名

1. 找到目标文件

如果你是vue2的项目,基于webpack进行打包构建的,那你需要在vue.config.js中进行配置,如果你是基于vite进行打包构建,那你需要找到vite.config.js文件配置

2.写入代码

先安装一下包,不安也可以继续走,如果报错了再回来下

npm i @types/node -D

引入下reslove模块

import { resolve } from 'path'

plugins同级写入以下代码

resolve: {
      alias: {
      	'@': reslove(__dirname, './src')
      },
      extensions: ['.js', '.mjs', '.vue', '.json', '.less', '.css']
    }

extensions的作用就是在你去引入文件的时候,可以忽略掉的后缀,这个视情况来写

如果你的项目使用ts语言的,那么还需要额外的配置,找到你的ts.config.json,写入下面代码

{
   "compilerOptions": {
       "target": "esnext",
       "useDefineForClassFields": true,
       "module": "esnext",
       "moduleResolution": "node",
       "strict": true,
       "jsx": "preserve",
       "sourceMap": true,
       "resolveJsonModule": true,
       "esModuleInterop": true,
       "lib": ["esnext", "dom"],
       // 路径配置
       "baseUrl": ".",
       "paths": {
           "@/*": ["src/*"]
       }
   },
   "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
   "exclude": ["node_modules"],
   "references": [{ "path": "./tsconfig.node.json" }]
}

其实配置到这里就结束了,如果你使用的vscode那么你无需其他的配置,但如果你用的是webstorm那么你会发现@符是可以使用的,但是没有路径提示出现,看下面的配置

3.针对webstorm进一步配置

首先你要进入到设置页面,ctrl + alt + s
依次找到语言和框架,JavaScript
在这里插入图片描述
配置哪个取决于你的项目构建工具,这里拿vite举例,点进去

在这里插入图片描述
按照图片,改为自动模式,同时将配置文件指向你当前项目的文件,webpack是vue.config.js, vite是vite.config.js,到这里就OK了!

4.关于脚手架的配置补充

可能有些人的项目是已经配置好后clone下来的,你会发现路径别名的配置变成了这样
在这里插入图片描述
接着会发现原本的webstorm的路径别名配置也无效了,不要慌。
这种写法其实是通过正则去匹配项目中用到了@符,将它统一替换为’.src/', 那这种情况只需要在你的项目中添加一个jsconfig.json文件, 如果你是ts的话,就是tsconfig.json,接着写入下面的代码

{
    "compilerOptions": {
        "baseUrl": ".",
        "paths": {
            "@/*": ["src/*"]
        }
    }
}

重新按照第三点的方法,将配置文件改为这个文件就ok了

### 创建 Vue 3 项目并配置 ViteWebStorm 为了在 WebStorm 中使用 Vite 创建 Vue 3 项目,可以按照以下说明操作: #### 安装依赖包 首先,在命令行工具中初始化一个新的 npm 项目,并安装必要的开发依赖项。 ```bash npm init -y npm install vite vue@next @vitejs/plugin-vue --save-dev ``` 这会设置好基础环境来支持基于 ViteVue 3 应用程序构建过程[^2]。 #### 初始化 TypeScript 支持 如果希望加入 TypeScript,则还需要额外安装 `typescript` 及其对应的 Vue 插件: ```bash npm install typescript vue-tsc --save-dev ``` 接着更新 `package.json` 文件中的脚本部分以便于后续编译和运行应用程序: ```json { "scripts": { "dev": "vite", "build": "vite build", "serve": "vite preview" } } ``` 对于 TypeScript 类型定义的支持可以通过编辑 `tsconfig.json` 来实现。确保此文件存在于项目的根目录下,并包含如下内容以适应 Vue 单文件组件 (SFC): ```json { "compilerOptions": { "target": "esnext", "module": "esnext", "strict": true, "jsx": "preserve", "importHelpers": true, "moduleResolution": "node", "skipLibCheck": true, "esModuleInterop": true, "allowSyntheticDefaultImports": true, "sourceMap": true, "baseUrl": ".", "types": [ "webpack-env" ], "paths": { "@/*": [ "src/*" ] }, "lib": [ "esnext", "dom", "dom.iterable", "scripthost" ] }, "include": [ "src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue" ], "exclude": [ "node_modules" ] } ``` #### 设置 Vite 配置 创建或修改现有的 `vite.config.ts` 文件用于自定义 Vite 行为。这里展示了一个简单的例子,其中包含了对 `.env` 文件的支持以及路径别名的处理方式: ```typescript import { defineConfig } from 'vite' import vue from '@vitejs/plugin-vue' export default defineConfig({ plugins: [vue()], resolve: { alias: { '@': '/src', }, }, }) ``` #### 添加 ESLint 和 Prettier 规则 为了让代码风格更加统一美观,建议集成静态分析工具如 ESLint 和代码格式化器 Prettier。通过调整 `eslint` 配置使得两者能够和谐共存而不互相干扰[^4]: ```json { "extends": ["prettier"], "plugins": ["prettier"], "rules": { "prettier/prettier": "error" } } ``` 同时可以在 package.json 中添加一个 script 方便执行 prettier 对整个 src 目录下的特定类型的文件进行自动格式化[^3]: ```json "scripts": { ... "format": "prettier --write \"./src/**/*.{html,vue,ts,js,json,md}\" --config ./.prettierrc.json" }, ``` 完成上述步骤之后就可以顺利地在 WebStorm 下启动新建立好的 Vite + Vue 3 工程了。记得重启 IDE 让所有的更改生效。
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值