本地安装修改后的GitHub NPM包：解决未编译（TS文件留存）问题

咱来帮你搞定这个头疼的问题——修改了GitHub上的TS模块，本地安装后却还是看到源TS文件，没生成JS，其实核心就是模块没在安装过程中完成编译，或者配置没到位导致npm找不到编译后的文件。下面给你两种靠谱的方案，还有关键配置要注意：

方案一：先编译本地模块，再本地安装（适合最终使用场景） #

这是最直接的方式，确保安装到项目里的是已经编译好的产物：

• 第一步：检查本地模块的tsconfig.json，确保配置了正确的编译输出：

  {
    "compilerOptions": {
      "outDir": "./dist", // 指定编译后的JS输出目录
      "declaration": true, // 生成类型声明文件（可选但推荐）
      "target": "ES6", // 根据你的项目需求选目标版本
      "module": "CommonJS" // 同样按需选择
    },
    "include": ["src/**/*"], // 要编译的TS文件范围
    "exclude": ["node_modules", "dist"] // 排除不需要编译的目录
  }
  

• 第二步：在模块的package.json里加编译脚本，还要加prepublishOnly确保打包/安装前自动编译：

  {
    "name": "your-module-name",
    "main": "dist/index.js", // 关键！指向编译后的入口JS
    "types": "dist/index.d.ts", // 类型声明文件路径（如果开启了declaration）
    "scripts": {
      "build": "tsc",
      "prepublishOnly": "npm run build" // 这个钩子会在npm pack/publish前自动执行编译
    }
  }
  

• 第三步：先在本地模块目录手动执行一次编译，确认dist目录生成了JS和类型文件：

  npm run build
  

• 第四步：回到你的主项目，安装本地模块：

  npm install /绝对路径/到/你的本地模块
  # 或者用相对路径更方便，比如
  npm install ../my-local-ts-module
  

方案二：用npm link（适合开发阶段频繁修改的场景） #

如果你需要反复修改本地模块，不想每次都重新安装，npm link是绝佳选择：

• 第一步：同样先配置好tsconfig.json和package.json的main、scripts（和方案一一样）。
• 第二步：在本地模块目录执行，把模块链接到npm全局仓库：

  npm link
  

• 第三步：在主项目目录执行，关联到本地模块：

  npm link your-module-name
  

• 第四步：之后每次修改本地模块的代码，只需要在模块目录执行npm run build，主项目里就能直接用到最新的编译产物了。

关键注意事项 #

• 千万别漏了package.json里的main字段！如果没指定，npm会默认找index.js，但你的源文件是index.ts，就会直接加载TS文件，这就是你看到的问题。
• 如果用npm pack打包本地模块，一定要确保打包前已经执行了npm run build，或者靠prepublishOnly自动触发，不然打包出来的包只有TS源文件，安装后自然没有JS。
• 要是你的模块用了其他构建工具（比如webpack、rollup），那把build脚本改成对应的构建命令就行，核心还是确保安装前生成了可执行的JS产物。

内容的提问来源于stack exchange，提问作者Bijay Kumar Rai