UNPKG

electron-forge

Version:

A complete tool for building modern Electron applications

390 lines (389 loc) 13.6 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for api/package.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../prettify.css" /> <link rel="stylesheet" href="../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../index.html">All files</a> / <a href="index.html">api</a> package.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">69.44% </span> <span class="quiet">Statements</span> <span class='fraction'>25/36</span> </div> <div class='fl pad1y space-right2'> <span class="strong">34.78% </span> <span class="quiet">Branches</span> <span class='fraction'>8/23</span> </div> <div class='fl pad1y space-right2'> <span class="strong">66.67% </span> <span class="quiet">Functions</span> <span class='fraction'>4/6</span> </div> <div class='fl pad1y space-right2'> <span class="strong">69.44% </span> <span class="quiet">Lines</span> <span class='fraction'>25/36</span> </div> </div> </div> <div class='status-line medium'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import 'colors'; import debug from 'debug'; import fs from 'fs-promise'; import glob from 'glob'; import path from 'path'; import pify from 'pify'; import packager from 'electron-packager'; import ora from 'ora'; &nbsp; import electronHostArch from '../util/electron-host-arch'; import getForgeConfig from '../util/forge-config'; import packagerCompileHook from '../util/compile-hook'; import readPackageJSON from '../util/read-package-json'; import rebuildHook from '../util/rebuild'; import resolveDir from '../util/resolve-dir'; &nbsp; const d = debug('electron-forge:packager'); &nbsp; /** * @typedef {Object} PackageOptions * @property {string} [dir=process.cwd()] The path to the app to package * @property {boolean} [interactive=false] Whether to use sensible defaults or prompt the user visually * @property {string} [arch=process.arch] The target arch * @property {string} [platform=process.platform] The target platform. NOTE: This is limited to be the current platform at the moment */ &nbsp; /** * Package an Electron application into an platform dependent format. * * @param {PackageOptions} providedOptions - Options for the Package method * @return {Promise} Will resolve when the package process is complete */ export default async (providedOptions = <span class="branch-0 cbranch-no" title="branch not covered" >{})</span> =&gt; { // eslint-disable-next-line prefer-const, no-unused-vars let { dir, interactive, arch, platform } = Object.assign({ dir: process.cwd(), interactive: false, arch: electronHostArch(), platform: process.platform, }, providedOptions); &nbsp; let prepareSpinner = ora.ora(`Preparing to Package Application for arch: ${(arch === 'all' ? <span class="branch-0 cbranch-no" title="branch not covered" >'ia32' </span>: arch).cyan}`).start(); let prepareCounter = 0; &nbsp; dir = await resolveDir(dir); <span class="missing-if-branch" title="if path not taken" >I</span>if (!dir) { // eslint-disable-next-line no-throw-literal <span class="cstat-no" title="statement not covered" > throw 'Failed to locate compilable Electron application';</span> } &nbsp; const packageJSON = await readPackageJSON(dir); &nbsp; <span class="missing-if-branch" title="if path not taken" >I</span>if (path.dirname(require.resolve(path.resolve(dir, packageJSON.main))) === dir) { <span class="cstat-no" title="statement not covered" > console.error(`Entry point: ${packageJSON.main}`.red);</span> // eslint-disable-next-line no-throw-literal <span class="cstat-no" title="statement not covered" > throw 'The entry point to your application ("packageJSON.name") must be in a subfolder not in the top level directory';</span> } &nbsp; const forgeConfig = await getForgeConfig(dir); let packagerSpinner; &nbsp; const packageOpts = Object.assign({ asar: false, overwrite: true, }, forgeConfig.electronPackagerConfig, { afterCopy: [async (buildPath, electronVersion, pPlatform, pArch, done) =&gt; { <span class="missing-if-branch" title="if path not taken" >I</span>if (packagerSpinner) { <span class="cstat-no" title="statement not covered" > packagerSpinner.succeed();</span> <span class="cstat-no" title="statement not covered" > prepareCounter += 1;</span> <span class="cstat-no" title="statement not covered" > prepareSpinner = ora.ora(`Preparing to Package Application for arch: ${(prepareCounter === 2 ? 'armv7l' : 'x64').cyan}`).start();</span> } await fs.remove(path.resolve(buildPath, 'node_modules/electron-compile/test')); const bins = await pify(glob)(path.join(buildPath, '**/.bin/**/*')); for (const bin of bins) { <span class="cstat-no" title="statement not covered" > await fs.remove(bin);</span> } done(); }, async (...args) =&gt; { prepareSpinner.succeed(); await packagerCompileHook(dir, ...args); }, async (buildPath, electronVersion, pPlatform, pArch, done) =&gt; { await rebuildHook(buildPath, electronVersion, pPlatform, pArch); packagerSpinner = ora.ora('Packaging Application').start(); done(); }].concat(forgeConfig.electronPackagerConfig.afterCopy ? <span class="branch-0 cbranch-no" title="branch not covered" >forgeConfig.electronPackagerConfig.afterCopy.map(<span class="fstat-no" title="function not covered" >it</span>em =&gt;</span> (<span class="cstat-no" title="statement not covered" >typeof item === 'string' ? require(item) : item)</span> ) : []), afterExtract: forgeConfig.electronPackagerConfig.afterExtract ? <span class="branch-0 cbranch-no" title="branch not covered" >forgeConfig.electronPackagerConfig.afterExtract.map(<span class="fstat-no" title="function not covered" >it</span>em =&gt;</span> (<span class="cstat-no" title="statement not covered" >typeof item === 'string' ? require(item) : item)</span> ) : [], dir, arch, platform, out: path.resolve(dir, 'out'), electronVersion: packageJSON.devDependencies['electron-prebuilt-compile'], }); packageOpts.quiet = true; <span class="missing-if-branch" title="if path not taken" >I</span>if (typeof packageOpts.asar === 'object' &amp;&amp; <span class="branch-1 cbranch-no" title="branch not covered" >packageOpts.asar.unpack)</span> { <span class="cstat-no" title="statement not covered" > packagerSpinner.fail();</span> <span class="cstat-no" title="statement not covered" > throw new Error('electron-compile does not support asar.unpack yet. Please use asar.unpackDir');</span> } &nbsp; d('packaging with options', packageOpts); &nbsp; await pify(packager)(packageOpts); &nbsp; packagerSpinner.succeed(); }; &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Sun Jan 15 2017 17:22:43 GMT+1100 (AEDT) </div> </div> <script src="../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../sorter.js"></script> </body> </html>