Wie man den Yarn-Paketmanager für Node.js installiert und verwendet

Einführung

Yarn ist ein Paketmanager für Node.js, der auf Geschwindigkeit, Sicherheit und Stabilität setzt. Er wurde ursprünglich entwickelt, um einige Probleme des beliebten Paketmanagers NPM zu beheben. Obwohl sich die beiden Paketmanager hinsichtlich Funktionalität und Funktionen inzwischen angenähert haben, ist Yarn weiterhin beliebt, insbesondere in der React-Entwicklung.

Zu den einzigartigen Merkmalen von Yarn gehören:

• In jedem Projekt ist ein Speichermechanismus integriert, der die nachfolgende Installation und den Aufbau erheblich beschleunigen kann.
• Feste und endgültige Installationen, die sicherstellen, dass die Struktur der installierten Bibliotheken immer gleich ist.
• Prüfung der Aggregation aller Pakete zur Überprüfung ihrer Integrität
• “Workspaces”, die die Nutzung von Yarn in einem Monorepo (mehrere Projekte, die in einem einzigen Quellcode-Repository entwickelt werden) erleichtern.

In diesem Tutorial installieren Sie Yarn global, fügen Yarn einem bestimmten Projekt hinzu und lernen einige grundlegende Yarn-Befehle kennen.

Voraussetzungen

Bevor Sie den Yarn-Paketmanager installieren und verwenden können, muss Node.js installiert sein. Um zu überprüfen, ob Node.js bereits installiert ist, geben Sie folgenden Befehl in Ihrem lokalen Terminal ein:

node -v

Wenn eine Versionsnummer wie v12.16.3 angezeigt wird, ist Node.js installiert. Sollten Sie eine Fehlermeldung wie „Befehl nicht gefunden“ erhalten, installieren Sie bitte Node.js, bevor Sie fortfahren.

Schritt 1 – Globale YARN-Installation

Yarn verwendet eine spezielle Methode zur Installation und Ausführung in JavaScript-Projekten. Zuerst wird Yarn global installiert, anschließend wird mit dem Befehl `yarn global` eine spezifische lokale Version im Projektverzeichnis installiert. Dies ist notwendig, um sicherzustellen, dass alle Projektbeteiligten (sowie alle automatisierten Test- und Bereitstellungstools des Projekts) dieselbe Yarn-Version verwenden und somit inkonsistentes Verhalten und abweichende Ergebnisse vermieden werden.

Die Entwickler von Yarn empfehlen, Yarn global über den Paketmanager NPM zu installieren, der standardmäßig in allen Node.js-Installationen enthalten ist. Verwenden Sie dazu den Parameter `-g` bei `npm install`.

sudo npm install -g yarn

Nach der Installation des Pakets lautet der Befehl Garn Lassen Sie sich die Versionsnummer anzeigen. So können Sie überprüfen, ob die Installation korrekt durchgeführt wurde:

yarn --version

Output
1.22.11

Nachdem Sie den yarn-Befehl nun global installiert haben, können Sie ihn verwenden, um Yarn in einem bestimmten JavaScript-Projekt zu installieren.

Schritt 2 – Garn in Ihr Projekt einarbeiten

Wenn Sie Yarn für die Arbeit mit einem bestehenden Yarn-basierten Projekt verwenden, können Sie diesen Schritt überspringen. Das Projekt sollte bereits mit einer lokalen Version von Yarn und allen erforderlichen Konfigurationsdateien eingerichtet sein.

Wenn Sie ein neues Projekt für sich selbst starten, sollten Sie jetzt eine projektspezifische Version von Yarn konfigurieren.

Wechseln Sie zunächst in Ihr Projektverzeichnis:

cd ~/my-project

Falls Sie kein Projektverzeichnis haben, können Sie mit mkdir einen neuen Ordner erstellen und anschließend in diesen wechseln:

mkdir my-project
cd my-project

Nun vom Befehl Garnset Um die Version von Berry festzulegen, verwenden Sie:

yarn set version berry

