1. ホーム
  2. node.js

[解決済み] 配布ファイルを含むnpmパッケージの公開方法は?

2022-04-20 07:22:16

質問

ソースファイルと配布ファイルを含む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ファイルの"files"フィールドを見ます。 https://docs.npmjs.com/files/package.json#files

ドキュメントより

files"フィールドは、プロジェクトに含めるファイルの配列です。配列の中にフォルダ名を指定すると、そのフォルダ内のファイルもインクルードされます。(他のルールで無視されない限り)。