TypeScript 中 Vite 怎么配置模块解析的扩展名白名单

轻辰君_1280

轻辰君_1280

2026-07-28

814人浏览

原创

typescript 项目中 vite 模块解析需两端协同配置:vite 的 resolve.extensions 控制运行时导入查找顺序,ts 的 tsconfig.json 需配置 include、baseurl/paths 和类型声明(如 vite-env.d.ts)以支持 .vue/.json 等扩展名的类型检查与路径别名解析。

typescript 中 vite 怎么配置模块解析的扩展名白名单

在 TypeScript 项目中使用 Vite 时,模块解析的扩展名白名单需要**两端协同配置**:Vite 负责运行时模块解析(开发和构建阶段),TypeScript 负责编译期类型检查和路径补全。只配一端会导致编辑器报错或导入失败。

1. Vite 配置 extensions(运行时解析)

Vite 的 resolve.extensions 决定它在 import 时尝试哪些后缀来查找文件。默认不包含 .vue,所以必须显式添加:

  • 在 vite.config.ts 或 vite.config.js 的 resolve 选项中设置:
示例:
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [vue()],
  resolve: {
    extensions: ['.mjs', '.js', '.ts', '.jsx', '.tsx', '.json', '.vue']
  }
})
  • 顺序很重要:Vite 按数组顺序依次尝试扩展名,建议把最常用、最明确的放前面(如 .ts 在 .js 前)
  • 若用 Vue 单文件组件,.vue 必须加入,否则 import Comp from '@/components/Hello' 会找不到文件

2. TypeScript 配置 typescript → tsconfig.json(编译期识别)

TypeScript 编译器本身不依赖 extensions,但它需要知道哪些文件属于项目范围,并能正确解析路径别名(如 @/)。关键配置在 tsconfig.json:

Add Typescript Best Practices
Add Typescript Best Practices

在 CLAUDE.md 中配置 TypeScript 最佳实践和代码风格规则

下载
  • "include" 或 "files" 确保 .vue 文件被纳入类型检查(Vue 项目需含 "src/**/*.d.ts" 和 "src/**/*.vue")
  • 启用 "resolveJsonModule": true 才能 import JSON;启用 "allowJs": true 才能 import JS(按需开启)
  • 若使用路径别名(如 @/),必须同步配置 "baseUrl" 和 "paths",否则 TS 报“无法找到模块”
示例(tsconfig.json 片段):
{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"]
    },
    "resolveJsonModule": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.vue"]
}

3. Vue 项目额外注意:声明 .vue 类型

TypeScript 默认不认识 .vue 文件,需通过类型声明告诉它:

  • 确保项目中有 src/vite-env.d.ts(Vite CLI 初始化自动生成),内容应包含:
/// <reference types="vite/client"></reference>
  • 该声明会自动引入 vite/client.d.ts,其中定义了 *.vue 的模块类型,使 import xxx from './xxx.vue' 可被 TS 正确识别
  • 若缺失此声明,即使 Vite 能加载 .vue,TS 编辑器仍会标红并提示“找不到模块”

4. 验证是否生效

配置完成后,测试以下几种导入方式是否无报错且可跳转:

  • import { foo } from '@/utils/index'(省略 .ts)
  • import Comp from '@/components/Hello'(省略 .vue)
  • import data from '@/assets/config.json'(省略 .json,需 resolveJsonModule: true)

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

typescript vite js javascript

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4626

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1149

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4544

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

920

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1816

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3305

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4293

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2800

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.7万人学习