TypeScript 中 Vite 怎么配置虚拟模块实现动态代码生成

夏伟同学_5648

夏伟同学_5648

2026-08-01

565人浏览

原创

vite可通过插件机制模拟虚拟模块,利用resolveid和load钩子拦截路径并动态生成ts代码,配合tsconfig.json的paths和include配置实现类型支持与ide识别。

typescript 中 vite 怎么配置虚拟模块实现动态代码生成

Vite 本身不直接提供“虚拟模块”概念,但可通过插件机制(尤其是 resolveId + load 钩子)模拟虚拟模块行为,配合 TypeScript 实现动态代码生成。关键在于:让 Vite 在请求某个路径时,不读取真实文件,而是由插件动态生成 TS 代码并返回,再交由 TypeScript 编译器处理。

以下为可落地的配置方式,适用于 Vue/React/Solid 等主流框架项目:

✅ 虚拟模块的核心实现逻辑

Vite 插件通过拦截模块请求路径(如 virtual:config),在 resolveId 中识别虚拟前缀,在 load 中返回生成的 TypeScript 字符串。TS 类型检查仍依赖 tsconfig.json 的 include 和 paths 配置,确保 IDE 和 tsc --noEmit 能识别该模块。

// vite.config.ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import { createRequire } from 'module'
const require = createRequire(import.meta.url)

export default defineConfig({
  plugins: [
    {
      name: 'vite-plugin-virtual-module',
      resolveId(id) {
        if (id.startsWith('virtual:')) {
          return id // 告诉 Vite 这是个需拦截的虚拟路径
        }
      },
      load(id) {
        if (id === 'virtual:api-config') {
          // 动态生成 TS 模块内容(例如从环境变量或 JSON 文件推导)
          const config = {
            baseUrl: process.env.API_BASE_URL || 'https://api.example.com',
            timeout: 10000,
          }
          return `
            export const API_CONFIG = ${JSON.stringify(config, null, 2)} as const;
            export type ApiConfig = typeof API_CONFIG;
          `
        }
        if (id === 'virtual:feature-flags') {
          const flags = { enableDarkMode: true, showBetaBanner: false }
          return `
            export const FEATURES = ${JSON.stringify(flags)} as const;
            export type FeatureFlags = typeof FEATURES;
          `
        }
      }
    }
  ],
  resolve: {
    alias: {
      '@': path.resolve(__dirname, 'src')
    }
  }
})

✅ TypeScript 必须同步适配(否则类型报错)

仅靠 Vite 插件返回代码还不够,TS 编译器和编辑器(VS Code)需要知道这些虚拟模块存在且可导入。需在 tsconfig.json 中显式声明:

Add Typescript Best Practices
Add Typescript Best Practices

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

下载
{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "virtual:*": ["src/virtual/*"]
    }
  },
  "include": [
    "src/**/*.ts",
    "src/**/*.d.ts",
    "src/**/*.tsx",
    "src/**/*.vue"
  ]
}

⚠️ 注意:"virtual:*" 是逻辑路径映射,实际无需创建 src/virtual/ 目录。它只是告诉 TS “当看到 import { ... } from 'virtual:xxx' 时,请当作合法模块处理”。

✅ 在代码中安全使用虚拟模块

// src/composables/useApi.ts
import { API_CONFIG } from 'virtual:api-config' // ✅ TS 识别类型,IDE 有提示
import { FEATURES } from 'virtual:feature-flags'

console.log(API_CONFIG.baseUrl) // 类型安全:string
console.log(FEATURES.enableDarkMode) // 类型安全:boolean

✅ 进阶建议:配合 @rollup/plugin-dynamic-import-vars 或 glob 生成模块列表

若需根据目录结构自动生成虚拟模块(例如扫描 src/api/endpoints/ 下所有 .ts 文件并汇总成一个 virtual:endpoints),可在 load 钩子中读取文件系统,用 fs.readdirSync + require.resolve 构建导出列表,再拼接为 TS 字符串返回。


TypeScript 不会编译虚拟模块本身(因无物理文件),但 Vite 的 load 返回内容会被当作真实 .ts 源码送入 TS 类型检查流程——只要 tsconfig.json 正确声明路径,就能享受完整类型推导、跳转、重构支持。

相关文章

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

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

下载

相关标签:

vite typescript js javascript

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

相关专题

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

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

2023.06.20

4566

5

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

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

2023.07.04

1129

3

js四舍五入
js四舍五入

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

2023.07.04

4484

6

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

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

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1796

5

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

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

2023.09.04

3265

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4253

6

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

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

2023.09.20

2760

5

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

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

2023.09.20

888

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二期_大前端线上班
第二期_大前端线上班

共345课时 | 80.5万人学习

WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习