NX工作区中tsconfig.editor.json文件的用途及适用IDE咨询
关于NX工作区中
tsconfig.editor.json的用途与IDE支持说明 当创建Angular的NX工作区,或是向现有工作区添加新项目时,NX会在项目文件夹中生成tsconfig.editor.json文件。
我在查找该文件用途时,找到了添加它的GitHub PR #3810,其中描述的核心背景与作用如下:
当前问题
新创建的文件或未被源文件引用的文件,在IDE的类型检查器中没有对应的tsconfig配置。预期效果
新创建的文件或未被源文件引用的文件,可通过tsconfig.editor.json让IDE的类型检查器识别。
详细解释与示例
常规项目的tsconfig.json(比如tsconfig.app.json)通常只包含构建时需要的源文件(通过include字段指定特定路径,如src/**/*.ts),但对于临时创建、尚未被项目代码引用的文件(比如新建的工具类、测试草稿),IDE的TypeScript服务不会自动将它们纳入类型检查范围,导致这些文件里的语法错误、类型问题无法被实时检测。
tsconfig.editor.json的作用就是专门为IDE的TypeScript服务提供配置,让它能覆盖项目中更多文件,哪怕这些文件还没被正式引用。
一个典型的tsconfig.editor.json示例如下:
{ "extends": "./tsconfig.json", "include": [ "src/**/*", "tools/**/*", "*.ts" ], "exclude": [ "node_modules", "dist" ] }
extends:继承项目主tsconfig.json的基础配置,保证类型规则与项目一致include:扩大文件覆盖范围,包含src下所有文件、工具目录、根目录的ts文件,哪怕它们未被项目引用exclude:排除无需检查的依赖和构建产物目录
支持的IDE
目前主流的TypeScript友好IDE都支持识别tsconfig.editor.json:
- Visual Studio Code:通过内置TypeScript服务自动读取该配置,无需额外设置
- WebStorm/IntelliJ IDEA:自动识别并应用该文件配置,用于编辑器内的类型检查与代码提示
- 其他基于Language Server Protocol(LSP)的TypeScript编辑器:只要支持读取自定义tsconfig文件,均可适配(部分可能需要手动指定配置文件)
内容的提问来源于stack exchange,提问作者rearl
相关产品推荐
相关产品推荐

