npm

Eine Snippet-Sammlung für npm (node package manager).

Links:

• npmsearch - Suche für npm-Bundles
• npm-Tricks

npm installieren (Mac)

npm (und node) installieren:

brew update
brew install node

npm (und node) aktualisieren:

brew update
brew upgrade node
npm i -g npm

npm in Projekt einrichten

Initiale package.json anlegen:

npm init -y

Durch -y kommen keine Abfragen nach Projektname usw. - es werden die Defaults verwendet.

Häufige Befehle

Bundle laden und in package.json unter dependencies eintragen:

npm install <wanted-bundle> --save

Bundle laden und in package.json unter devDependencies eintragen:

npm install <wanted-bundle> --save-dev

Installierte Pakete mit Version anzeigen (--all zeigt alle Ebenen, mit -g werden globale Pakete gezeigt):

npm list
npm list --all
npm list -g

Verfügbare Versionen eines Pakets anzeigen:

npm show <wanted-bundle> versions

Veraltete Pakete anzeigen:

npm outdated

Veraltete Pakete auf neueste Version ziehen (benötigt npm-check-updates):

npm i -g npm-check-updates
npm-check-updates -u
npm install

Pakete aktualisieren (nach Versionsangaben in der package.json):

npm update

Pakete entfernen, die nicht (mehr) in der package.json stehen:

npm prune

Private npm-Projekte

Man kann ein npm-Projekt als privat markieren, dann passiert nichts, wenn man mal aus Versehen npm publish aufruft. Außerdem warnt npm dann nicht mehr, wenn description, repository oder README fehlen.

package.json erweitern:

{
  "private": true
}

Abhängigkeiten zu anderen privaten npm-Projekten:

{
  ...
  "dependencies": {
    "my-other-project1": "file:../my-other-project",
    "my-other-project2": "git+https://github.com/user/project.git#master"
  }
}

Siehe: npm-Doku

Öffentliche npm-Projekte

Details:

• npm-Doku Publishing npm packages.
• Blog-Artikel Step by step: Building and publishing an NPM Typescript package

Bei npm einloggen (einmal):

npm login

Version hochzählen (siehe Semantic versioning):

npm version (pre)major|(pre)minor|(pre)patch

Version veröffentlichen:

git push && git push --tags
npm publish

Das Paket ist nun öffentlich. Siehe: https://npmjs.com/package/<package>

Shortcuts für Scripte

Siehe: Doku

Script in package.json definieren:

{
  "scripts": {
    "clean": "rm -rf build",
    "build": "node_modules/.bin/webpack"
  }
}

Script ausführen:

npm run build

Ruft man npm run {script} mit dem Parameter -- auf, dann leitet npm die folgenden Parameter an das Skript weiter:

npm run build -- --watch

Repository angeben

package.json erweitern:

{
  "repository": {
    "type": "git",
    "url": "git+https://github.com/username/repository.git"
  }
}