Electron Builder for Visual Studio Code
Build system for Electron Builder.
Installation
Extension Marketplace
Launch Quick Open, paste the following command, and press Enter
ext install electron-builder
Packaged Extension
Download the package extension from the the release page and install it from the command-line:
$ code --install-extension path/to/electron-builder-*.vsix
Alternatively, you can download the packaged extension from the Open VSX Registry or install it using the ovsx command-line tool:
$ ovsx get idleberg.electron-builder
Clone Repository
Change to your Visual Studio Code extensions directory:
# Windows
$ cd %USERPROFILE%\.vscode\extensions
# Linux & macOS
$ cd ~/.vscode/extensions/
Clone repository as electron-builder:
$ git clone https://github.com/idleberg/vscode-electron-builder electron-builder
Usage
Prerequisites
By default, electron-builder is expected to be installed as a local dependency. Alternatively, you can specify the path to electron-builder in your user settings.
Electron Builder expects your project to include the electron module as a devDependency. Likewise, if you want to work with TOML configurations, you need to install the toml module as a devDependency.
Building
You can run the Electron Builder: Build from the command-palette or from the title menu when opening a configuration file. When no such file has been opened, your workspace will be scanned for eligible configurations.
Configuration Precedence:
- extension settings using
--config option
package.json with build fieldelectron-builder.ymlelectron-builder.yamlelectron-builder.jsonelectron-builder.toml (requires toml)electron-builder.js
Options
pathToElectronBuilder
Type: string
Default: ${workspaceFolder}/node_modules/.bin/electron-builder
Path to your electron-builder, defaults to your locally installed dependency
electronBuilderArguments
Type: string[]
Default: []
Custom arguments for electron builder
License
This work is licensed under The MIT License
