electron builder

Электронный строитель

Полное решение для упаковки и создания готового к распределительному электрону, Proton Native App для MacOS, Windows и Linux с поддержкой «Auto Update» из коробки.

Всегда ищу вклад сообщества! ? Настройка среды разработки легко сделать?

Спонсоры

Примечания, задачи, проекты. Все в одном месте.
Ваш шлюз для понимания данных о диабете	Открытый, доступный источник лицензирование программного обеспечения и API дистрибуции
Todesktop: все в одном платформу для создания и выпуска электронных приложений	Dashcam: Захватите шаги, чтобы воспроизвести любую ошибку с помощью отчетов о сбое видео для Electron.

Документация

Смотрите полную документацию на Electron.build.

• Управление пакетами NPM:
  • Компиляция нативных приложений зависимостей (включая поддержку пряжи).
  • Зависимости развития никогда не включены. Вам не нужно явно игнорировать их.
  • Два структура Package.json поддерживается, но вы не вынуждены использовать его, даже если у вас есть нативные производственные зависимости.
• Подписание кода на CI -сервере или машине разработки.
• Автоматическое обновление, готовая упаковка приложений.
• Многочисленные целевые форматы:
  • Все платформы: 7z , zip , tar.xz , tar.7z , tar.lz , tar.gz , tar.bz2 , dir (непакованный каталог).
  • MacOS: dmg , pkg , mas .
  • Linux: Appimage, Snap, Debian Package ( deb ), rpm , freebsd , pacman , p5p , apk .
  • Windows: nsis (установщик), nsis-web (веб-установщик), portable (портативное приложение без установки), Appx (Windows Store), MSI, Squirrel.Windows.
• Публикация артефактов для выпусков GitHub, Amazon S3, Digitalocean Spaces и Bintray.
• Усовершенствованное здание:
  • Упаковать в распределяемом формате, уже упакованном приложении.
  • Отдельные шаги сборки.
  • Создайте и публикуйте параллельно, используя жесткие ссылки на CI -сервере, чтобы уменьшить использование места ввода и дискового пространства.
  • Опощи из электрон-компиляции (компиляция для времени выпуска на лету на сборке).
• Docker Images для создания электронного приложения для Linux или Windows на любой платформе.
• Поддержка Proton Native.
• Загрузка всех необходимых инструментов файлов по требованию автоматически (например, к приложению Windows кода, чтобы сделать Appx), не нужно настройка.

Вопрос	Отвечать
«Я хочу настроить электрон-строитель»	Смотрите варианты
«Я нашел ошибку или у меня есть вопрос»	Откройте проблему
«Я хочу поддерживать разработку»	Пожертвовать

Установка

Пряжа настоятельно рекомендуется вместо NPM.

yarn add electron-builder --dev

Примечание для PNPM

Чтобы использовать с pnpm , вам нужно изменить свой .npmrc , чтобы использовать любые следующие подходы, чтобы ваши зависимости были правильно связаны (Ссылка: #6389):

 node-linker=hoisted

 public-hoist-pattern=*

 shamefully-hoist=true

Примечание. Установка позорного хода для True-это то же самое, что установить общедоступный паттерн для *.

Примечание для пряжи 3

Пряжа 3 Используйте PNP по умолчанию, но электрон-строитель все еще нуждаются в модулях узлов (ссылка: yarnpkg/berry#4804). Добавьте конфигурацию в .yarnrc.yaml следующим образом:

 nodeLinker: "node-modules"

будет объявлять использование узлов-модулей вместо PNP.

Руководство по быстрой настройке

Electron-Webpack-Quick-Start-это рекомендуемый способ создать новое электронное приложение. Смотрите швабры.

1. Укажите version поля в package.json приложения description

2. Укажите конфигурацию сборки в package.json следующим образом:

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

   Смотрите все варианты. Файлы опции, чтобы указать, какие файлы должны быть упакованы в окончательном приложении, включая файл входа, возможно, требуется. Вы также можете использовать отдельные файлы конфигурации, такие как js , ts , yml и json / json5 . См. Read-Config-файл для подтвержденных расширений. Пример JS для программного API

3. Добавить значки.

4. Добавьте ключ сценариев в Development package.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. Рекомендуется.
• Электроно-реакционная пластинка парикмахерская для масштабируемых кроссплатформенных настольных приложений.
• Электронно-реакционная реконструкция Boilerplate Минимальная шаблон для начала с электроном, React и Redux.
• Electron-Boilerplate Минималистичное, но всеобъемлющее применение шаблон.
• Vue Cli 3 плагин для электрона A Vue Cli 3 плагин для электрона без необходимой конфигурации.
• Электрон-Vue-vite-настоящий простой электрон + vue3 + vite5 boilerplate.
• VITE-Electron-Builder Secure Cowerplate для электронного приложения на основе 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

!!! Tip "PowerShell" PowerShell использует разные синтаксисы для установки переменных среды. bash $env:DEBUG=electron-builder

Пожертвовать

Мы делаем эту работу с открытым исходным кодом в свободное время. Если вы хотите, чтобы мы потратили на это больше времени, пожалуйста, пожертвуйте.