Paketbaurichtlinien für Node.js

Um ein Paket zu erstellen, das ein Node.js-Modul ist, Node.js-Module bündelt oder verwendet oder Node.js zum Erstellen oder Testen benötigt, benötigen Sie Folgendes:

Die folgenden Makros sind für Sie definiert:

Diese Makros werden vom Paket nodejs-packaging bereitgestellt.

Während %install oder beim Auflisten von %files können Sie mit dem Makro %nodejs_sitelib oder %nodejs_sitearch angeben, wo die installierten Module zu finden sind. Zum Beispiel:

Durch die Verwendung dieses Makros anstelle der Angabe des Verzeichnisses in der Spec-Datei wird sichergestellt, dass Ihre Spec-Datei zur installierten Node.js-Version kompatibel bleibt, selbst wenn sich die Verzeichnisstruktur radikal ändert (zum Beispiel, wenn %nodejs_sitelib nach %{_datadir} verschoben wird).

Die von Node.js verwendete V8-JavaScript-Laufzeitumgebung nutzt einen Just-in-Time-Compiler (JIT), der speziell auf die jeweilige Architektur abgestimmt ist und manuell auf neue Architekturen portiert werden muss, die ihn unterstützen sollen. Node.js-Pakete müssen daher eine ExclusiveArch-Zeile enthalten, die sie auf diese Architekturen beschränkt.

Das Makro %{nodejs_arches} vereinfacht dies, daher müssen reine JavaScript-Pakete Folgendes verwenden:

Native (binäre) Pakete müssen noarch weglassen und stattdessen nur %{nodejs_arches} oder gegebenenfalls die Architekturen auflisten.

Die Lizenzen der gebündelten Node.js-Module müssen in der Spec-Datei enthalten sein. Wenn Sie unser Bundling-Skript verwenden, finden Sie sie in <Paket>-<Version>-bundled-licenses.txt. Es wird empfohlen, <Paket>-<Version>-bundled-licenses.txt in das RPM-Paket aufzunehmen.

Bei jeder Aktualisierung Ihres Pakets müssen Sie die enthaltenen Lizenzen anhand der Fedora-Softwarelizenzliste überprüfen. Beachten Sie, dass auch vorkompiliertes/minimiertes JavaScript enthalten sein kann; die Lizenzprüfung ist jedoch auch hierfür erforderlich (siehe JavaScript-Richtlinien).

Führen Sie alle eindeutigen Lizenzen in der Zeile „License:“ Ihrer Spec-Datei auf. Trennen Sie die einzelnen Lizenzen durch das Wort „and“.

Bei weiteren Fragen lesen Sie die Fedora Lizenzierungsrichtlinien.

Die gängigste Methode zum Ausliefern der meisten Node-Module ist das Herunterladen von Tarballs aus der npm-Registry. Die Source0-Adresse solcher Module sollte folgendes Format haben: https://registry.npmjs.org/<Modulname>/-/<Modulname>-<Version>.tgz. Zum Beispiel:

Diese Methode sollte der Verwendung von Git-Checkouts oder automatisch von GitHub generierten Tarballs vorgezogen werden.

Diese Tarballs speichern den Inhalt des Moduls in einem package-Verzeichnis. Daher sollte jedes Paket, das diese Tarballs verwendet, Folgendes in %prep verwenden:

Für die Bündelung von Node-Modulabhängigkeiten empfiehlt sich die Verwendung von Tarballs. Diese Tarballs sollten unabhängig vom Hauptpaketquellcode sein. Es sollten zwei Tarballs vorhanden sein: einer für das Binärpaket zur Laufzeit und einer für Tests während des Paketbaus. Dadurch wird ein kleineres Installationspaket erzeugt.

Diese Tarballs speichern die gebündelten Module namens node_modules_prod und node_modules_dev in einem Verzeichnis.

Falls Ihre Pakete keinen der Tarballs benötigen, passen Sie diese Anweisungen entsprechend an. Falls sie den Produktions-Tarball nicht benötigen, entfernen Sie Source1 sowie die Abschnitte %build und %install. Falls sie den Entwicklungs-Tarball nicht benötigen, entfernen Sie Source2 und den Abschnitt %check.

