node.js - 如何发布带有分发文件的 npm 包？

Question

我想发布一个包含我的源代码和分发文件的 npm 包。我的 GitHub 存储库包含 src 文件夹，其中包含 JavaScript 源文件。构建过程会生成包含分发文件的 dist 文件夹。当然，dist 文件夹并没有检入 GitHub 存储库。

我如何发布一个 npm 包，当有人执行 npm install 时，他们会获得 src 以及 dist 文件夹？目前，当我从我的 Git 存储库运行 npm publish 时，它只会发布 src 文件夹。

我的 package.json 文件如下所示:

{
  "name": "join-js",
  "version": "0.0.1",
  "homepage": "https://github.com/archfirst/joinjs",
  "repository": {
    "type": "git",
    "url": "https://github.com/archfirst/joinjs.git"
  },
  "main": "dist/index.js",
  "scripts": {
    "test": "gulp",
    "build": "gulp build",
    "prepublish": "npm run build"
  },
  "dependencies": {
    ...
  },
  "devDependencies": {
    ...
  }
}

Answer 1

当你 npm publish 时，如果你没有 .npmignore 文件，npm 将使用你的 .gitignore 文件(在你的如果您排除了 dist 文件夹)。

要解决您的问题，请根据您的 .gitignore 文件创建一个 .npmignore 文件，不要忽略 dist 文件夹。

来源: Keeping files out of your Package