Wie veröffentliche ich ein npm-Paket mit Verteilungsdateien?

Question

Ich möchte ein npm-Paket veröffentlichen, das meine Quell- und Distributionsdateien enthält. Mein Github-Repository enthält den Ordner src, der JavaScript-Quelldateien enthält. Der Buildprozess generiert den Ordner dist, der die Verteilungsdateien enthält. Der Ordner dist wird natürlich nicht in das Github-Repository eingecheckt.

Wie veröffentliche ich ein npm-Paket in einer Weise, dass wenn jemand npm install tut, erhalten sie src sowie dist Ordner? Derzeit, wenn ich npm publish von meinem Git-Repository ausführen, wird nur src Ordner veröffentlicht.

Meine package.json wie folgt aussieht:

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

Answer 1

Werfen Sie einen Blick auf die "Dateien" Feld der package.json Datei https://docs.npmjs.com/files/package.json#files

Aus der Dokumentation:

"Dateien" -Feld ist ein Array von Dateien, die in Ihrem Projekt enthalten sein sollen. Wenn Sie einen Ordner im Array benennen, enthält er auch die Dateien in diesem Ordner. (Es sei denn, sie würden von einer anderen Regel ignoriert werden.)

Answer 2

Wenn Sie npm publish, wenn Sie keine .npmignore Datei haben, werden npm Ihre .gitignore-Datei verwenden (in Ihrem Fall Sie ausgeschlossen, um die dist Ordner).

Um Ihr Problem, erstellen Sie eine .npmignore Datei auf der Grundlage Ihrer .gitignore Datei, ohne ignorieren die dist-Ordner zu lösen.

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