如何以原始TypeScript格式发布npm包？及官方指南相关疑问

如果你希望用户能直接获取你的TypeScript源码，按以下步骤操作即可：

• 配置package.json关键字段

  • 设置main字段指向你的TypeScript入口文件，比如"main": "./src/index.ts"
  • 添加types字段指向生成的声明文件（用于提供类型提示），比如"types": "./dist/index.d.ts"
  • 通过files字段明确指定要发布的文件，确保所有源码被包含：

    "files": [
      "src/**/*.ts",
      "dist/**/*.d.ts",
      "tsconfig.json"
    ]
    

  • 如果你的库使用ES模块规范，添加"type": "module"字段

• 调整tsconfig.json

  • 开启declaration: true来生成类型声明文件，同时可设置emitDeclarationOnly: true只生成.d.ts文件而不编译JavaScript（若无需发布编译后的JS）
  • 确保include数组包含你的源码目录，比如"include": ["src/**/*"]，用exclude排除node_modules等无关目录

• 发布前验证

  • 执行npm pack生成本地测试包，解压后检查是否包含所有需要的TypeScript源码、声明文件和配置文件
  • 用.npmignore或.gitignore排除不需要发布的文件（如node_modules、测试用例、构建日志等）

完成以上配置后，直接执行npm publish就能将包含原始TypeScript源码的库发布到npm了。

官方这么做主要是出于以下核心考虑：

• 兼容性最大化：JavaScript生态仍是主流，发布编译后的.js文件能让纯JS用户直接使用你的库，无需额外配置TypeScript环境
• 降低使用门槛：用户不需要安装TypeScript依赖、配置编译选项就能运行你的库，减少上手成本
• 统一编译输出：由你预先控制编译目标（如ES5/ES6）、模块规范等，避免不同用户因tsconfig配置差异导致编译出的代码出现兼容性问题
• 运行性能优化：编译后的JS文件可直接在浏览器或Node.js环境执行，无需用户在运行时编译，提升加载速度

当然，这并不代表发布源码是错误的做法——如果你的库目标用户主要是TypeScript开发者，或者用户需要自定义编译逻辑（比如修改目标版本、添加编译插件），发布原始TS源码完全是合理的选择。

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