¿Cómo publicar un paquete npm con archivos de distribución?

Me gustaría publicar un paquete npm que contenga mi fuente y archivos de distribución. Mi repositorio de Github contiene una srccarpeta que contiene archivos fuente JavaScript. El proceso de construcción genera una distcarpeta que contiene los archivos de distribución. Por supuesto, la distcarpeta no está registrada en el repositorio de Github.

¿Cómo publico un paquete npm de manera que cuando alguien lo haga npm install, reciba srctan bien como distcarpeta? Actualmente, cuando ejecuto npm publishdesde mi repositorio de git, solo srcse publica la carpeta.

Mi package.json se ve así:

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

Eche un vistazo al campo "archivos" del archivo package.json https://docs.npmjs.com/files/package.json#files

De la documentación:

El campo "archivos" es una matriz de archivos para incluir en su proyecto. Si nombra una carpeta en la matriz, también incluirá los archivos dentro de esa carpeta. (A menos que sean ignorados por otra regla).

Cuando usted npm publish, si no tiene un .npmignorearchivo, npm usará su .gitignorearchivo (en su caso, excluyó la distcarpeta).

Para resolver su problema, cree un .npmignorearchivo basado en su .gitignorearchivo, sin ignorar la carpeta dist .

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

Ejemplo mínimo de cómo usar archivos de datos de un script

Otro caso de uso común es tener archivos de datos que sus scripts deben usar.

Esto se puede hacer fácilmente usando las técnicas mencionadas en: En node.JS, ¿cómo puedo obtener la ruta de un módulo que he cargado a través de require que es * no * mío (es decir, en algún node_module)

El ejemplo completo se puede encontrar en:

• fuente: https://github.com/cirosantilli/linux-kernel-module-cheat/tree/008bd8000234d74e00845939ea6c47d302a26706/npm/data-files
• publicado: https://www.npmjs.com/package/cirosantilli-data-files

Con esta configuración, el archivo mydata.txtse coloca node_modules/cirosantilli-data-files/mydata.txtdespués de la instalación porque lo agregamos a nuestra files:entrada de package.json.

Nuestra función myfuncpuede entonces encontrar ese archivo y usar su contenido usando require.resolve. También solo funciona en el ejecutable, ./cirosantilli-data-filespor supuesto.

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

El is-installed-globallypaquete es útil si desea generar rutas relativas a los archivos distribuidos dependiendo de si están instalados localmente o globalmente: Cómo saber si el paquete npm se instaló global o localmente