Vite配置路径别名的简单实现方法

 更新时间:2023年04月04日 09:51:40   作者:ぃ Gavin  
Vite项目中我们可以手动将src路径设置**@**路径别名,可以省下很多引入路径的冗余路径,下面这篇文章主要给大家介绍了关于Vite配置路径别名的简单实现方法,需要的朋友可以参考下

1. 项目说明

主技术栈:

Vite + Vue3 + TypeScript

项目中版本情况:

"Vite": "3.0.0"
"Vue":	"3.2.37"
"Ts":	"4.6.4"

出现问题:

在配置完Vite后,正常开发没问题,但是Ts类型检查报错:

找不到模块"/xxx/xxx/xxx"或其相应的类型声明

2. 解决方法

首先要配置Vite,根据官方文档中的给出的类型说明:

Record<string, string> | Array<{ find: string | RegExp, replacement: string }>

由此可知:我们可以配置alias为一个对象,或一个 { find, replacement } 的数组

具体配置:

在根目录中的 vite.config.ts 中加入如下配置:(以下是我个人项目配置)

import { resolve } from "path"; // 导入 path 模块,帮助我们解析路径

export default defineConfig({
  resolve: { // 这里配置需要注意:Vite新版本resolve配置改为对象形式,如下:
    alias: [
      {
        find: '@',
        replacement: resolve(__dirname, "src"),
      },
      {
        find: 'comps',
        replacement: resolve(__dirname, "src/components"),
      },
      {
        find: 'apis',
        replacement: resolve(__dirname, "src/apis"),
      },
      {
        find: 'views',
        replacement: resolve(__dirname, "src/views"),
      },
      {
        find: 'routes',
        replacement: resolve(__dirname, "src/router"),
      },
      {
        find: 'store',
        replacement: resolve(__dirname, "src/store"),
      },
      {
        find: 'utils',
        replacement: resolve(__dirname, "src/utils"),
      },
      {
        find: 'styles',
        replacement: resolve(__dirname, "src/styles"),
      },
      {
        find: 'layout',
        replacement: resolve(__dirname, "src/Layout"),
      },
      {
        find: 'models',
        replacement: resolve(__dirname, "src/models"),
      },
      {
        find: 'hooks',
        replacement: resolve(__dirname, 'src/hooks')
      }
    ],
  }
})

这样配置完成后,项目中可以正常使用,但是Ts类型检查会提示错误,接着,配置根目录下的 ts.config.json 文件:(这里还是我个人的配置,分别对应Vite中配置好的别名)

注意:主要配置 baseUrlpaths 两个配置项即可,其他选项是初始化项目自动生成的

{
  "compilerOptions": {
    "target": "ESNext",
    "useDefineForClassFields": true,
    "module": "ESNext",
    "moduleResolution": "Node",
    "strict": true,
    "jsx": "preserve",
    "sourceMap": true,
    "resolveJsonModule": true,
    "isolatedModules": true,
    "esModuleInterop": true,
    "lib": ["ESNext", "DOM"],
    "skipLibCheck": true,
    "baseUrl": "./",
    "paths": {
      "@/*":["src/*"],
      "comps/*": ["src/components/*"],
      "apis/*": ["src/apis/*"],
      "views/*": ["src/views/*"],
      "routes/*": ["src/router/*"],
      "store/*": ["src/store/*"],
      "utils/*": ["src/utils/*"],
      "styles/*": ["src/styles/*"],
      "layout/*": ["src/Layout/*"],
      "models/*": ["src/models/*"],
      "hooks/*": ["src/hooks/*"]
    }
  },
  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
  "references": [{ "path": "./tsconfig.node.json" }]
}

配置完成后,Ts类型检查就不会报错了。(反应慢的重启一下VsCode)

总结

到此这篇关于Vite配置路径别名的简单实现方法的文章就介绍到这了,更多相关Vite配置路径别名内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • vue render函数动态加载img的src路径操作

    vue render函数动态加载img的src路径操作

    这篇文章主要介绍了vue render函数动态加载img的src路径操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • vue3 父控件远程获取数据在子组件上显示不出来的解决方案

    vue3 父控件远程获取数据在子组件上显示不出来的解决方案

    这篇文章主要介绍了vue3 父控件远程获取数据,在子组件上显示不出来,本文给大家分享两种解决方案帮助大家解决这个问题,需要的朋友可以参考下
    2023-08-08
  • 基于vue2实现上拉加载功能

    基于vue2实现上拉加载功能

    这篇文章主要为大家详细介绍了基于vue2实现上拉加载功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • Vue封装数字框组件实现流程详解

    Vue封装数字框组件实现流程详解

    这篇文章主要介绍了Vue封装数字框组件实现流程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2023-04-04
  • Vue页面渲染中key的应用实例教程

    Vue页面渲染中key的应用实例教程

    这篇文章主要给大家介绍了关于Vue页面渲染中key的应用的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • vue篇之事件总线EventBus使用示例详解

    vue篇之事件总线EventBus使用示例详解

    这篇文章主要为大家介绍了vue篇之事件总线EventBus使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-09-09
  • 示例vue 的keep-alive缓存功能的实现

    示例vue 的keep-alive缓存功能的实现

    这篇文章主要介绍了示例vue 的keep-alive缓存功能的实现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • 面试题:react和vue的区别分析

    面试题:react和vue的区别分析

    这篇文章主要介绍了react和vue的区别分析,在面试中经常会遇到,小编通过实例文字相结合的形式给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-04-04
  • Vue Hook 封装通用型表格的详细过程

    Vue Hook 封装通用型表格的详细过程

    这篇文章主要介绍了Vue Hook 封装通用型表格,设计通用型表格组件首先,需要设计一个基础的表格组件,它接受列配置、数据和分页信息等参数,本文给大家介绍的非常详细,需要的朋友可以参考下
    2024-08-08
  • 更强大的vue ssr实现预取数据的方式

    更强大的vue ssr实现预取数据的方式

    这篇文章主要介绍了更强大的 vue ssr 预取数据的方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-07-07

最新评论