TypeScript包依赖缺失问题：如何确保npm安装时自动获取依赖？

我有两个TypeScript包，project-1作为依赖安装在project-2中。能正常导入并访问project-1的所有类型定义，但project-1的依赖找不到，因为它的node_modules目录不存在。

我是不是必须手动进入./project-2/node_modules/project-1执行npm install？或者需要把node_modules目录发布到npm？如果要发布，是不是得从tsconfig.json的exclude里移除它？另外node_modules应该放在.gitignore里对吧？

目录结构说明 #

./project-2/node_modules                         // 存在
./project-2/node_modules/project-1               // 存在
./project-2/node_modules/project-1/node_modules  // 不存在

/* 仅在手动进入./project-2/node_modules/project-1执行npm install后，该node_modules目录才会出现。 */

project-1 配置信息 #

package.json #

{
  "main": "./dist/index.js",
  "types": "./dist/index.d.ts",
  "type": "commonjs"
}

tsconfig.json #

{
  "compilerOptions": {
    "declaration": true,
    "esModuleInterop": true,
    "module": "CommonJS",
    "outDir": "dist",
    "baseUrl": ".",
    "rootDir": "src",
    "strict": true,
    "target": "ES5",
    "noImplicitAny": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "src/**/*.test.ts"]
}

.gitignore #

node_modules
dist
logs
tsconfig.tsbuildinfo
.env

.npmignore #

该文件为空。

核心结论：不需要手动安装子依赖，也绝对不能发布node_modules到npm #

npm本身会自动处理依赖传递：当你在project-2里安装project-1时，npm会自动把project-1的package.json里声明的**dependencies**（注意不是devDependencies）安装到project-2的根node_modules目录下，而不是project-1自己的node_modules里。这是npm的默认依赖扁平化机制，目的是避免重复安装依赖。

问题排查与解决步骤 #

1. 检查project-1的依赖声明

   • 确保project-1运行时必须的依赖都放在dependencies字段中，而不是devDependencies。devDependencies仅用于project-1自身的开发阶段（比如测试框架、打包工具），不会被传递到依赖它的project-2中。
   • 举个例子：如果project-1代码里用到了lodash，那lodash必须出现在dependencies里，不能只放在devDependencies。

2. 关于node_modules的关键规则

   • 绝对不要发布node_modules到npm：这会导致包体积暴增，而且npm的依赖机制已经能自动处理子依赖，完全没必要这么做。
   • node_modules必须加入.gitignore：这是前端开发的通用规范，避免把第三方依赖代码提交到Git仓库。
   • tsconfig.json的exclude保留node_modules即可：编译TypeScript时不需要处理第三方依赖的代码，排除它能提升编译效率。

3. 手动安装的弊端
   手动进入project-1目录执行npm install确实能让它的node_modules出现，但这是错误的做法——npm已经把这些依赖扁平化安装到project-2的根node_modules了，手动安装只会造成重复依赖，浪费磁盘空间，还可能引发版本冲突。

4. 如果问题仍未解决

   • 删除project-2的node_modules和package-lock.json，执行npm install重新安装，让npm重新解析并构建依赖树。
   • 确认project-1发布到npm的版本中，package.json包含完整的dependencies字段，没有遗漏运行时依赖。

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