如何发布带有分发文件的npm软件包？

我想发布一个包含我的源代码和分发文件的npm软件包。我的Github存储库包含src包含JavaScript源文件的文件夹。生成过程将生成dist包含分发文件的文件夹。当然，该dist文件夹不会签入Github存储库。

我该如何发布npm软件包，以使某人这样做npm install时他们src和dist文件夹一样好？当前，当我npm publish从git存储库运行时，它只会导致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": {
    ...
  }
}

看看package.json文件https://docs.npmjs.com/files/package.json#files的“文件”字段

从文档中：

“文件”字段是要包含在项目中的文件数组。如果您在阵列中命名一个文件夹，那么它还将包括该文件夹内的文件。（除非它们会被另一个规则忽略。）

当您npm publish没有.npmignore文件时，npm将使用您的.gitignore文件（在您的情况下，您将dist文件夹排除在外）。

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

来源：https : //docs.npmjs.com/misc/developers#keeping-files-out-of-your-package

有关如何使用脚本中的数据文件的最小示例

另一个常见的用例是拥有脚本需要使用的数据文件。

使用以下提到的技术可以轻松完成此操作： 在node.JS中，我如何获取通过require不是*我的（即在某些node_module中）加载的模块的路径

完整的示例可以在以下位置找到：

• 来源：https : //github.com/cirosantilli/linux-kernel-module-cheat/tree/008bd8000234d74e00845939ea6c47d302a26706/npm/data-files
• 发布：https : //www.npmjs.com/package/cirosantilli-data-files

使用此设置，文件mydata.txt将node_modules/cirosantilli-data-files/mydata.txt在安装后放入，因为我们将其添加到的files:条目中package.json。

myfunc然后，我们的函数可以找到该文件并使用来使用其内容require.resolve。当然，它也只适用于可执行文件./cirosantilli-data-files。

package.json

{
  "bin": {
    "cirosantilli-data-files": "cirosantilli-data-files"
  },
  "license": "MIT",
  "files":  [
    "cirosantilli-data-files",
    "mydata.txt",
    "index.js"
  ],
  "name": "cirosantilli-data-files",
  "repository": "cirosantilli/linux-kernel-module-cheat",
  "version": "0.1.0"
}

mydata.txt

hello world

index.js

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

function myfunc() {
  const package_path = path.dirname(require.resolve(
    path.join('cirosantilli-data-files', 'package.json')));
  return fs.readFileSync(path.join(package_path, 'mydata.txt'), 'utf-8');
}
exports.myfunc = myfunc;

cirosantilli数据文件

#!/usr/bin/env node
const cirosantilli_data_files = require('cirosantilli-data-files');
console.log(cirosantilli_data_files.myfunc());

is-installed-globally如果要生成分布式文件的相对路径（取决于文件是本地安装还是全局安装），则该软件包很有用：如何确定npm软件包是全局安装还是本地安装