Jak opublikować pakiet npm z plikami dystrybucyjnymi?

Chciałbym opublikować pakiet npm zawierający moje pliki źródłowe i dystrybucyjne. Moje repozytorium Github zawiera srcfolder zawierający pliki źródłowe JavaScript. Proces kompilacji generuje distfolder zawierający pliki dystrybucyjne. Oczywiście distfolder nie jest wpisywany do repozytorium Github.

Jak opublikować pakiet npm w taki sposób, że gdy ktoś to zrobi npm install, dostanie srcrównież distfolder? Obecnie, gdy uruchamiam npm publishz mojego repozytorium git, srcpublikowany jest tylko folder.

Mój plik package.json wygląda następująco:

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

Spójrz na pole „files” w pliku package.json https://docs.npmjs.com/files/package.json#files

Z dokumentacji:

Pole „pliki” to tablica plików, które mają zostać uwzględnione w projekcie. Jeśli nazwiesz folder w tablicy, będzie on również zawierał pliki w tym folderze. (Chyba że zostaną zignorowani przez inną regułę).

Kiedy ty npm publish, jeśli nie masz .npmignorepliku, npm użyje twojego .gitignorepliku (w twoim przypadku wykluczyłeś distfolder).

Aby rozwiązać problem, utwórz .npmignoreplik na podstawie swojego .gitignorepliku, bez ignorowania folderu dist .

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

Minimalny przykład użycia plików danych ze skryptu

Innym częstym przypadkiem użycia jest posiadanie plików danych, których muszą używać twoje skrypty.

Można to łatwo zrobić za pomocą technik wymienionych w: W node.JS jak mogę uzyskać ścieżkę do modułu, który załadowałem za pomocą wymagania, które jest * nie * moje (tj. W jakimś module node_module)

Pełny przykład można znaleźć pod adresem:

• źródło: https://github.com/cirosantilli/linux-kernel-module-cheat/tree/008bd8000234d74e00845939ea6c47d302a26706/npm/data-files
• opublikowano: https://www.npmjs.com/package/cirosantilli-data-files

W tej konfiguracji plik mydata.txtjest umieszczany node_modules/cirosantilli-data-files/mydata.txtpo instalacji, ponieważ dodaliśmy go do naszego files:wpisu package.json.

Nasza funkcja myfuncmoże następnie znaleźć ten plik i użyć jego zawartości przy użyciu require.resolve. Oczywiście działa również na pliku wykonywalnym ./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-globallyPakiet jest następnie przydatna, jeśli chcesz wygenerować ścieżki względne do plików rozproszonych w zależności czy są one zainstalowane lokalnie lub globalnie: Jak sprawdzić, czy pakiet został zainstalowany npm globalnie lub lokalnie