Dadurch wird die aktuelle, entwickelte Version von Yarn – berry – heruntergeladen und im Verzeichnis .yarn/releases/ Ihres Projekts gespeichert. Außerdem wird eine .yarnrc.yml-Konfigurationsdatei erstellt:

Output
Resolving berry to a url...
Downloading https://github.com/yarnpkg/berry/raw/master/packages/berry-cli/bin/berry.js...
Saving it into /home/sammy/my-project/.yarn/releases/yarn-berry.cjs...
Updating /home/sammy/my-project/.yarnrc.yml...
Done!

Versuchen Sie nun den Befehl yarn --version erneut:

yarn --version

Output
3.0.0

Sie werden sehen, dass die Version 3.0.0 oder höher ist. Dies ist die neueste Version von Yarn.

Ihr Projekt ist nun mit einer projektspezifischen Version von Yarn eingerichtet. Als Nächstes sehen wir uns einige häufig verwendete Yarn-Befehle an, um Ihnen den Einstieg zu erleichtern.

Garn verwenden

Yarn bietet viele Unterbefehle, aber für den Anfang reichen ein paar aus. Schauen wir uns die ersten Unterbefehle an, die Sie verwenden sollten.

Bei der ersten Verwendung eines neuen Tools ist es hilfreich zu lernen, wie man auf dessen Online-Hilfe zugreift. In Yarn können Sie jedem Befehl den Parameter `--help` hinzufügen, um weitere Informationen zu erhalten:

yarn --help

Dies gibt allgemeine Hilfe zum yarn-Befehl aus. Um detailliertere Informationen zu einem Unterbefehl zu erhalten, fügen Sie --help nach dem Unterbefehl hinzu:

yarn install --help

Hier werden Details zur Verwendung des Yarn-Installationsbefehls ausgegeben.

Ein neues YARN-Projekt starten

Wenn Sie ein Projekt von Grund auf neu beginnen, verwenden Sie den Unterbefehl „init“, um die benötigten Yarn-spezifischen Dateien zu erstellen:

yarn init

Dadurch werden eine package.json-Konfigurationsdatei und eine yarn.lock-Datei zu Ihrem Verzeichnis hinzugefügt. Die package.json-Datei enthält die Konfiguration und die Liste der Abhängigkeiten für Ihr Modul. Die yarn.lock-Datei legt diese Abhängigkeiten auf bestimmte Versionen fest und gewährleistet so, dass der Abhängigkeitsbaum stets konsistent ist.

Alle Abhängigkeiten für ein Projekt installieren

Um alle Abhängigkeiten in einem bestehenden Yarn-basierten Projekt herunterzuladen und zu installieren, verwenden Sie den Unterbefehl install:

yarn install

Dadurch werden die Module heruntergeladen und installiert, die Sie für den Einstieg benötigen.

Hinzufügen einer neuen Abhängigkeit zu einem Projekt

Verwenden Sie den Unterbefehl „add“, um dem Projekt neue Abhängigkeiten hinzuzufügen:

yarn add package-name

Dadurch wird das Modul heruntergeladen und installiert sowie Ihre package.json- und yarn.lock-Dateien aktualisiert.

Datei wird aktualisiert .gitignore Für Garn

Yarn speichert Dateien in einem .yarn-Ordner in Ihrem Projektverzeichnis. Einige dieser Dateien sollten in die Versionskontrolle eingecheckt, andere ignoriert werden. Die grundlegende .gitignore-Konfiguration für Yarn sieht wie folgt aus:

.yarn/*
!.yarn/patches
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*

Dadurch wird das gesamte yarn.-Verzeichnis ignoriert und anschließend einige Ausnahmen für wichtige Ordner hinzugefügt, darunter das Verzeichnis releases, das Ihre projektspezifische Version von Yarn enthält.

Weitere Informationen zur Konfiguration von Git und Yarn finden Sie in der offiziellen Yarn-Dokumentation unter .gitignore.

Ergebnis

In diesem Tutorial haben Sie Yarn installiert und einige Yarn-Unterbefehle kennengelernt. Weitere Informationen zur Verwendung von Yarn finden Sie in der offiziellen Yarn-CLI-Dokumentation.