TypeScript检查本地依赖JS文件但不输出的配置问题
我来帮你搞定这个让人头疼的TS配置问题!你的核心需求很明确:想让TS能识别本地JS依赖的类型,同时只编译输出自己子模块里的TS代码,绝对不能把依赖文件也打包到输出目录里对吧?
先拆解下你之前配置出问题的原因:你把../dependencies/**/*.js加到了include里,这相当于告诉TS“这些也是需要我编译的源文件”,但你的rootDir设成了./ts,TS的规则是所有要编译的源文件必须在rootDir目录下,所以就抛出了TS6059错误。而改成../当rootDir的话,TS又会把所有include的文件(包括依赖)都输出到outDir,完全不符合你的需求。
下面给你两个最实用的解决方案,按需选择:
方案一:移除include中的依赖路径,通过引用获取类型
这个方法最简单,不需要额外写声明文件,靠TS自动推断类型:
- 调整tsconfig.json的include范围
把依赖文件从include里删掉,只保留你的TS源码目录:
{ "compilerOptions": { "allowJs": true, "checkJs": false, // 如果不需要检查依赖JS的语法错误,设为false就行;如果要检查,也可以保留true,但依赖不在include里TS不会去检查它们 "rootDir": "./ts", "outDir": "./js", // 其他你需要的配置比如target、module等 }, "include": [ "./ts/**/*" ] }
- 在TS文件中正确引用依赖
- 如果你的依赖是ES模块化的(比如用
export导出内容):import * as utils from '../../dependencies/utils.js'; // 现在TS会自动解析utils的类型,给你补全提示 - 如果依赖是全局变量(比如直接挂载到window上的库):
/// <reference path="../../dependencies/globalLib.js" /> // 现在可以直接用全局变量,TS会提供部分类型推断
- 如果你的依赖是ES模块化的(比如用
这样一来,TS只会编译你./ts里的代码到./js,完全不会碰依赖文件,同时还能正常解析依赖的类型,也不会再报rootDir的错误。
方案二:手动编写类型声明文件(更可控)
如果TS自动推断的类型不够精准,或者你想给依赖补全更详细的类型,就用这个方法:
创建类型声明目录
在你的子模块ts目录下新建一个types文件夹,专门放依赖的类型声明文件。编写.d.ts声明文件
比如你的依赖是一个叫utils.js的工具库,就写一个utils.d.ts:
declare module 'utils' { export function formatDate(date: Date): string; export const version: string; }
如果是全局变量类型的依赖,就写:
declare global { interface Window { GlobalLib: { init(): void; doSomething(): boolean; } } } export {};
- 配置tsconfig识别类型目录
在compilerOptions里加上typeRoots,让TS能找到你写的声明文件:
"compilerOptions": { // ...其他配置 "typeRoots": ["./ts/types", "./node_modules/@types"] }
这个方法能让你完全掌控依赖的类型定义,而且彻底和依赖的JS文件解耦,完全不会有编译输出的问题。
总结一下
核心思路就是:别把依赖JS文件当成TS要编译的源文件,只让TS读取它们的类型信息就行。上面两个方案都能帮你解决问题,选哪个看你对类型精准度的需求~
备注:内容来源于stack exchange,提问作者Abderrahim Benmelouka

