如何为Pixi 6原生模块配置TypeScript类型补全?
原生ES模块项目PixiJS类型识别配置方案
无需引入打包工具、无需新增package.json配置,仅需两步即可让VS Code正常识别PixiJS类型:
- 关联模块与类型声明
在js目录下新建pixi.mjs.d.ts文件,写入如下内容:
VS Code内置的TypeScript语言服务解析相对路径模块时,默认会查找与导入文件同名的export * from './index.d.ts';.d.ts文件作为类型来源。你之前将PixiJS的类型文件命名为index.d.ts,和实际导入的pixi.mjs文件名不匹配,所以无法自动关联。新增的这个文件会作为桥接,把pixi.mjs的类型指向你已经存放好的PixiJS类型声明。 - 新增JS项目类型配置
在项目根目录(与index.html同级)新建jsconfig.json文件,写入如下配置:
配置中{ "compilerOptions": { "target": "ESNext", "module": "ESNext", "checkJs": true, "moduleResolution": "node", "allowSyntheticDefaultImports": true }, "include": ["js/**/*"] }checkJs: true用于开启对.js/.mjs后缀文件的类型检查,include字段限定类型扫描范围,避免遍历无关目录影响性能。
生效操作
配置完成后,按下Ctrl+Shift+P(macOS为Cmd+Shift+P)调出VS Code命令面板,搜索并执行TypeScript: Restart TS Server,等待TS服务重启完成后,PixiJS的代码补全、类型校验即可正常生效,你原有代码中的导入语句不需要做任何修改。
如果后续出现部分类型缺失的问题,检查你放在js目录下的
index.d.ts是否存在对其他.d.ts文件的引用,如果有,把对应依赖的类型文件按照PixiJS npm包内的原始目录结构一并拷贝到js目录即可。
内容的提问来源于stack exchange,提问作者Kokodoko
相关产品推荐
相关产品推荐

