Bagaimana cara mempublikasikan paket npm dengan file distribusi?

Saya ingin menerbitkan paket npm yang berisi file sumber dan distribusi saya. Repositori Github saya berisi srcfolder yang berisi file sumber JavaScript. Proses membangun menghasilkan distfolder yang berisi file distribusi. Tentu saja, distfolder tersebut tidak diperiksa di repositori Github.

Bagaimana cara saya mempublikasikan paket npm sedemikian rupa sehingga ketika seseorang melakukannya npm install, mereka mendapatkan srcserta distfolder? Saat ini ketika saya menjalankan npm publishdari repositori git saya, itu hanya menghasilkan srcfolder yang diterbitkan.

Package.json saya terlihat seperti ini:

{
  "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": {
    ...
  }
}

Lihat bidang "files" dari file package.json https://docs.npmjs.com/files/package.json#files

Dari dokumentasi:

Bidang "file" adalah larik file untuk disertakan dalam proyek Anda. Jika Anda memberi nama folder dalam array, maka itu juga akan menyertakan file di dalam folder itu. (Kecuali mereka akan diabaikan oleh aturan lain.)

Ketika Anda npm publish, jika Anda tidak memiliki .npmignorefile, npm akan menggunakan .gitignorefile Anda (dalam kasus Anda Anda mengecualikan distfolder tersebut).

Untuk mengatasi masalah Anda, buat .npmignorefile berdasarkan .gitignorefile Anda , tanpa mengabaikan folder dist .

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

Contoh minimal bagaimana menggunakan file data dari sebuah script

Kasus penggunaan umum lainnya adalah memiliki file data yang perlu digunakan skrip Anda.

Ini dapat dilakukan dengan mudah dengan menggunakan teknik yang disebutkan di: Dalam node.JS bagaimana saya bisa mendapatkan jalur modul yang telah saya muat melalui require yang * bukan * milik saya (yaitu di beberapa node_module)

Contoh lengkapnya dapat ditemukan di:

• sumber: https://github.com/cirosantilli/linux-kernel-module-cheat/tree/008i>000234d74e00845939ea6c47d302a26706/npm/data-files
• dipublikasikan: https://www.npmjs.com/package/cirosantilli-data-files

Dengan pengaturan ini, file mydata.txtdimasukkan ke dalam node_modules/cirosantilli-data-files/mydata.txtsetelah instalasi karena kami menambahkannya ke files:entri kami package.json.

Fungsi kami myfunckemudian dapat menemukan file itu dan menggunakan isinya dengan menggunakan require.resolve. Ini juga hanya berfungsi pada eksekusi ./cirosantilli-data-filestentu saja.

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());

The is-installed-globallypaket kemudian berguna jika Anda ingin menghasilkan path relatif ke file didistribusikan tergantung jika mereka diinstal secara lokal atau global: Bagaimana untuk mengetahui apakah paket NPM dipasang secara global atau lokal