npm包导出自定义错误类后TypeScript导入报错求助

可能的原因及对应解决步骤 #

1. npm包未正确生成并导出类型声明文件 #

TypeScript依赖.d.ts类型文件识别包的导出成员，若包未配置生成类型文件，就会出现导入时编辑器无报错但编译时找不到成员的情况。

解决步骤：

• 在包的tsconfig.json中确保以下配置：

  {
    "compilerOptions": {
      "declaration": true, // 生成.d.ts类型文件
      "outDir": "./dist", // 指定编译输出目录
      "rootDir": "./src" // 源码根目录，根据项目结构调整
    },
    "include": ["src/**/*"], // 包含所有需要编译的源码文件
    "exclude": ["node_modules", "dist"]
  }
  

• 在包的package.json中指定入口文件和类型文件路径：

  {
    "main": "./dist/index.js",
    "types": "./dist/index.d.ts", // 必须指定类型入口
    "scripts": {
      "build": "tsc" // 添加编译脚本，发布前执行npm run build
    }
  }
  

• 执行npm run build重新编译包，确认dist目录下生成了.js和.d.ts文件。

2. 文件路径大小写不匹配 #

在大小写敏感的系统（如Linux/macOS）中，index.ts的导入路径与实际文件名大小写不一致会导致导出失败。

比如index.ts中写的是：

export * from "./errors/not-found-error";

但实际文件名为NotFoundError.ts，就会出现匹配问题。解决方法是统一路径和文件名的大小写：

• 将文件名改为not-found-error.ts，或者将导入路径改为./errors/NotFoundError
• 重新编译包并更新依赖。

3. 本地链接或依赖未更新 #

如果是本地通过npm link使用包，可能存在编译缓存或旧版本文件的问题：

• 在包目录重新执行npm run build
• 在使用包的项目中执行npm install或重新执行npm link @node/common，确保依赖的是最新编译后的文件。

4. 导出语句正确性验证 #

检查包的index.ts是否正确导出目标类：

• 确认./errors/custom-error和./errors/not-found-error路径正确，对应文件中确实有export class或export abstract class声明
• 直接查看编译后的dist/index.d.ts文件，确认其中包含export class NotFoundError和export abstract class CustomError的声明。

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