mitmario.dev

Versionen verstehen

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

Hinter slugify steht in der package.json meist ^1.6.9 und nicht nur 1.6.9. Das Zeichen davor macht aus der Version einen Bereich, und an diesem Bereich hängt, welchen fremden Code dein Projekt bei der nächsten frischen Installation bekommt. Dazu gehört auch Code, den es heute noch gar nicht gibt und den du nie gesehen hast.

Die drei Zahlen

Eine Version wie 1.4.2 besteht aus drei Teilen, und hinter jedem steckt ein Versprechen.

Steigt die erste Zahl, die Major-Version, darf sich alles ändern. Funktionen können verschwinden oder anders aufgerufen werden, und dein Code muss vielleicht angepasst werden. Express hat beim Sprung von 4 auf 5 zum Beispiel den Pfad "*" abgeschafft. Ein Programm, das ihn noch anmeldet, bricht mit Express 5 schon beim Start ab.

Steigt die zweite, die Minor-Version, ist etwas dazugekommen, und alles Bisherige funktioniert weiter.

Steigt die dritte, der Patch, ist ein Fehler behoben. Sonst ändert sich nichts.

Diese Verabredung heißt Semantic Versioning, kurz Semver. Nur deshalb kannst du überhaupt einen Bereich angeben und musst nicht jede neue Version einzeln prüfen.

Das Dach

Ein ^ vor der Version heißt Dach (englisch caret) und ist die Voreinstellung. npm install schreibt es von sich aus hin.

Was ^1.4.2 hereinlässt
const kandidaten = ["1.4.1", "1.4.2", "1.4.9", "1.7.0", "2.0.0"];

for (const version of kandidaten) {
  const [major, minor, patch] = version.split(".").map(Number);
  const erlaubt = major === 1 && (minor > 4 || (minor === 4 && patch >= 2));

  console.log(`${version.padEnd(6)} ${erlaubt ? "ja" : "nein"}`);
}

^1.4.2 lässt alles ab 1.4.2 bis unter 2.0.0 herein.

1.4.1 fällt raus, obwohl es dieselbe Minor-Version ist. Der Bereich beginnt nämlich bei der genannten Version und nicht bei der Minor-Reihe. Und 2.0.0 fällt raus, weil dort alles brechen darf.

1.7.0 ist dagegen drin. Damit bekommst du eine Minor-Version, die es beim ersten npm install noch gar nicht gab, und dazu Funktionen, die du nie angeschaut hast.

Die Tilde

Was ~1.4.2 anders macht
const kandidaten = ["1.4.1", "1.4.2", "1.4.9", "1.7.0", "2.0.0"];

for (const version of kandidaten) {
  const [major, minor, patch] = version.split(".").map(Number);
  const erlaubt = major === 1 && minor === 4 && patch >= 2;

  console.log(`${version.padEnd(6)} ${erlaubt ? "ja" : "nein"}`);
}

Eine Tilde (~) ist enger. ~1.4.2 reicht nur bis unter 1.5.0, herein kommen also nur Patches und damit nur Fehlerbehebungen.

Im Vergleich mit dem Dach ändert sich eine Zeile. 1.7.0 ist beim Dach erlaubt und bei der Tilde nicht.

Steht gar kein Zeichen davor, also nur 1.4.2, ist die Version festgenagelt.

Der Sonderfall unter 1.0.0

Der Sonderfall unterhalb von 1.0.0
const kandidaten = ["0.4.1", "0.4.2", "0.4.9", "0.5.0", "1.0.0"];

for (const version of kandidaten) {
  const [major, minor, patch] = version.split(".").map(Number);
  const erlaubt = major === 0 && minor === 4 && patch >= 2;

  console.log(`${version.padEnd(6)} ${erlaubt ? "ja" : "nein"}`);
}

Hier verhält sich das Dach plötzlich wie eine Tilde. ^0.4.2 erlaubt nur bis unter 0.5.0, obwohl das eine Minor-Erhöhung ist.

Vor 1.0.0 verspricht Semver gar nichts. Dort darf jede neue Version brechen. npm rechnet deshalb so, als wäre die erste Stelle, die nicht 0 ist, die Major-Stelle. Bei 0.4.2 ist das die 4.

Ein Paket in 0.x ist nicht automatisch schlecht. Du hast nur weniger Sicherheit, weil ein ^ dort nur eine Stelle weit schützt.

Warum es trotzdem manchmal knallt

Ob eine Version hält, was ihre Nummer verspricht, prüft npm nicht. Beim Veröffentlichen entscheidet ein Mensch, welche Zahl er hochzählt. Und Menschen schätzen sich falsch ein.

Deshalb bricht gelegentlich ein Patch etwas, meistens ohne jede böse Absicht. Rechnet eine Funktion nach einer Fehlerbehebung endlich richtig, stimmt kein Programm mehr, das ihren alten Fehler ausgeglichen hat.

Ein Versionsbereich allein macht eine Installation nicht wiederholbar. Das schafft erst die Datei, um die es in der nächsten Lektion geht.

In der Aufgabe stehen fünf Pakete noch auf *, und was das Team zu jedem beschlossen hat, liegt in einer eigenen Datei.

Zum Mitnehmen

Ein Dach lässt alles bis zur nächsten Major-Version herein, eine Tilde nur Patches, und unter 1.0.0 verhält sich das Dach wie eine Tilde. Ob eine Version hält, was ihre Nummer ankündigt, prüft dabei niemand.

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 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, auf dem Server geprüft

    Öffnet sich mit dem Basis Konto.