Include node_modules beim Packen von Electron Desktop-App?

Question

Ich probiere eine einfache Hello World Electron App in Linux aus. Ich möchte es verpacken und es unter Windows installieren, um zu testen, ob es dort gut läuft.

Wenn ich 'npm install' gemacht habe, hat es einen Ordner node_modules von ~ 112 MB erstellt. Ich habe noch nichts, das sogar diese Module verwendet, und das Beispiel startet gut, wenn ich diesen Ordner auch lösche. Die package.json Datei hat 'Elektron-prebuilt' als das einzige Element in devDependencies, so nehme ich an, der Knoten node_modules war dafür.

Also mein Zweifel ist, sollte dieser Ordner in das endgültige Paket enthalten sein, wenn ich möchte, dass es unter Windows läuft?

Ich überprüfte die Dokumentation here, aber es hat nur die 3 Dateien und keine Abhängigkeiten, so dass ich nicht sicher war, was in Fällen zu tun, in denen Sie explizit einige haben.

Answer 1

electron-packager ist eine leichtgewichtige Abstraktion, die den Aufbau von Elektron-Anwendungen für jede Plattform ein wenig langweilig macht.

Es wird Ihre Anwendungen durchlaufen und eine ausführbare Datei für jedes der von Ihnen angegebenen Betriebssysteme erstellen. Es wird sich darum kümmern, Ihre Anwendung zu bündeln. Sie müssen sich keine Gedanken darüber machen, dass node_modules im endgültigen Build enthalten sein soll.

Im Allgemeinen wird es nicht empfohlen, auch nur node_modules in Versionskontrolle zu überprüfen.

Answer 2

Kurze Antwort:

Sie tun node_modules Ordner in Ihrer Endausschüttung benötigen, wenn Sie über npm zusätzliche Bibliotheken installieren und sie dann aus dem Code verweisen.

Lange Antwort:

Ich bin nicht sicher, aber Sie sind wahrscheinlich verwirrt, weil Sie electron-prebuilt installiert, die auch ein npm Paket ist, aber dieses ist etwas Besonderes, da sie für die Entwicklung und Verpackung erforderlich ist, und doesn Sie können nicht als einfache Bibliothek für Ihre App dienen. Ich würde empfehlen, eine Zwei-Paket-Struktur für Ihre Anwendung zu verwenden, um Entwicklungs- und Anwendungspakete zu trennen. Hier ist ein Beispiel für eine Ordnerstruktur für meinen Elektron-App (lass es MyApp nennen):

• MeineAnw: Lösung Stammordner für eine einfache Anwendung dieses auf Ihren Repository Stammordner Karte würden

  • gulpfile .js - build configuration, wenn Sie gulp verwenden
  • package.json - dev Paketmetadaten. Dev-Paket ist nicht Ihre Anwendung, sondern eher ein Wrapper drum herum.
  • andere Dateien, wie. Hgignore, README.md, was auch immer.
  • node_modules: alle Entwickler Abhängigkeiten dieser Pakete enthalten, die Sie für die Entwicklung benötigen, wie gulp, electron-prebuilt, Plugins schlucke usw. aus Repo exluded

  • dist: Distributionsordner, das ist, wo meine Aufgaben schluck sollen verpackte App-Verteilung setzen, wenn es zur Produktion geht.ausgeschlossen von Repo

  • Quelle: alle App-Quellen. Jetzt ist dies Ihre Anwendung. Der gesamte Inhalt dieses Ordners wird in eine Distribution gepackt.

    • bower.json - Bower manifestieren, falls Sie verwenden es
    • package.json - App-Paket Metadaten
    • node_modules: alle npm App Abhängigkeiten (wie SQLite, eckig, d3, etc.) ; aus Repo ausgeschlossen
    • bower_modules: alle App Abhängigkeiten Bower von Repo ausgeschlossen
    • app.js - App Einspeisepunkt

Also, wenn ich brauche eine installieren Paket, das mir bei der Entwicklung hilft (normalerweise ein Gulp-Plugin) Ich navigiere zu/MyApp und führe dort npm install -D [package] aus. Wenn ich eine Bibliothek für die Verwendung meiner App installieren muss, z. B. ein Front-End-Framework, navigiere ich zu/MyApp/src und führe dort npm install -S [package] aus.

Wenn ich schnell Elektronen-App in Entwicklung laufen lassen muss füttere ich /MyApp/src Ordner gulp-run-electron Plugin. Alternativ können Sie, wenn Sie electron-prebuilt für Ihr Entwicklungspaket installiert haben, zu /MyApp navigieren und /MyApp/node_modules/electron-prebuilt/dist/electron[.exe] ./src ausführen. Sie können electron-prebuilt auch global mit npm i -g electron-prebuilt installieren und einfach electron ./src ausführen.

Wenn ich meine App für die Veröffentlichung oder Tests packen muss, verwende ich gulp-electron Plugin für Schluck, um eine Verteilung zu erzeugen. Es gibt andere Möglichkeiten, dies zu tun, wie electron-packager oder einen seiner Wrapper für ein Build-System Ihrer Wahl zu verwenden, oder das Ganze manuell zu tun.

Edit: Da Sie über die Größe besorgt sind, wird yeah vorgebaute Elektron selbst ziemlich viel Platz brauchen, aber der Installer kann effektiv mit einigen Archiver, wie 7z geschrumpft werden.