Vue (Official) v3.0.2 新特性 为非类npm环境引入 globalTypesPath 选项

前言

在早上更新了vscode后,发现自己 uni-app 项目的 .vue文件template 标签都出现了报错。定位到了问题是因为 Vue (Official) 插件更新导致的,重装了插件的上一个小版本,报错消失,暂时解决了问题。

报错信息

js 复制代码
Write global types file failed. Please ensure that "node_modules" exists and "vue" is a direct dependency, or set "vueCompilerOptions.globalTypesPath" in "tsconfig.json" manually.vue(404)

提示请确保 "node_modules" 目录存在且 "vue" 是项目的直接依赖项,或在 "tsconfig.json" 中手动配置 "vueCompilerOptions.globalTypesPath" 参数。vue(404)

原因

在github上提交了反馈后很快得到了大佬的回复,了解查阅后发现并非是bug,而是版本更新的新特性。

v3.0.2 版本之前 Vue (Official) 如果检测不到 node_modules,全局类型会被写到每一个 .vue 的虚拟文件里面,将造成大量内存开销。而现在为了解决这一问题在 v3.0.2 中需要为缺少 node_modules 目录的项目环境 ("non-npm like environment")在 tsconfig.json 或者 jsconfig.json 里面手动指定出 vueCompilerOptions.globalTypesPath 的位置。

而我的使用 HBuilderX 创建的 uni-app 项目完全符合这种情况,既缺少 node_modules 也缺少tsconfig.jsonjsconfig.json 文件。在 #5505 中提供了一个解决在项目缺少 node_modules 时,手动指定 vueCompilerOptions.globalTypesPath 的方法

解决方案

  • 确定 Vue (Official) 版本为 3.0.2
  • 首先在项目根目录下创建tsconfig.json 或者 jsconfig.json (以 jsconfig.json 为例)
  • jsconfig.json 中添加
js 复制代码
{
  "vueCompilerOptions": {
    "globalTypesPath": "./vue-global-types.d.ts"
  }
}
  • globalTypesPath 中的路径和文件名是可以自己指定的,也可以像这样 ./types/uni-app.d.ts
  • 随后在扩展中禁用 Vue (Official) ,并选择重新启动扩展 ,最后选择启用插件 !
  • 此时 Vue (Official) 会自动在你的指定路径下生成指定文件并写入内容,此时报错解决!

总结

  • 这个错误提示是 Vue (Official) 有意设计的功能,而不是一个bug 。他解决了先前在检测不到 node_modules时,写入全局类型会造成大量内存开销的问题。
  • 类似 npm 会生成 node_modules 结构的项目都不需要关心这个问题。而像 uni-app 这样的项目在使用 Vue (Official) 时则需要进行配置。
  • 如果项目包含 node_modules 文件夹,出现了同样的报错,推荐查看 #5516 可能是因为项目结构嵌套的问题。
相关推荐
毕设源码-郭学长2 小时前
【开题答辩全过程】以 基于vue在线考试系统的设计与实现为例,包含答辩的问题和答案
前端·javascript·vue.js
詩句☾⋆᭄南笙2 小时前
初识Vue
前端·javascript·vue.js
qb3 小时前
vue3.5.18-编译-生成ast树
前端·vue.js·架构
我的写法有点潮3 小时前
Vue实例都做了什么?
前端·javascript·vue.js
鹏多多3 小时前
vue3监听属性watch和watchEffect的详解
前端·javascript·vue.js
小蒜学长4 小时前
基于SpringBoot+Vue的健身房管理系统的设计与实现(代码+数据库+LW)
java·数据库·vue.js·spring boot·后端
不想上班只想要钱5 小时前
vue3 ts:声明的一个数组不能将类型“boolean”分配给类型“never”。
前端·vue.js
拉不动的猪14 小时前
简单回顾下Weakmap在vue中为何不能去作为循环数据源,以及替代方案
前端·javascript·vue.js
java水泥工16 小时前
校园管理系统|基于SpringBoot和Vue的校园管理系统(源码+数据库+文档)
数据库·vue.js·spring boot
正义的大古18 小时前
OpenLayers常用控件 -- 章节七:测量工具控件教程
前端·javascript·vue.js·openlayers