UNPKG

electron-forge

Version:

A complete tool for building modern Electron applications

567 lines (566 loc) 17.3 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for api/install.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> install.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Statements</span> <span class='fraction'>63/63</span> </div> <div class='fl pad1y space-right2'> <span class="strong">89.47% </span> <span class="quiet">Branches</span> <span class='fraction'>34/38</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Functions</span> <span class='fraction'>9/9</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Lines</span> <span class='fraction'>57/57</span> </div> </div> </div> <div class='status-line high'></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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168</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-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">11x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">11x</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">11x</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">11x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">11x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">11x</span> <span class="cline-any cline-yes">11x</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">9x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">9x</span> <span class="cline-any cline-yes">9x</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">9x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">3x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">9x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-yes">6x</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-yes">5x</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">5x</span> <span class="cline-any cline-yes">8x</span> <span class="cline-any cline-yes">8x</span> <span class="cline-any cline-yes">40x</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-yes">5x</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-yes">4x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-yes">3x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">2x</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-yes">1x</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-yes">3x</span> <span class="cline-any cline-yes">3x</span> <span class="cline-any cline-yes">3x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">3x</span> <span class="cline-any cline-yes">3x</span> <span class="cline-any cline-yes">3x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">3x</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">3x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">3x</span> <span class="cline-any cline-yes">3x</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">6x</span> <span class="cline-any cline-yes">3x</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></td><td class="text"><pre class="prettyprint lang-js">import 'colors'; import debug from 'debug'; import fetch from 'node-fetch'; import fs from 'fs-promise'; import inquirer from 'inquirer'; import nugget from 'nugget'; import os from 'os'; import path from 'path'; import pify from 'pify'; import semver from 'semver'; &nbsp; import asyncOra from '../util/ora-handler'; &nbsp; import darwinDMGInstaller from '../installers/darwin/dmg'; import darwinZipInstaller from '../installers/darwin/zip'; import linuxDebInstaller from '../installers/linux/deb'; import linuxRPMInstaller from '../installers/linux/rpm'; import win32ExeInstaller from '../installers/win32/exe'; &nbsp; const d = debug('electron-forge:install'); &nbsp; const GITHUB_API = 'https://api.github.com'; &nbsp; /** * @typedef {Object} InstallOptions * @property {boolean} [interactive=false] Whether to use sensible defaults or prompt the user visually * @property {boolean} [prerelease=false] Whether to install prerelease versions * @property {string} repo The GitHub repository to install from, in the format owner/name * @property {function} chooseAsset A function that must return the asset to use/install from a provided array of compatible GitHub assets */ &nbsp; /** * Install an Electron application from GitHub. If you leave interactive as `false`, you MUST provide a `chooseAsset` function. * * @param {InstallOptions} providedOptions - Options for the install method * @return {Promise} Will resolve when the install process is complete */ export default async (providedOptions = {}) =&gt; { // eslint-disable-next-line prefer-const, no-unused-vars let { interactive, prerelease, repo, chooseAsset } = Object.assign({ interactive: false, prerelease: false, }, providedOptions); asyncOra.interactive = interactive; &nbsp; let latestRelease; let possibleAssets = []; &nbsp; await asyncOra('Searching for Application', async (searchSpinner) =&gt; { if (!repo || repo.indexOf('/') === -1) { // eslint-disable-next-line no-throw-literal throw 'Invalid repository name, must be in the format owner/name'; } &nbsp; d('searching for repo:', repo); let releases; try { releases = await (await fetch(`${GITHUB_API}/repos/${repo}/releases`)).json(); } catch (err) { // Ignore error } &nbsp; if (!releases || releases.message === 'Not Found' || !Array.isArray(releases)) { // eslint-disable-next-line no-throw-literal throw `Failed to find releases for repository "${repo}". Please check the name and try again.`; } &nbsp; releases = releases.filter(release =&gt; !release.prerelease || <span class="branch-1 cbranch-no" title="branch not covered" >prerelease)</span>; &nbsp; const sortedReleases = releases.sort((releaseA, releaseB) =&gt; { let tagA = releaseA.tag_name; if (tagA.substr(0, 1) === 'v') tagA = tagA.substr(1); let tagB = releaseB.tag_name; if (tagB.substr(0, 1) === 'v') tagB = tagB.substr(1); return (semver.gt(tagB, tagA) ? 1 : -1); }); latestRelease = sortedReleases[0]; &nbsp; searchSpinner.text = 'Searching for Releases'; // eslint-disable-line &nbsp; const assets = latestRelease.assets; if (!assets || !Array.isArray(assets)) { // eslint-disable-next-line no-throw-literal throw 'Could not find any assets for the latest release'; } &nbsp; const installTargets = { win32: [/\.exe$/], darwin: [/OSX.*\.zip$/, /darwin.*\.zip$/, /macOS.*\.zip$/, /mac.*\.zip$/, /\.dmg$/], linux: [/\.rpm$/, /\.deb$/], }; &nbsp; possibleAssets = assets.filter((asset) =&gt; { const targetSuffixes = installTargets[process.platform]; for (const suffix of targetSuffixes) { if (suffix.test(asset.name)) return true; } return false; }); &nbsp; if (possibleAssets.length === 0) { // eslint-disable-next-line no-throw-literal throw `Failed to find any installable assets for target platform: ${`${process.platform}`.cyan}`; } }); &nbsp; console.info(`Found latest release${prerelease ? <span class="branch-0 cbranch-no" title="branch not covered" >' (including prereleases)' </span>: ''}: ${latestRelease.tag_name.cyan}`); &nbsp; let targetAsset = possibleAssets[0]; if (possibleAssets.length &gt; 1) { if (chooseAsset) { targetAsset = await Promise.resolve(chooseAsset(possibleAssets)); } else if (interactive) { const choices = []; possibleAssets.forEach((asset) =&gt; { choices.push({ name: asset.name, value: asset.id }); }); const { assetID } = await inquirer.createPromptModule()({ type: 'list', name: 'assetID', message: 'Multiple potential assets found, please choose one from the list below:'.cyan, choices, }); &nbsp; targetAsset = possibleAssets.find(asset =&gt; asset.id === assetID); } else { // eslint-disable-next-line no-throw-literal throw 'expected a chooseAsset function to be provided but it was not'; } } &nbsp; const tmpdir = path.resolve(os.tmpdir(), 'forge-install'); const pathSafeRepo = repo.replace(/[/\\]/g, '-'); const filename = `${pathSafeRepo}-${latestRelease.tag_name}-${targetAsset.name}`; &nbsp; const fullFilePath = path.resolve(tmpdir, filename); <span class="missing-if-branch" title="else path not taken" >E</span>if (!await fs.exists(fullFilePath) || <span class="branch-1 cbranch-no" title="branch not covered" >(await fs.stat(fullFilePath)).size !== targetAsset.size)</span> { await fs.mkdirs(tmpdir); &nbsp; const nuggetOpts = { target: filename, dir: tmpdir, resume: true, strictSSL: true, }; await pify(nugget)(targetAsset.browser_download_url, nuggetOpts); } &nbsp; await asyncOra('Installing Application', async (installSpinner) =&gt; { const installActions = { win32: { '.exe': win32ExeInstaller, }, darwin: { '.zip': darwinZipInstaller, '.dmg': darwinDMGInstaller, }, linux: { '.deb': linuxDebInstaller, '.rpm': linuxRPMInstaller, }, }; &nbsp; const suffixFnIdent = Object.keys(installActions[process.platform]).find(suffix =&gt; targetAsset.name.endsWith(suffix)); await installActions[process.platform][suffixFnIdent](fullFilePath, installSpinner); }); }; &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>