Grunt-electron-windows-installer NPM

grunt-electron-windows-installer

Create a Windows package for your Electron app.

🚨 This package has been renamed to grunt-electron-installer-windows! 🚨

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-electron-windows-installer --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-electron-windows-installer');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.

Installer task

Run this task with the grunt electron-windows-installer command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Usage

Say your app lives in path/to/app, and has a structure like this:

$ tree path/to/app/ -L 2
path/to/app/
├── LICENSE
├── index.js
├── main
│   ├── index.js
│   └── squirrel.js
├── node_modules
│   ├── fs-plus
│   └── yargs
├── package.json
└── renderer
    ├── index.css
    ├── index.html
    └── index.js

To create a package from your app, the configuration for your task would look like this:

'electron-windows-installer': {
  app: {
    src: 'path/to/app/',
    dest: 'path/to/out/'
  }
}

The task will try to extract all necessary information from your package.json. When it finishes, you'll have these:

$ ls path\to\out
RELEASES  app-0.0.1-full.nupkg  Setup.exe

You can also create different packages for different architectures, while manually overriding certain options:

'electron-windows-installer': {
  options: {
    productName: 'Foo',
    productDescription: 'Bar baz qux.',
    rename: function (dest, src) {
      if (/\.exe$/.test(src)) {
        src = '<%= name %>-<%= version %>-setup.exe';
      }
      return dest + src;
    }
  },

  win32: {
    src: 'path/to/win32/',
    dest: 'path/to/out/win32/'
  },

  win64: {
    src: 'path/to/win64/',
    dest: 'path/to/out/win64/'
  }
}

Options

src

Type: String Default: undefined

Path to the folder that contains your built Electron application.

dest

Type: String Default: undefined

Path to the folder that will contain your Windows installer.

options.name

Type: String Default: package.name

Name of the package (e.g. atom), used in the id field of the nuspec file.

options.productName

Type: String Default: package.productName || package.name

Name of the application (e.g. Atom), used in the title field of the nuspec file.

options.description

Type: String Default: package.description

Short description of the application, used in the summary field of the nuspec file.

options.productDescription

Type: String Default: package.productDescription || package.description

Long description of the application, used in the description field of the nuspec file.

options.version

Type: String Default: package.version

Long description of the application, used in the version field of the nuspec file.

options.copyright

Type: String Default: package.copyright

options.authors

Type: Array[String] Default: package.author

List of authors of the package, used in the authors field of the spec file.

options.owners

Type: Array[String] Default: package.author

List of owners of the package, used in the authors field of the spec file.

options.homepage

Type: String Default: package.homepage || package.author.url

URL of the homepage for the package, used in the projectUrl field of the spec file.

options.iconUrl

Type: String Default: undefined

URL for the image to use as the icon for the package in the Manage NuGet Packages dialog box, used in the iconUrl field of the spec file.

options.licenseUrl

Type: String Default: undefined

URL for the license that the package is under, used in the licenseUrl field of the spec file.

options.requireLicenseAcceptance

Type: String Default: false

Whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed, used in the requireLicenseAcceptance field of the spec file.

options.tags

Type: Array[String] Default: []

List of tags and keywords that describe the package, used in the tags field of the spec file.

options.rename

Type: Function Default: function (dest, src) { return dest + src; }

Function that renames all files generated by the task just before putting them in your dest folder.

Updating

Squirrel

Current version: 1.2.2

To update Squirrel to the latest version:

$ rm vendor/squirrel/*
$ curl -kLo vendor/squirrel.zip https://github.com/Squirrel/Squirrel.Windows/releases/download/1.2.2/Squirrel.Windows-1.2.2.zip
$ unzip -d vendor/squirrel/ vendor/squirrel.zip
$ rm vendor/squirrel.zip