-
-
Notifications
You must be signed in to change notification settings - Fork 506
/
package.ts
193 lines (164 loc) · 6.35 KB
/
package.ts
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
import 'colors';
import { ora as realOra, fakeOra, OraImpl } from '@electron-forge/async-ora';
import { ForgeArch, ForgePlatform, ForgeConfig } from '@electron-forge/shared-types';
import debug from 'debug';
import fs from 'fs-extra';
import glob from 'glob';
import path from 'path';
import pify from 'pify';
import packager from 'electron-packager';
import getForgeConfig from '../util/forge-config';
import runHook from '../util/hook';
import { warn } from '../util/messages';
import readPackageJSON from '../util/read-package-json';
import rebuildHook from '../util/rebuild';
import requireSearch from '../util/require-search';
import resolveDir from '../util/resolve-dir';
import getCurrentOutDir from '../util/out-dir';
import getElectronVersion from '../util/electron-version';
const { hostArch }: { hostArch: () => ForgeArch | 'all'} = require('electron-packager/targets');
const d = debug('electron-forge:packager');
type ElectronPackagerAfterCopyHook =
(buildPath: string, electronVersion: string, pPlatform: ForgePlatform, pArch: ForgeArch, done: (err?: Error) => void) => void;
/**
* Resolves hooks if they are a path to a file (instead of a `Function`).
*/
function resolveHooks(hooks: (string | ElectronPackagerAfterCopyHook)[] | undefined, dir: string) {
if (hooks) {
return hooks.map(hook => (
typeof hook === 'string'
? requireSearch<ElectronPackagerAfterCopyHook>(dir, [hook]) as ElectronPackagerAfterCopyHook
: hook
));
}
return [];
}
/**
* Runs given hooks sequentially by mapping them to promises and iterating
* through while awaiting
*/
function sequentialHooks(hooks: Function[]) {
return [async (...args: any[]) => {
const done = args[args.length - 1];
const passedArgs = args.splice(0, args.length - 1);
for (const hook of hooks) {
await pify(hook)(...passedArgs);
}
done();
}] as [(...args: any[]) => Promise<void>];
}
export interface PackageOptions {
/**
* The path to the app to package
*/
dir?: string;
/**
* Whether to use sensible defaults or prompt the user visually
*/
interactive?: boolean;
/**
* The target arch
*/
arch?: ForgeArch;
/**
* The target platform.
*/
platform?: ForgePlatform;
/**
* The path to the output directory for packaged apps
*/
outDir?: string;
}
export default async ({
dir = process.cwd(),
interactive = false,
arch = hostArch(),
platform = process.platform,
outDir,
}: PackageOptions) => {
const ora = interactive ? realOra : fakeOra;
let prepareSpinner = ora(`Preparing to Package Application for arch: ${(arch === 'all' ? 'ia32' : arch).cyan}`).start();
let prepareCounter = 0;
const resolvedDir = await resolveDir(dir);
if (!resolvedDir) {
throw 'Failed to locate compilable Electron application';
}
dir = resolvedDir;
const packageJSON = await readPackageJSON(dir);
if (!packageJSON.main) {
throw 'packageJSON.main must be set to a valid entry point for your Electron app';
}
const forgeConfig = await getForgeConfig(dir);
const calculatedOutDir = outDir || getCurrentOutDir(dir, forgeConfig);
let packagerSpinner: OraImpl | null = null;
const pruneEnabled = !('prune' in forgeConfig.packagerConfig) || forgeConfig.packagerConfig.prune;
const afterCopyHooks: ElectronPackagerAfterCopyHook[] = [
async (buildPath, electronVersion, pPlatform, pArch, done) => {
if (packagerSpinner) {
packagerSpinner.succeed();
prepareCounter += 1;
prepareSpinner = ora(`Preparing to Package Application for arch: ${(prepareCounter === 2 ? 'armv7l' : 'x64').cyan}`).start();
}
const bins = await pify(glob)(path.join(buildPath, '**/.bin/**/*'));
for (const bin of bins) {
await fs.remove(bin);
}
done();
}, async (buildPath, electronVersion, pPlatform, pArch, done) => {
prepareSpinner.succeed();
await runHook(forgeConfig, 'packageAfterCopy', buildPath, electronVersion, pPlatform, pArch);
done();
},
async (buildPath, electronVersion, pPlatform, pArch, done) => {
await rebuildHook(buildPath, electronVersion, pPlatform, pArch, forgeConfig.electronRebuildConfig);
packagerSpinner = ora('Packaging Application').start();
done();
},
];
afterCopyHooks.push(async (buildPath, electronVersion, pPlatform, pArch, done) => {
const copiedPackageJSON = await readPackageJSON(buildPath);
if (copiedPackageJSON.config && copiedPackageJSON.config.forge) {
delete copiedPackageJSON.config.forge;
}
await fs.writeJson(path.resolve(buildPath, 'package.json'), copiedPackageJSON, { spaces: 2 });
done();
});
afterCopyHooks.push(...resolveHooks(forgeConfig.packagerConfig.afterCopy, dir));
const afterPruneHooks = [];
if (pruneEnabled) {
afterPruneHooks.push(...resolveHooks(forgeConfig.packagerConfig.afterPrune, dir));
}
afterPruneHooks.push((async (buildPath, electronVersion, pPlatform, pArch, done) => {
await runHook(forgeConfig, 'packageAfterPrune', buildPath, electronVersion, pPlatform, pArch);
done();
}) as ElectronPackagerAfterCopyHook);
const afterExtractHooks = [(async (buildPath, electronVersion, pPlatform, pArch, done) => {
await runHook(forgeConfig, 'packageAfterExtract', buildPath, electronVersion, pPlatform, pArch);
done();
}) as ElectronPackagerAfterCopyHook];
afterExtractHooks.push(...resolveHooks(forgeConfig.packagerConfig.afterExtract, dir));
const packageOpts: packager.Options = Object.assign({
asar: false,
overwrite: true,
}, forgeConfig.packagerConfig, {
dir,
arch,
platform,
afterCopy: sequentialHooks(afterCopyHooks),
afterExtract: sequentialHooks(afterExtractHooks),
afterPrune: sequentialHooks(afterPruneHooks),
out: calculatedOutDir,
electronVersion: getElectronVersion(packageJSON),
});
packageOpts.quiet = true;
if (!packageJSON.version && !packageOpts.appVersion) {
// eslint-disable-next-line max-len
warn(interactive, 'Please set "version" or "config.forge.packagerConfig.appVersion" in your application\'s package.json so auto-updates work properly'.yellow);
}
await runHook(forgeConfig, 'generateAssets');
await runHook(forgeConfig, 'prePackage');
d('packaging with options', packageOpts);
await (packager as (opts: packager.Options) => Promise<void>)(packageOpts);
await runHook(forgeConfig, 'postPackage');
if (packagerSpinner) packagerSpinner!.succeed();
};