electron builder

pembangun elektron

Solusi lengkap untuk mengemas dan membangun elektron distribusi yang siap untuk distribusi, aplikasi asli proton untuk macOS, windows dan linux dengan dukungan "pembaruan otomatis" di luar kotak.

Selalu mencari kontribusi komunitas! ? Menyiapkan lingkungan dev mudah dilakukan?

Sponsor

Catatan, tugas, proyek. Semua di satu tempat.
Gerbang Anda untuk memahami data diabetes Anda	Lisensi Perangkat Lunak dan Distribusi Perangkat Lunak Terbuka dan Sumber
Todesktop: platform all-in-one untuk membangun dan merilis aplikasi elektron	Dashcam: Tangkap langkah -langkah untuk mereproduksi bug apa pun dengan laporan crash video untuk elektron.

Dokumentasi

Lihat dokumentasi lengkap tentang electron.build.

• Manajemen Paket NPM:
  • Kompilasi dependensi aplikasi asli (termasuk dukungan benang).
  • Ketergantungan pembangunan tidak pernah dimasukkan. Anda tidak perlu mengabaikannya secara eksplisit.
  • Dua package.json struktur didukung, tetapi Anda tidak dipaksa untuk menggunakannya bahkan jika Anda memiliki dependensi produksi asli.
• Penandatanganan kode pada server CI atau mesin pengembangan.
• Pembaruan Otomatis Kemasan Aplikasi Siap.
• Banyak format target:
  • Semua platform: 7z , zip , tar.xz , tar.7z , tar.lz , tar.gz , tar.bz2 , dir (Direktori yang Tidak Datang).
  • MacOS: dmg , pkg , mas .
  • Linux: AppImage, Snap, Paket Debian ( deb ), rpm , freebsd , pacman , p5p , apk .
  • Windows: nsis (Penginstal), nsis-web (Penginstal Web), portable (Aplikasi Portabel tanpa Instalasi), APPX (Windows Store), MSI, Squirrel.windows.
• Menerbitkan artefak untuk rilis GitHub, Amazon S3, Digitalocean Spaces dan Bintray.
• Bangunan Tingkat Lanjut:
  • Kemas dalam format yang dapat didistribusikan yang sudah dikemas aplikasi.
  • Terpisah langkah build.
  • Bangun dan publikasikan secara paralel, menggunakan tautan keras di server CI untuk mengurangi penggunaan ruang IO dan disk.
  • Dukungan kompilasi elektron (kompilasi untuk rilis-waktu on the fly on build).
• Gambar Docker Untuk membangun aplikasi elektron untuk Linux atau Windows di platform apa pun.
• Dukungan asli proton.
• Unduh semua file alat yang diperlukan sesuai permintaan secara otomatis (misalnya aplikasi Windows tanda tanda, untuk membuat APPX), tidak perlu diatur.

Pertanyaan	Menjawab
“Saya ingin mengonfigurasi pembangun elektron”	Lihat opsi
“Saya menemukan bug atau saya punya pertanyaan”	Buka masalah
“Saya ingin mendukung pengembangan”	Menyumbangkan

Instalasi

Benang sangat disarankan alih -alih NPM.

yarn add electron-builder --dev

Catatan untuk PNPM

