/gulp-atom-electron

Gulp plugin for packaging Electron applications

Primary LanguageJavaScript

gulp-atom-electron

Build Status

Installation

npm install --save gulp-atom-electron

Usage

var gulp = require('gulp');
var electron = require('gulp-atom-electron');

gulp.task('default', function () {
	return gulp.src('src/**')
		.pipe(electron({ 
				  version: '0.19.4',
				  platform: 'darwin'
		 }))
		.pipe(electron.zfsdest('app.zip'));
});

Options

You must provide the following options:

  • version - the Electron version to use
  • platform - kind of OS (darwin, linux, win32)

The following options are optional:

  • token - GitHub access token(to avoid request limit. You can grab it here)

  • arch - the processor architecture (ia32, x64)

  • Windows

    • winIcon - path to an .ico file
    • companyName - company name
    • copyright - copyright statement

  • Darwin

    • darwinIcon - path to an .icns file
    • darwinBundleDocumentTypes - (reference) array of dictionaries, each containing the following structure:
    • name - the CFBundleTypeName value
    • role - the CFBundleTypeRole value
    • ostypes - the CFBundleTypeOSTypes value, a string array
    • extensions - the CFBundleTypeExtensions value, a string array of file extensions
    • iconFile - the CFBundleTypeIconFile value