【问题标题】:When publishing a nodejs package, some files are upoload to npm but not upload to Github. Why?发布 nodejs 包时,有些文件会上传到 npm,但不会上传到 Github。为什么?
【发布时间】:2020-04-10 17:16:35
【问题描述】:

在发布 nodejs 包时,有些文件会上传到 npm,但不会上传到 Github。为什么?

例如,包是assets-webpack-plugin。

在其package.json 的files 部分中,它包括dist/:

"files": [
  "index.js",
  "dist/"
],

但在.gitignore 文件中仍然包含dist:

node_modules
dist
tmp
npm-debug.log*
.package.json

# Lock files shouldn't be committed for libraries https://stackoverflow.com/a/40206145
yarn.lock
package-lock.json

问题是为什么 Github 上的项目会忽略这些文件,而 npm 必须包含它们?现在它们在package.json 的files 部分,这意味着这些文件对包很重要——为什么.gitignore 他们?

【问题讨论】:

  • 构建工件通常不包含在源代码管理中,因为它们可以从源代码构建。但是,如果您想分发包以供其他人使用,您分发的是构建工件,而不是源代码。
  • 同理,游戏下载包含exe文件但不包含源代码,游戏的存储库(git、svn等)包含源代码但不包含exe文件

标签: node.js github npm


【解决方案1】:

让我们首先了解更多关于这个项目的“build”和“publish”步骤...

如果您检查项目package.json 文件,它包含在scripts 部分中定义的与您的问题相关的以下两个脚本:

"scripts": {
    ...
    "build": "babel index.js --out-dir dist && babel lib --out-dir dist/lib",
    "prepublish": "npm run build"
},

assets-webpack-plugin 的维护者将包发布到 npm 时,他们会使用 npm publish 命令。

在运行npm publish ... 时,会发生以下步骤:

  1. 在package.json(称为pre hook)中定义的prepublish 脚本会自动被调用并运行build 脚本。

  2. build 脚本本质上是利用babel-cli 工具开始转换项目源代码的过程(即源代码就是您在项目 GitHub 存储库中看到的)。生成的转译代码将发布到 npm。

    注意:在build 脚本中,输出文件被保存到dist 和dist/lib 文件夹中。

上述步骤(1 和 2)发生在 npm publish ... 命令将包发布到 npm 之前。


问题是为什么 Github 上的项目会忽略这些文件,而 npm 必须包含它们?

  1. 让我们解决您问题的“为什么 Github 上的项目忽略文件”部分问题:

    • 保存到dist文件夹的文件是根据上述步骤1和2自动从源代码生成的。

    • 生成“build” 文件的过程是可重复的。此“构建” 过程的结果文件输出是源代码文件的衍生文件。

    • 基本上,没有理由将 "build" 文件(即自动生成到 dist 文件夹的文件)推送到 GitHub 存储库,因为项目维护者知道他们可以简单地通过运行 npm build 脚本从源代码重新生成衍生版本。

  2. 让我们尝试解决 “...而 npm 必须包含它们” 您问题的一部分:

    • npm 必须包含 dist 文件夹中的文件,因为它们本质上是发布到 npm 注册表的文件。

【讨论】:

  • 另一个问题是当你想使用包 assets-webpack-plugin 时,dist 中的文件才是真正有用的。github 上的代码用于构建 dist 中的这些文件。对吗?
猜你喜欢
  • 2017-10-03
  • 1970-01-01
  • 2016-04-11
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2022-11-30
  • 2012-11-12
  • 2012-10-28
相关资源
最近更新 更多