Nx环境下解决libxmljs2-xsd缺失TypeScript声明文件的问题问询

NX 环境下该问题的完整解决步骤 #

1. 创建类型声明文件
   在报错的NX项目（对应apps/xxx或libs/xxx目录）根目录新建typings文件夹，在文件夹内创建libxmljs2-xsd.d.ts文件，写入以下内容：

declare module 'libxmljs2-xsd' {
  // 可根据你实际使用的API逐步补充类型，避免全局关闭any校验
  export function parse(xsdSource: string | Buffer): {
    validate(xmlSource: string | Buffer): boolean | { errors: unknown[] };
  };
  // 其他用到的导出方法可自行补充类型定义
}

如果暂时不需要完整类型只想解决报错，也可以简化为declare module 'libxmljs2-xsd';。

2. 修改项目级TS配置
   找到对应项目根目录下的tsconfig.json（不是工作区根目录的tsconfig.base.json），修改以下配置：

{
  "compilerOptions": {
    // 新增自定义类型目录
    "typeRoots": ["node_modules/@types", "./typings"]
  },
  "include": [
    "src/**/*.ts",
    // 新增声明文件匹配规则
    "typings/**/*.d.ts"
  ]
}

如果是可构建的NX库，还要同步修改同目录下的tsconfig.lib.json、tsconfig.build.json的include配置，避免构建时遗漏声明文件。

3. 清理缓存验证生效
   NX默认会缓存构建和类型检查结果，修改配置后必须执行以下操作避免缓存干扰：

• 执行nx reset清理全局NX缓存
• 重启IDE的TS语言服务（VSCode可按Ctrl+Shift+P选择「TypeScript: Restart TS Server」）
• 重新执行类型检查或构建命令验证问题是否解决

之前配置不生效的常见原因 #

• 错误将配置写在工作区根目录的tsconfig.base.json中，NX项目级的tsconfig配置优先级更高，会覆盖根目录的include、typeRoots等配置，只有项目级的配置对当前项目生效
• 未清理NX缓存，旧的缓存结果导致配置修改看起来没有生效
• 声明文件后缀错误写为.ts而非.d.ts，不会被TS识别为类型声明文件

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