配布ファイルを含むnpmパッケージを公開する方法は？

ソースと配布ファイルを含むnpmパッケージを公開したいと思います。私のGithubリポジトリにはsrcは、JavaScriptソースファイルをフォルダーが含まれています。ビルドプロセスdistにより、配布ファイルを含むフォルダーが生成されます。もちろん、distフォルダーはGithubリポジトリにチェックインされません。

誰かがnpm installを取得srcしたときに、distフォルダーと同様に取得するように、npmパッケージを公開するにはどうすればよいですか？現在私が走るとき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ファイルの「files」フィールドを ご覧くださいhttps://docs.npmjs.com/files/package.json#files

ドキュメントから：

「files」フィールドは、プロジェクトに含めるファイルの配列です。配列内のフォルダーに名前を付けると、そのフォルダー内のファイルも含まれます。（別のルールで無視される場合を除きます。）

とき、あなたはnpm publishあなたが持っていない場合は、.npmignoreファイルを、NPMは、あなたの使用します.gitignore（お使いの場合には、あなたが除外されたファイルをdistフォルダ）。

あなたの問題を解決するために、作成.npmignoreあなたに基づいてファイル.gitignore、ファイルをdistのフォルダを無視せずに。

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

スクリプトからのデータファイルの使用方法の最小限の例

もう1つの一般的な使用例は、スクリプトで使用する必要があるデータファイルを用意することです。

これは、次の場所に記載されている手法を使用して簡単に行うことができます。node.JSでrequireを介してロードしたモジュールのパスを取得するにはどうすればよいですか。

完全な例は、次の場所にあります。

• ソース：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-data-files

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

is-installed-globallyパッケージには、あなたは彼らがローカルまたはグローバルにインストールされている場合によっては配布されたファイルへの相対パスを生成する場合は、その後に便利です：NPMパッケージは、グローバルまたはローカルにインストールされた場合、どのよう指示します