Comment publier un package npm avec des fichiers de distribution?

Je souhaite publier un package npm contenant ma source ainsi que les fichiers de distribution. Mon référentiel Github contient un srcdossier contenant les fichiers source JavaScript. Le processus de génération génère un distdossier contenant les fichiers de distribution. Bien sûr, le distdossier n'est pas archivé dans le référentiel Github.

Comment publier un package npm de manière à ce que lorsque quelqu'un le fasse npm install, il obtienne srcainsi qu'un distdossier? Actuellement, lorsque j'exécute à npm publishpartir de mon référentiel git, seul le srcdossier est publié.

Mon package.json ressemble à ceci:

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

Jetez un œil au champ "files" du fichier package.json https://docs.npmjs.com/files/package.json#files

De la documentation:

Le champ "fichiers" est un tableau de fichiers à inclure dans votre projet. Si vous nommez un dossier dans le tableau, il inclura également les fichiers à l'intérieur de ce dossier. (À moins qu'ils ne soient ignorés par une autre règle.)

Lorsque vous npm publish, si vous n'avez pas de .npmignorefichier, npm utilisera votre .gitignorefichier (dans votre cas, vous avez exclu le distdossier).

Pour résoudre votre problème, créez un .npmignorefichier basé sur votre .gitignorefichier, sans ignorer le dossier dist .

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

Exemple minimal d'utilisation des fichiers de données à partir d'un script

Un autre cas d'utilisation courant est d'avoir des fichiers de données que vos scripts doivent utiliser.

Cela peut être fait facilement en utilisant les techniques mentionnées à: Dans node.JS comment puis-je obtenir le chemin d'un module que j'ai chargé via require qui n'est * pas * le mien (c'est-à-dire dans certains node_module)

L'exemple complet peut être trouvé à:

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

Avec cette configuration, le fichier mydata.txtest placé node_modules/cirosantilli-data-files/mydata.txtaprès l'installation car nous l'avons ajouté à notre files:entrée de package.json.

Notre fonction myfuncpeut ensuite trouver ce fichier et utiliser son contenu en utilisant require.resolve. Cela fonctionne également uniquement sur l'exécutable, ./cirosantilli-data-filesbien sûr.

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

Le is-installed-globallypackage est alors utile si vous souhaitez générer des chemins relatifs vers les fichiers distribués selon qu'ils sont installés localement ou globalement: Comment savoir si le package npm a été installé globalement ou localement