electron builder

ผู้สร้างอิเล็กตรอน

โซลูชันที่สมบูรณ์ในการบรรจุและสร้างอิเล็กทรอนิกส์ที่พร้อมสำหรับการกระจายแอพ Proton Native สำหรับ MacOS, Windows และ Linux ด้วยการสนับสนุน“ Auto Update” นอกกรอบ

มองหาการมีส่วนร่วมของชุมชนเสมอ! - การตั้งค่าสภาพแวดล้อม dev นั้นง่ายต่อการทำ?

ผู้สนับสนุน

หมายเหตุงานโครงการ ทั้งหมดอยู่ในที่เดียว
เกตเวย์ของคุณเพื่อทำความเข้าใจข้อมูลโรคเบาหวานของคุณ	สิทธิ์ใช้งานซอฟต์แวร์ที่เปิดกว้างและเปิดใช้งาน API
Todesktop: แพลตฟอร์ม all-in-one สำหรับการสร้างและปล่อยแอพอิเล็กตรอน	Dashcam: จับขั้นตอนในการทำซ้ำข้อผิดพลาดใด ๆ ด้วยรายงานความผิดพลาดวิดีโอสำหรับอิเล็กตรอน

เอกสาร

ดูเอกสารฉบับเต็มเกี่ยวกับอิเล็กตรอน Build

• การจัดการแพ็คเกจ NPM:
  • การรวบรวมการพึ่งพาแอปพลิเคชันดั้งเดิม (รวมถึงการสนับสนุนเส้นด้าย)
  • การพึ่งพาการพัฒนาจะไม่รวม คุณไม่จำเป็นต้องเพิกเฉยต่อพวกเขาอย่างชัดเจน
  • รองรับสองแพ็คเกจ JSON ได้รับการสนับสนุน แต่คุณไม่ได้ถูกบังคับให้ใช้แม้ว่าคุณจะมีการพึ่งพาการผลิตแบบดั้งเดิมก็ตาม
• การลงนามในรหัสบนเซิร์ฟเวอร์ CI หรือเครื่องพัฒนา
• อัปเดตอัตโนมัติบรรจุภัณฑ์แอปพลิเคชัน
• รูปแบบเป้าหมายมากมาย:
  • แพลตฟอร์มทั้งหมด: 7z , zip , tar.xz , tar.7z , tar.lz , tar.gz , tar.bz2 , dir (ไดเรกทอรีที่ไม่ได้บรรจุ)
  • MacOS: dmg , pkg , mas
  • Linux: Appimage, Snap, แพ็คเกจ Debian ( deb ), rpm , freebsd , pacman , p5p , apk
  • Windows: nsis (Installer), nsis-web (Web Installer), portable (แอพพกพาโดยไม่ต้องติดตั้ง), Appx (Windows Store), MSI, Squirrel.Windows
• การเผยแพร่สิ่งประดิษฐ์ไปยัง GitHub Rease, Amazon S3, พื้นที่ดิจิตอลและ Bintray
• อาคารขั้นสูง:
  • แพ็คในรูปแบบที่แจกจ่ายได้แอพแพ็คแล้ว
  • แยกขั้นตอนการสร้าง
  • สร้างและเผยแพร่ในแบบคู่ขนานโดยใช้การเชื่อมโยงอย่างหนักบนเซิร์ฟเวอร์ CI เพื่อลดการใช้พื้นที่ IO และดิสก์
  • การรองรับแบบคอมไพล์อิเล็กตรอน (คอมไพล์สำหรับเวลาวางจำหน่ายในการสร้างบิวด์)
• Docker Images เพื่อสร้างแอพอิเล็กตรอนสำหรับ Linux หรือ Windows บนแพลตฟอร์มใด ๆ
• การสนับสนุนพื้นเมืองของโปรตอน
• ดาวน์โหลดไฟล์เครื่องมือที่จำเป็นทั้งหมดตามความต้องการโดยอัตโนมัติ (เช่นไปยังรหัสแอปพลิเคชัน Sign Sign Windows เพื่อสร้าง APPX) ไม่จำเป็นต้องติดตั้ง

คำถาม	คำตอบ
“ ฉันต้องการกำหนดค่าอิเล็กตรอนผู้สร้าง”	ดูตัวเลือก
“ ฉันพบข้อผิดพลาดหรือมีคำถาม”	เปิดปัญหา
“ ฉันต้องการสนับสนุนการพัฒนา”	บริจาค

การติดตั้ง

แนะนำให้ใช้เส้นด้ายแทน NPM

yarn add electron-builder --dev

หมายเหตุสำหรับ PNPM

