electron builder

construtor de elétrons

Uma solução completa para empacotar e construir um Electron Ready for Distribution, App Proton Native para MacOS, Windows e Linux com suporte para "Atualização automática" pronta para uso.

Sempre procurando contribuições da comunidade! ? Configurar um ambiente de desenvolvimento é fácil de fazer?

Patrocinadores

Notas, tarefas, projetos. Tudo em um único lugar.
Sua porta de entrada para entender seus dados de diabetes	Uma API de licenciamento e distribuição de software aberta e disponível
Todesktop: uma plataforma all-in-one para criar e liberar aplicativos de elétrons	DASHCAM: Capture as etapas para reproduzir qualquer bug com relatórios de acidente de vídeo para elétron.

Documentação

Veja a documentação completa sobre o Electron.Build.

• Gerenciamento de pacotes NPM:
  • Compilação de dependências de aplicativos nativos (incluindo suporte de fios).
  • As dependências de desenvolvimento nunca são incluídas. Você não precisa ignorá -los explicitamente.
  • A estrutura de dois package.json é suportada, mas você não é forçado a usá -lo, mesmo se tiver dependências de produção nativas.
• Assinatura de código em um servidor de CI ou máquina de desenvolvimento.
• Atualização automática Pacote de aplicativos pronto.
• Numerosos formatos de destino:
  • Todas as plataformas: 7z , zip , tar.xz , tar.7z , tar.lz , tar.gz , tar.bz2 , dir (diretório não embalado).
  • MacOS: dmg , pkg , mas .
  • Linux: Appimage, Snap, Debian Package ( deb ), rpm , freebsd , pacman , p5p , apk .
  • Windows: nsis (instalador), nsis-web (instalador da web), portable (aplicativo portátil sem instalação), APPX (Windows Store), MSI, Squirrel.Windows.
• Publicando artefatos para lançamentos do GitHub, Amazon S3, Digitalocean Spaces e Bintray.
• Edifício avançado:
  • Pacote em um formato distribuível já embalado.
  • Etapas de construção separadas.
  • Crie e publique em paralelo, usando links rígidos no servidor CI para reduzir o uso de IO e espaço em disco.
  • Suporte de elétrons-compilos (compile para tempo de lançamento em tempo de exposição).
• Imagens do Docker para criar aplicativos Electron para Linux ou Windows em qualquer plataforma.
• Suporte nativo de prótons.
• Download todos os arquivos de ferramentas necessários sob demanda automaticamente (por exemplo, para assinar o aplicativo do Windows, para fazer o APPX), não é necessário configurar.

Pergunta	Responder
“Eu quero configurar o construtor de elétrons”	Veja as opções
“Eu encontrei um bug ou tenho uma pergunta”	Abra um problema
“Eu quero apoiar o desenvolvimento”	Doar

Instalação

O fio é fortemente recomendado em vez de NPM.

yarn add electron-builder --dev

Nota para PNPM

Para usar com pnpm , você precisará ajustar seu .npmrc para usar qualquer pessoa, as seguintes abordagens para que suas dependências sejam agrupadas corretamente (Ref: #6389):

 node-linker=hoisted

 public-hoist-pattern=*

 shamefully-hoist=true

NOTA: Definir vergonhosamente-hoist como TRUE é o mesmo que definir o padrão público-pau para *.

Nota para o fio 3

O YARN 3 usa PNP por padrão, mas o construtor de elétrons ainda precisa de módulos de nó (Ref: YARNPKG/Berry#4804). Adicione a configuração no .yarnrc.yaml da seguinte forma:

 nodeLinker: "node-modules"

declarará usar módulos de nó em vez de PNP.

Guia de configuração rápida

Electron-Webpack-Quick-Start é uma maneira recomendada de criar um novo aplicativo de elétrons. Veja plantões de caldeira.

1. Especifique os campos padrão no Application package.json - nome, description , version e autor.

2. Especifique a configuração de compilação no package.json da seguinte forma:

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

   Veja todas as opções. Arquivos de opção para indicar quais arquivos devem ser embalados no aplicativo final, incluindo o arquivo de entrada, talvez necessário. Você também pode usar arquivos de configuração separados, como js , ts , yml e json / json5 . Consulte o arquivo de leitura-config para extensões suportadas. Exemplo JS para API programática

3. Adicione ícones.

4. Adicione a chave dos scripts ao package.json de desenvolvimento.json:

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

   Em seguida, você pode executar yarn app:dist (para embalar em um formato distribuível (por exemplo, DMG, Windows Installer, Package Deb)) ou yarn app:dir (gera apenas o diretório de pacotes sem realmente embalá -lo. Isso é útil para fins de teste).

   Para garantir que suas dependências nativas sejam sempre a versão eletrônica correspondente, basta adicionar o script "postinstall": "electron-builder install-app-deps" ao seu package.json .

5. Se você possui addons nativos que fazem parte do aplicativo (não como uma dependência), defina o NodeGyPrebuild como true .

Observe que tudo está embalado em um arquivo ASAR por padrão.

Para um aplicativo que será enviado para a produção, você deve assinar seu aplicativo. Veja onde comprar certificados de assinatura de código.

Uso programático

Consulte node_modules/electron-builder/out/index.d.ts . As típicas do TypeScript são fornecidas e também podem ser encontradas aqui.

O snippet de código fornecido abaixo também é mostrado "em ação" aqui também.

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

Boilerplates

• Electron-Webpack-Quick-Start-Uma estrutura de projeto mínima nua para começar a se desenvolver com o Electron-Webpack. Recomendado.
• REACT-REACT-BOILERPLACE Um placa de caldeira para aplicativos de desktop escaláveis ​​de plataforma cruzada.
• REACT-RECT-REDUX-BOILERLATE Um placa mínima para começar com elétron, reação e redux.
• Placa-eletron um aplicativo de caldeira minimalista, mas abrangente.
• VUE CLI 3 Plugin para elétron A VUE CLI 3 Plugin Para elétron, sem configuração necessária.
• Electron-vue-vite Um elétron simples + vite3 + vite5 caldeira.
• Vite-Electron-Builder Secure Boilerplate para aplicativo Electron com base no Vite. Suporta várias estruturas.

Depurar

Defina a variável de ambiente DEBUG para depurar o que o Builder de Eletrón está fazendo:

DEBUG=electron-builder

FPM_DEBUG ENV para adicionar mais detalhes sobre a criação de alvos Linux (exceto Snap e Appimage).

DEBUG_DMG=true Env var para adicionar mais depuração/verbosidade de hdiutil (macOS).

!!! Dica "CMD" no Windows A variável de ambiente é definida usando o comando set. bash set DEBUG=electron-builder

!!! A TIP "PowerShell" PowerShell usa sintaxe diferente para definir variáveis ​​de ambiente. bash $env:DEBUG=electron-builder

Doar

Fazemos esse trabalho de código aberto em nosso tempo livre. Se você quiser investir mais tempo, doe.