如何为webpack构建的npm库生成发布用的精简版package.json

首先你的思路完全正确：如果你的npm包已经将所有依赖都打包进了dist目录的产物中，下游开发者安装后不需要二次构建，确实不需要在发布的package.json中保留多余的dependencies、devDependencies字段，避免下游安装不必要的依赖。

以下是行业通用的最佳实践：

首选方案：使用npm原生生命周期钩子配合轻量脚本 #

这个方案是绝大多数开源库的选择，不需要依赖额外工具，兼容性好，本地和CI发布流程都能生效。

配置步骤 #

1. 在根目录package.json中添加npm生命周期钩子和发布配置：

{
  "scripts": {
    "build": "webpack",
    // prepublishOnly是npm内置钩子，执行npm publish前会自动触发
    "prepublishOnly": "node ./scripts/generate-publish-pkg.js"
  },
  // 配置npm默认发布dist目录的内容，不需要手动cd到dist执行发布
  "publishConfig": {
    "directory": "dist"
  }
}

2. 新增scripts/generate-publish-pkg.js脚本，逻辑为读取根目录的package.json，移除不需要的字段后写入dist目录：

const fs = require('fs')
const path = require('path')

const rootPackage = require('../package.json')
const publishPackage = structuredClone(rootPackage)

// 移除不需要发布的字段
delete publishPackage.devDependencies
delete publishPackage.scripts
delete publishPackage.publishConfig
// 确认所有依赖都打包进产物的话可以删除dependencies，否则按需保留
delete publishPackage.dependencies
// 可选：peerDependencies如果有的话建议保留，比如组件库依赖的React版本要求

fs.writeFileSync(
  path.resolve(__dirname, '../dist/package.json'),
  JSON.stringify(publishPackage, null, 2)
)

配置完成后，你只需要正常执行npm run build && npm publish即可，npm会自动发布dist目录下修改后的包。

你提到的三种方案的适用场景 #

• 使用copy-webpack-plugin的transform能力生成package.json：适合不想新增额外脚本的项目，缺点是和webpack绑定，后续更换构建工具需要修改配置。
• 在CI流水线中添加自定义步骤生成package.json：适合有复杂发布校验逻辑的大型项目，缺点是本地手动执行npm publish时不会触发该步骤，容易出现发布错误。
• 单独维护一份发布用的package.json：不推荐，需要同时维护两份配置，很容易出现版本号、包描述等字段不一致的问题，维护成本很高。

补充注意事项 #

如果你的库存在不适合打包进产物的公共依赖（比如React、Lodash这类通用库），不要删除dependencies字段，应该保留这些外部依赖的声明，避免下游项目出现多份重复的依赖副本。

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