ในการใช้กับ pnpm คุณจะต้องปรับ .npmrc ของคุณเพื่อใช้วิธีการใด ๆ ต่อไปนี้เพื่อให้การพึ่งพาของคุณได้รับการรวมอย่างถูกต้อง (อ้างอิง: #6389):

 node-linker=hoisted

 public-hoist-pattern=*

 shamefully-hoist=true

หมายเหตุ: การตั้งค่าความน่าอับอายของความจริงเป็นเช่นเดียวกับการตั้งค่ารูปแบบสาธารณะที่เป็น *

หมายเหตุสำหรับเส้นด้าย 3

เส้นด้าย 3 ใช้ PNP โดยค่าเริ่มต้น แต่อิเล็กตรอนผู้สร้างยังคงต้องการโหมดโหนด (REF: yarnpkg/berry#4804) เพิ่มการกำหนดค่าใน .yarnrc.yaml ดังนี้:

 nodeLinker: "node-modules"

จะประกาศว่าจะใช้โหมดโหนดแทน PNP

คู่มือการตั้งค่าด่วน

Electron-Webpack-Quick-Start เป็นวิธีที่แนะนำในการสร้างแอพพลิเคชั่นอิเล็กตรอนใหม่ ดูหม้อต้ม

1. ระบุฟิลด์มาตรฐานใน package.json แอปพลิเคชัน json - ชื่อ, description , version และผู้แต่ง

2. ระบุการกำหนดค่าการสร้างใน package.json ดังต่อไปนี้:

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

   ดูตัวเลือกทั้งหมด ไฟล์ตัวเลือกเพื่อระบุไฟล์ที่ควรบรรจุในแอปพลิเคชันสุดท้ายรวมถึงไฟล์รายการอาจจำเป็น นอกจากนี้คุณยังสามารถใช้ไฟล์การกำหนดค่าแยกต่างหากเช่น js , ts , yml และ json / json5 ดูที่ Read-config-file สำหรับส่วนขยายที่รองรับ ตัวอย่าง JS สำหรับโปรแกรม API โปรแกรม

3. เพิ่มไอคอน

4. เพิ่มคีย์สคริปต์ลงใน package.json การพัฒนา json:

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

   จากนั้นคุณสามารถเรียกใช้ yarn app:dist (เพื่อจัดทำแพ็คเกจในรูปแบบที่กระจายได้ (เช่น DMG, Windows Installer, DEB Package)) หรือ yarn app:dir (สร้างไดเรกทอรีแพ็คเกจโดยไม่ต้องบรรจุภัณฑ์จริงๆสิ่งนี้มีประโยชน์สำหรับการทดสอบ)

   เพื่อให้แน่ใจว่าการพึ่งพาดั้งเดิมของคุณจะถูกจับคู่กับรุ่นอิเล็กตรอนเสมอเพียงเพิ่มสคริปต์ "postinstall": "electron-builder install-app-deps" ลงใน package.json ของคุณ

5. หากคุณมีส่วนเสริมดั้งเดิมของคุณเองที่เป็นส่วนหนึ่งของแอปพลิเคชัน (ไม่ใช่การพึ่งพา) ให้ตั้ง nodegyprebuild เป็น true

โปรดทราบว่าทุกอย่างถูกบรรจุไว้ในคลังเก็บ ASAR โดยค่าเริ่มต้น

สำหรับแอพที่จะส่งไปยังการผลิตคุณควรเซ็นชื่อแอปพลิเคชันของคุณ ดูว่าจะซื้อใบรับรองการลงนามรหัสได้ที่ไหน

การใช้โปรแกรม

ดู node_modules/electron-builder/out/index.d.ts มีการพิมพ์ typescript และยังสามารถพบได้ที่นี่

ตัวอย่างโค้ดที่ให้ไว้ด้านล่างจะแสดง "ในการดำเนินการ" ที่นี่เช่นกัน

 "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
  } ) 

หม้อต้มน้ำ

• Electron-Webpack-Quick-Start-โครงสร้างโครงการขั้นต่ำที่เปลือยเปล่าเพื่อเริ่มต้นพัฒนาด้วยอิเล็กตรอน-Webpack ที่แนะนำ.
• อิเล็กตรอนรีแอคทิก-หม้ออิเล็กทรอนิกส์ A Boilerplate สำหรับแอพเดสก์ท็อปข้ามแพลตฟอร์มที่ปรับขนาดได้
• อิเล็กตรอนรีอะค์-เรดซ์-หม้ออิเล็กทรอนิกส์แผ่นหม้อไอน้ำน้อยที่สุดในการเริ่มต้นด้วยอิเล็กตรอนปฏิกิริยาและ redux
• อิเล็กตรอน-เครื่องต้มเพลทแอปพลิเคชั่นหม้อต้มแบบเรียบง่าย แต่ครอบคลุม
• ปลั๊กอิน Vue CLI 3 สำหรับอิเล็กตรอน A Vue CLI 3 ปลั๊กอินสำหรับอิเล็กตรอนโดยไม่ต้องกำหนดค่า
• อิเล็กตรอน-ช่องทางอิเล็กตรอนที่เรียบง่าย + Vue3 + Vite5 Boilerplate
• Vite-Electron-Builder Secure Boilerplate สำหรับแอพอิเล็กตรอนตาม Vite รองรับหลายเฟรมเวิร์ก

การดีบัก

ตั้งค่าตัวแปรสภาพแวดล้อม DEBUG ให้ดีบักสิ่งที่อิเล็กตรอนผู้สร้างกำลังทำอยู่:

DEBUG=electron-builder

FPM_DEBUG Env เพื่อเพิ่มรายละเอียดเพิ่มเติมเกี่ยวกับการสร้างเป้าหมาย Linux (ยกเว้น SNAP และ AppImage)

DEBUG_DMG=true env var เพื่อเพิ่มการดีบักเพิ่มเติม/คำสั่งจาก hdiutil (macOS)

- เคล็ดลับ "CMD" บน Windows ตัวแปรสภาพแวดล้อมถูกตั้งค่าโดยใช้คำสั่ง SET bash set DEBUG=electron-builder

- เคล็ดลับ "PowerShell" PowerShell ใช้ไวยากรณ์ที่แตกต่างกันเพื่อตั้งค่าตัวแปรสภาพแวดล้อม bash $env:DEBUG=electron-builder

บริจาค

เราทำงานโอเพ่นซอร์สนี้ในเวลาว่างของเรา หากคุณต้องการให้เราลงทุนเวลามากขึ้นโปรดบริจาค