在Vite+TypeScript项目中导入组件时会报找不到模块的声明文件

在使用Vite创建Vue3项目时,遇到找不到模块"@/components/***.vue"的错误。解决方法包括在src下的vite-env.d.ts文件中添加特定代码,或者如果文件不存在,则在根目录创建env.d.ts或者vite-env.d.ts文件并追加相应代码,从而完美解决此类模块导入问题。

TypeScript 复制代码
/// <reference types="vite/client" />

declare module "*.vue" {
	import type { DefineComponent } from "vue";
	// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/ban-types
	const component: DefineComponent<{}, {}, any>;
	export default component;
}
  • declare module "*.vue":

    • 这表示 TypeScript 将处理所有以 .vue 结尾的文件。
    • 这种声明告诉 TypeScript 如何处理 Vue 组件文件,确保这些文件在导入时具有适当的类型信息。
  • import type { DefineComponent } from "vue";:

    • vue 包中导入 DefineComponent 类型。这是 Vue 3 的一个类型,用于定义 Vue 组件的类型。
  • const component: DefineComponent<{}, {}, any>;:

    • 声明一个名为 component 的常量,它是一个 DefineComponent 类型。
    • DefineComponent<{}, {}, any> 表示组件的类型:
      • 第一个 {} 表示组件的 props 类型。
      • 第二个 {} 表示组件的 data 类型。
      • any 表示组件的 methodscomputed 类型。
    • 这可以适用于大多数简单的 Vue 组件,但对于更复杂的组件,可能需要更详细的类型定义。
  • export default component;:

    • 导出 component 作为默认导出。这使得 TypeScript 知道你可以从 Vue 组件文件中默认导出一个组件。

这段代码的主要作用是:

  • 类型安全:在 TypeScript 项目中,通过声明 Vue 组件模块的类型,使得在导入 Vue 组件时可以获得类型提示和类型检查。
  • 自动推断 :当你在 TypeScript 中使用 .vue 文件时,TypeScript 会自动知道这些文件是 Vue 组件,并应用适当的类型定义。
相关推荐
怒放的生命19912 小时前
pnpm + Monorepo 使用教程(集成 Vue 3 项目)
前端·vue.js·pnpm·monorepo·前端工程化
kkkAloha2 小时前
JS笔记汇总
开发语言·javascript·笔记
Irene19918 小时前
Vue3 TypeScript 项目中,Emits 验证的使用场景
typescript·vue3·验证
计算机毕设VX:Fegn08958 小时前
计算机毕业设计|基于springboot + vue医院设备管理系统(源码+数据库+文档)
数据库·vue.js·spring boot·后端·课程设计
北辰alk9 小时前
Vue 路由信息获取全攻略:8 种方法深度解析
vue.js
北辰alk9 小时前
Vue 三剑客:组件、插件、插槽的深度辨析
vue.js
北辰alk9 小时前
Vue Watch 立即执行:5 种初始化调用方案全解析
vue.js
北辰alk9 小时前
Vue 组件模板的 7 种定义方式:从基础到高级的完整指南
vue.js
北辰alk9 小时前
深入理解 Vue 生命周期:created 与 mounted 的核心差异与实战指南
vue.js
计算机毕设VX:Fegn08959 小时前
计算机毕业设计|基于springboot + vue小型房屋租赁系统(源码+数据库+文档)
数据库·vue.js·spring boot·后端·课程设计