Untuk digunakan dengan pnpm , Anda harus menyesuaikan .npmrc Anda untuk menggunakan salah satu pendekatan berikut agar dependensi Anda dibundel dengan benar (REF: #6389):

 node-linker=hoisted

 public-hoist-pattern=*

 shamefully-hoist=true

CATATAN: Pengaturan dengan memalukan ke true sama dengan mengatur pola publik-hoist ke *.

Catatan untuk benang 3

YARN 3 Gunakan PNP secara default, tetapi elektron-pembangun masih membutuhkan modul simpul (REF: YARNPKG/Berry#4804). Tambahkan konfigurasi di .yarnrc.yaml sebagai berikut:

 nodeLinker: "node-modules"

akan mendeklarasikan untuk menggunakan modul simpul alih-alih PNP.

Panduan Pengaturan Cepat

Electron-Webpack-cepat-cepat adalah cara yang disarankan untuk membuat aplikasi elektron baru. Lihat Boilerplate.

1. Tentukan bidang standar dalam package.json aplikasi.json - nama, description , version dan penulis.

2. Tentukan konfigurasi build di package.json sebagai berikut:

    "build" : {
     "appId" : " your.id " ,
     "mac" : {
       "category" : " your.app.category.type "
     }
   }

   Lihat semua opsi. File opsi untuk menunjukkan file mana yang harus dikemas dalam aplikasi akhir, termasuk file entri, mungkin diperlukan. Anda juga dapat menggunakan file konfigurasi terpisah, seperti js , ts , yml , dan json / json5 . Lihat File-Config-File untuk ekstensi yang didukung. Contoh JS untuk API terprogram

3. Tambahkan ikon.

4. Tambahkan kunci skrip ke package.json pengembangan.json:

    "scripts" : {
     "app:dir" : " electron-builder --dir " ,
     "app:dist" : " electron-builder "
   }

   Kemudian Anda dapat menjalankan yarn app:dist (untuk mengemas dalam format yang dapat didistribusikan (misalnya DMG, pemasang Windows, paket DEB)) atau yarn app:dir (hanya menghasilkan direktori paket tanpa benar -benar mengemasnya. Ini berguna untuk tujuan pengujian).

   Untuk memastikan dependensi asli Anda selalu cocok dengan versi elektron, cukup tambahkan skrip "postinstall": "electron-builder install-app-deps" ke package.json Anda.json.

5. Jika Anda memiliki addons asli Anda sendiri yang merupakan bagian dari aplikasi (bukan sebagai ketergantungan), atur nodegyprebuild ke true .

Harap dicatat bahwa semuanya dikemas ke dalam arsip Asar secara default.

Untuk aplikasi yang akan dikirim ke produksi, Anda harus menandatangani aplikasi Anda. Lihat di mana membeli sertifikat penandatanganan kode.

Penggunaan terprogram

Lihat node_modules/electron-builder/out/index.d.ts . Typing untuk TypeScript disediakan dan juga dapat ditemukan di sini.

Cuplikan kode yang disediakan di bawah ini juga ditampilkan "beraksi" di sini juga.

 "use strict"

const builder = require ( "electron-builder" )
const Platform = builder . Platform

// Promise is returned
builder . build ( {
  targets : Platform . MAC . createTarget ( ) ,
  config : {
   "//" : "build options, see https://goo.gl/QQXmcV"
  }
} )
  . then ( ( ) => {
    // handle result
  } )
  . catch ( ( error ) => {
    // handle error
  } ) 

Pelat boiler

• Electron-Webpack-cepat-cepat-Struktur proyek minimum untuk mulai berkembang dengan elektron-webpack. Direkomendasikan.
• Electron-react-boilerplate Boilerplate untuk aplikasi desktop lintas platform yang dapat diskalakan.
• Elektron-reakt-redux-boilerplate boilerplate minimal untuk memulai dengan elektron, bereaksi dan redux.
• Elektron-boilerplate aplikasi boilerplate minimalis namun komprehensif.
• Plugin Vue CLI 3 untuk elektron plugin Vue CLI 3 untuk elektron tanpa konfigurasi yang diperlukan.
• elektron-vue-vite elektron sederhana + vue3 + vite5 boilerplate.
• Vite-electron-Builder Secure Boilerplate untuk aplikasi elektron berdasarkan vite. Mendukung banyak kerangka kerja.

Debug

Atur variabel lingkungan DEBUG untuk men-debug apa yang dilakukan elektron-pembangun:

DEBUG=electron-builder

FPM_DEBUG Env untuk menambahkan detail lebih lanjut tentang membangun target Linux (kecuali Snap dan AppImage).

DEBUG_DMG=true env var untuk menambahkan lebih banyak debugging/verbositas dari hdiutil (macOS).

!!! Tip "CMD" pada Windows Variabel lingkungan diatur menggunakan perintah set. bash set DEBUG=electron-builder

!!! Tip "PowerShell" PowerShell menggunakan sintaks yang berbeda untuk mengatur variabel lingkungan. bash $env:DEBUG=electron-builder

Menyumbangkan

Kami melakukan pekerjaan open source ini di waktu luang kami. Jika Anda ingin kami menginvestasikan lebih banyak waktu, silakan donasi.