Nativefier/src/build/buildMain.js

175 lines
4.9 KiB
JavaScript
Raw Normal View History

2016-01-29 07:26:35 +01:00
import path from 'path';
import packager from 'electron-packager';
import tmp from 'tmp';
import ncp from 'ncp';
import async from 'async';
import hasBinary from 'hasbin';
2016-03-12 08:46:07 +01:00
import ProgressBar from 'progress';
2016-02-20 03:39:51 +01:00
import optionsFactory from './../options/optionsMain';
2016-01-29 07:26:35 +01:00
import iconBuild from './iconBuild';
import helpers from './../helpers/helpers';
import PackagerConsole from './../helpers/packagerConsole';
2016-01-29 07:26:35 +01:00
import buildApp from './buildApp';
const copy = ncp.ncp;
const isWindows = helpers.isWindows;
/**
* @callback buildAppCallback
* @param error
* @param {string} appPath
*/
/**
*
* @param {{}} options
* @param {buildAppCallback} callback
*/
function buildMain(options, callback) {
// pre process app
2016-03-12 08:46:07 +01:00
const tmpObj = tmp.dirSync({unsafeCleanup: true});
2016-01-29 07:26:35 +01:00
const tmpPath = tmpObj.name;
// todo check if this is still needed on later version of packager
const packagerConsole = new PackagerConsole();
2016-03-12 08:46:07 +01:00
const bar = new ProgressBar(' :task [:bar] :percent', {
complete: '=',
incomplete: ' ',
total: 5,
width: 50,
clear: true
});
2016-01-29 07:26:35 +01:00
async.waterfall([
callback => {
2016-03-12 08:46:07 +01:00
bar.tick({
task: 'infering'
});
2016-01-29 07:26:35 +01:00
optionsFactory(options, callback);
},
(options, callback) => {
2016-03-12 08:46:07 +01:00
bar.tick({
task: 'copying'
});
2016-01-29 07:26:35 +01:00
buildApp(options.dir, tmpPath, options, error => {
if (error) {
callback(error);
return;
}
// dir now correctly references the app folder to package
options.dir = tmpPath;
callback(null, options);
});
},
(options, callback) => {
2016-03-12 08:46:07 +01:00
bar.tick({
task: 'icons'
});
2016-01-29 07:26:35 +01:00
iconBuild(options, (error, optionsWithIcon) => {
callback(null, optionsWithIcon);
});
},
(options, callback) => {
2016-03-12 08:46:07 +01:00
bar.tick({
task: 'packaging'
});
2016-01-29 07:26:35 +01:00
// maybe skip passing icon parameter to electron packager
const packageOptions = maybeNoIconOption(options);
2016-03-12 08:46:07 +01:00
packagerConsole.override();
2016-03-12 08:46:07 +01:00
2016-01-29 07:26:35 +01:00
packager(packageOptions, (error, appPathArray) => {
2016-03-12 08:46:07 +01:00
// restore console.error
packagerConsole.restore();
2016-03-12 08:46:07 +01:00
2016-01-29 07:26:35 +01:00
// pass options which still contains the icon to waterfall
callback(error, options, appPathArray);
});
},
(options, appPathArray, callback) => {
2016-03-12 08:46:07 +01:00
bar.tick({
task: 'finalizing'
});
2016-01-29 07:26:35 +01:00
// somehow appPathArray is a 1 element array
const appPath = getAppPath(appPathArray);
if (!appPath) {
callback();
return;
}
maybeCopyIcons(options, appPath, error => {
callback(error, appPath);
});
}
], (error, appPath) => {
packagerConsole.playback();
callback(error, appPath);
});
2016-01-29 07:26:35 +01:00
}
/**
* Checks the app path array to determine if the packaging was completed successfully
* @param appPathArray Result from electron-packager
* @returns {*}
*/
function getAppPath(appPathArray) {
if (appPathArray.length === 0) {
// directory already exists, --overwrite is not set
// exit here
return null;
}
if (appPathArray.length > 1) {
console.warn('Warning: This should not be happening, packaged app path contains more than one element:', appPathArray);
}
return appPathArray[0];
}
/**
* Removes the `icon` parameter from options if building for Windows while not on Windows and Wine is not installed
* @param options
*/
function maybeNoIconOption(options) {
const packageOptions = JSON.parse(JSON.stringify(options));
if (options.platform === 'win32' && !isWindows()) {
if (!hasBinary.sync('wine')) {
console.warn('Wine is required to set the icon for a Windows app when packaging on non-windows platforms');
2016-01-29 07:26:35 +01:00
packageOptions.icon = null;
}
}
return packageOptions;
}
/**
* For windows and linux, we have to copy over the icon to the resources/app folder, which the
* BrowserWindow is hard coded to read the icon from
* @param {{}} options
* @param {string} appPath
* @param callback
*/
function maybeCopyIcons(options, appPath, callback) {
if (!options.icon) {
callback();
return;
}
if (options.platform === 'darwin') {
callback();
return;
}
// windows & linux
// put the icon file into the app
2016-01-29 07:26:35 +01:00
const destIconPath = path.join(appPath, 'resources/app');
const destFileName = `icon${path.extname(options.icon)}`;
copy(options.icon, path.join(destIconPath, destFileName), error => {
2016-01-29 07:26:35 +01:00
callback(error);
});
}
export default buildMain;