Hinweis 1: Die Einrichtung der Produktions- und Entwicklungs-Tarballs wird demnächst über ein Makro erfolgen. Zum jetzigen Zeitpunkt ist dies noch nicht der Fall.

Hinweis 2: Der Tarball mit den Entwicklungsabhängigkeiten muss in %check und nicht in %prep entpackt werden, um zu vermeiden, dass versehentlich die nicht paketierten Abhängigkeiten mitgebündelt werden, die nur zum Testen benötigt werden.

Die meisten Node-Module verfügen nicht über einen eigenen Installationsmechanismus. Stattdessen nutzen sie npm für die Installation. npm darf nicht zur Installation von Modulen in Fedora-Paketen verwendet werden, da hierfür üblicherweise ein Netzwerkzugriff erforderlich ist.

Installieren Sie die Dateien stattdessen manuell am richtigen Ort mit install oder cp. Die meisten Dateien sollten in %{nodejs_sitelib}/ installiert werden, die Dokumentation hingegen über %doc. Falls das Modul architekturunabhängige Inhalte außer JavaScript-Code enthält, sollten diese in %{_datadir} installiert und das Modul entsprechend angepasst werden.

Das nodejs-Paket enthält einen automatischen Generator für Requires und Provides, der automatisch versionierte Abhängigkeiten basierend auf den Informationen in der package.json-Datei eines Moduls und der gebündelten Abhängigkeiten hinzufügt. Zusätzliche Requires werden nativen (binären) Modulen hinzugefügt, um ABI-Brüche in Node oder der V8-JavaScript-Laufzeitumgebung zu verhindern. Zusätzlich wird für e eine Zeile „Provides: bundled()“ hinzugefügt.

Nur für nicht-gebündelte Module.

Node.js und npm erfordern, dass Abhängigkeiten explizit in ein node_modules-Verzeichnis innerhalb des Modulverzeichnisses eingebunden oder verlinkt werden. Um dies zu vereinfachen, stellt das Makro %nodejs_symlink_deps bereit, das automatisch einen node_modules-Baum mit symbolischen Links für jede in der package.json aufgeführte Abhängigkeit erstellt. Dieses Makro sollte im %install-Abschnitt jedes Node.js-Modulpakets aufgerufen werden.

Die meisten nativen Module verwenden das Werkzeug`node-gyp` für die Erstellung. Dieses Werkzeug konfiguriert und verwendet das Build-Framework gyp, um Add-on-Module zu erstellen, die mit Node.js und dem von diesem verwendeten V8 JavaScript-Interpreter interagieren können.

Das Build-Framework WAF wurde vom Upstream-Projekt aufgegeben und wird in Fedora nicht unterstützt.

Alle Spec-Dateien für Node.js-Module müssen einen %check-Abschnitt mit (mindestens) folgender Zeile enthalten:

Dieser Test stellt sicher, dass das Modul tatsächlich geladen werden kann, wodurch Situationen vermieden werden, in denen eine neue Upstream-Version eine neue Abhängigkeit hinzugefügt hat, ohne dass der Paketierer dies bemerkt.

Alle weiteren vom Upstream-Projekt bereitgestellten Tests sollten nach Möglichkeit ebenfalls ausgeführt werden.

Zur Vereinfachung akzeptiert %nodejs_symlink_deps auch das Argument --check, wodurch es im aktuellen Arbeitsverzeichnis anstatt im Buildroot ausgeführt wird. Sie können dies im Abschnitt %check verwenden, um Abhängigkeiten für die Ausführung von Tests verfügbar zu machen. Bei Verwendung dieses Arguments werden auch die Entwicklungsabhängigkeiten, die im Schlüssel "devDependencies" in der Datei package.json aufgeführt sind, verlinkt.

Es wird empfohlen, das im Fedora-Paket nodejs-packaging-bundler enthaltene Skript nodejs-packaging-bundler zu verwenden. Weitere Informationen dazu finden Sie unter Fedora nodejs-packaging repo.