JSII项目中TypeScript未忽略node_modules问题排查

问题场景 #

我有一个JSII项目，package.json中的JSII配置如下：

"jsii": {
  "outdir": "dist",
  "targets": {
    "python": {
      "distName": "pipeline-github-token",
      "module": "pipeline_github_token"
    }
  },
  "tsc": {
    "outDir": "build",
    "rooDir": "src"
  }
}

构建时JSII自动生成的tsconfig.json包含以下配置段：

"include": [
  "**/*.ts"
],
"exclude": [
  "node_modules",
  "build/**/*.ts"
],

但TypeScript编译时仍尝试处理node_modules内的文件，报出如下错误：

node_modules/jest-snapshot/build/index.d.ts:179:9 - error TS1005: ',' expected.

179   [hint?: string, fromPromise?: boolean]
            ~
node_modules/jest-snapshot/build/index.d.ts:179:30 - error TS1005: ',' expected.

179   [hint?: string, fromPromise?: boolean]
                                 ~
node_modules/jest-snapshot/build/index.d.ts:179:31 - error TS1134: Variable declaration expected.

179   [hint?: string, fromPromise?: boolean]
                                  ~
node_modules/jest-snapshot/build/index.d.ts:179:40 - error TS1005: ',' expected.

179   [hint?: string, fromPromise?: boolean]
                                           ~
node_modules/jest-snapshot/build/index.d.ts:180:1 - error TS1109: Expression expected.

180 >;;
    ~
node_modules/jest-snapshot/build/index.d.ts:180:2 - error TS1109: Expression expected.

核心原因 #

1. JSII配置拼写错误：tsc配置里的rooDir是笔误，正确字段名应为rootDir（少了一个t）。这个错误会导致TypeScript无法识别正确的源码根目录，打破exclude规则的生效逻辑，错误扫描到node_modules下的文件。
2. include范围过于宽泛："**/*.ts"会匹配所有层级的.ts文件，即使配置了exclude，一旦rootDir失效，TypeScript的文件解析逻辑会出现偏差，exclude规则无法正常过滤node_modules。
3. TS版本兼容问题：jest-snapshot的类型语法（数组解构中的可选参数）需要TypeScript 4.0及以上版本支持，当前使用的TS版本无法解析该语法，这会在exclude失效时触发报错。

解决办法 #

1. 修正JSII的tsc配置拼写：将rooDir改为rootDir，确保TypeScript能正确识别源码根目录，让exclude规则正常生效：

"jsii": {
  "outdir": "dist",
  "targets": {
    "python": {
      "distName": "pipeline-github-token",
      "module": "pipeline_github_token"
    }
  },
  "tsc": {
    "outDir": "build",
    "rootDir": "src" // 修正拼写错误
  }
}

2. 缩小include范围：替换全局匹配为明确的源码目录匹配，避免不必要的文件扫描：

"include": [
  "src/**/*.ts"
]

3. 升级TypeScript版本：如果修正配置后仍有类型语法错误，将TypeScript升级到4.0及以上版本，以支持jest-snapshot中的新语法特性。

内容的提问来源于stack exchange，提问作者Comfortably Numb