mitmario.dev

Synthese: ein Paket im Einsatz

Node.js Sandbox 3 Min Lesezeit 2 BeispieleLektion 6 von 7

Ein Projekt mit fremdem Code entsteht in sechs Schritten. In der falschen Reihenfolge verspricht die package.json einen Startbefehl, den es noch nicht gibt, oder ein import scheitert, weil in type noch das "commonjs" von npm init -y steht.

Die Reihenfolge am Stück

  1. Projekt anlegen. npm init -y erzeugt die package.json.
  2. type setzen. npm init -y hat "commonjs" eingetragen, für ESM muss dort "module" stehen.
  3. Paket auswählen, mit den zwei Minuten aus Lektion 5.5. Wie alt, wie gepflegt, wie viele Abhängigkeiten, heißt es wirklich so?
  4. Installieren. npm install slugify schreibt den Eintrag in dependencies und legt das Lockfile an.
  5. Importieren und benutzen, und dabei in die Dokumentation schauen, sonst wird aus Köln ein Koln.
  6. Startbefehl eintragen, "start": "node index.js" in den Block scripts.
Ein Projekt in der richtigen Reihenfolge
import slugify from "slugify";
import { readFile } from "node:fs/promises";

const eintraege = JSON.parse(await readFile("titel.json", "utf8"));

for (const eintrag of eintraege) {
  console.log(`${eintrag} -> ${slugify(eintrag, { lower: true, locale: "de" })}`);
}

console.log(`${eintraege.length} Einträge verarbeitet`);

Im Beispiel liegt ein vollständiges kleines Projekt, und es lässt sich auch wie eines bedienen. Mit npm start aus der Befehlsleiste schreibt npm im Terminal erst, was es ausführt (> node index.js), und danach kommt die Ausgabe des Programms. Diesen Weg nimmt später jeder, der dein Projekt bekommt. Deinen Dateinamen muss er dafür nicht kennen.

Der Startbefehl kommt zuletzt

Beim Entwickeln tippst du node index.js sowieso von Hand, und der Befehl ändert sich vielleicht noch. Vielleicht kommt eine Option dazu, vielleicht heißt die Datei am Ende anders.

Der scripts-Eintrag ist dagegen eine Zusage an andere. Wer npm start tippt, bekommt das laufende Programm. So eine Zusage gibt man erst, wenn feststeht, was der richtige Befehl ist. Ein start, das nicht startet, ist schlimmer als gar keins, denn damit rechnet niemand. Fehlt der Eintrag ganz, sagt npm wenigstens ehrlich npm error Missing script: "start" und schlägt als Ersatz npm star vor, einen Befehl, der Pakete mit einem Stern markiert.

Ein Paket wieder loswerden

Ein Paket herauszunehmen ist einfach, solange du es an einer Stelle benutzt. Du ersetzt diese eine Stelle und deinstallierst.

Steht es an zwanzig Stellen, wird aus der Änderung ein eigenes kleines Projekt. Und je praktischer ein Paket ist, desto eher landet es nach und nach überall.

Gründe, warum du ein Paket loswerden willst, gibt es genug. Es wird nicht mehr gepflegt. Es hat eine Sicherheitslücke, die niemand schließt. Es hat in Version 3 alles umgebaut. Oder Node kann es inzwischen selbst, so wie fetch seit Node 18 und das Einlesen einer .env mit --env-file seit Node 20.6.

Das Paket hinter einer eigenen Datei
import { readFile } from "node:fs/promises";
import { kurzform } from "./lib/kurzform.js";

const eintraege = JSON.parse(await readFile("titel.json", "utf8"));

for (const eintrag of eintraege) {
  console.log(`${eintrag} -> ${kurzform(eintrag)}`);
}

console.log(`${eintraege.length} Einträge verarbeitet`);

Hier steht zwischen dem Paket und dem restlichen Code eine kleine eigene Datei. index.js importiert jetzt kurzform statt slugify.

Am Ergebnis ändert das nichts. Die Ausgabe ist bei beiden Beispielen Zeichen für Zeichen dieselbe.

Die Optionen stehen jetzt an einer Stelle. Ohne die eigene Datei müsstest du { lower: true, locale: "de" } bei jedem weiteren Aufruf wiederholen, und spätestens beim dritten vergisst jemand die locale.

Fällt slugify morgen weg, ändert sich lib/kurzform.js und sonst nichts. Und der Name passt zum Projekt. An kurzform siehst du, was die Funktion in deinem Zusammenhang tut.

Das lohnt sich nicht bei jedem Paket. Bei einem, das an vielen Stellen vorkommt, und bei einem, dessen Aufruf du dir merken müsstest, lohnt es sich fast immer. In Abschnitt 18 kommt der Gedanke wieder, wenn ein ganzes Projekt in Dateien aufgeteilt wird. Dort hat jede Datei eine Aufgabe und einen Namen, der sie sagt.

Was in der Aufgabe noch fehlt, gehört alles in die package.json, die npm init -y angelegt hat.

Zum Mitnehmen

Erst type, dann das Paket, und der Startbefehl kommt zuletzt, wenn feststeht, was er starten soll. Steht ein Paket hinter einer eigenen kleinen Datei, kostet sein Austausch später nur diese eine Datei.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 2 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.