electron/default_app/main.ts

280 lines
7.8 KiB
TypeScript
Raw Normal View History

import * as electron from 'electron/main';
2020-03-20 20:28:31 +00:00
import * as fs from 'fs';
import * as path from 'path';
import * as url from 'url';
const { app, dialog } = electron;
type DefaultAppOptions = {
file: null | string;
noHelp: boolean;
version: boolean;
webdriver: boolean;
interactive: boolean;
abi: boolean;
modules: string[];
}
2020-03-20 20:28:31 +00:00
const Module = require('module');
// Parse command line options.
2020-03-20 20:28:31 +00:00
const argv = process.argv.slice(1);
2017-09-28 03:51:53 +00:00
const option: DefaultAppOptions = {
2017-09-28 03:51:53 +00:00
file: null,
noHelp: Boolean(process.env.ELECTRON_NO_HELP),
version: false,
webdriver: false,
interactive: false,
abi: false,
2017-09-28 03:51:53 +00:00
modules: []
2020-03-20 20:28:31 +00:00
};
2017-09-28 03:51:53 +00:00
2020-03-20 20:28:31 +00:00
let nextArgIsRequire = false;
for (const arg of argv) {
if (nextArgIsRequire) {
2020-03-20 20:28:31 +00:00
option.modules.push(arg);
nextArgIsRequire = false;
continue;
} else if (arg === '--version' || arg === '-v') {
2020-03-20 20:28:31 +00:00
option.version = true;
break;
} else if (arg.match(/^--app=/)) {
2020-03-20 20:28:31 +00:00
option.file = arg.split('=')[1];
break;
} else if (arg === '--interactive' || arg === '-i' || arg === '-repl') {
2020-03-20 20:28:31 +00:00
option.interactive = true;
} else if (arg === '--test-type=webdriver') {
2020-03-20 20:28:31 +00:00
option.webdriver = true;
} else if (arg === '--require' || arg === '-r') {
2020-03-20 20:28:31 +00:00
nextArgIsRequire = true;
continue;
} else if (arg === '--abi' || arg === '-a') {
2020-03-20 20:28:31 +00:00
option.abi = true;
continue;
} else if (arg === '--no-help') {
2020-03-20 20:28:31 +00:00
option.noHelp = true;
continue;
} else if (arg[0] === '-') {
2020-03-20 20:28:31 +00:00
continue;
} else {
2020-03-20 20:28:31 +00:00
option.file = arg;
break;
}
}
if (nextArgIsRequire) {
2020-03-20 20:28:31 +00:00
console.error('Invalid Usage: --require [file]\n\n"file" is required');
process.exit(1);
}
// Set up preload modules
if (option.modules.length > 0) {
2020-03-20 20:28:31 +00:00
Module._preloadModules(option.modules);
}
function loadApplicationPackage (packagePath: string) {
// Add a flag indicating app is started from default app.
Object.defineProperty(process, 'defaultApp', {
configurable: false,
enumerable: true,
value: true
2020-03-20 20:28:31 +00:00
});
try {
// Override app name and version.
2020-03-20 20:28:31 +00:00
packagePath = path.resolve(packagePath);
const packageJsonPath = path.join(packagePath, 'package.json');
let appPath;
if (fs.existsSync(packageJsonPath)) {
2020-03-20 20:28:31 +00:00
let packageJson;
try {
2020-03-20 20:28:31 +00:00
packageJson = require(packageJsonPath);
} catch (e) {
2020-03-20 20:28:31 +00:00
showErrorMessage(`Unable to parse ${packageJsonPath}\n\n${e.message}`);
return;
}
2016-03-28 20:19:41 +00:00
2016-05-24 16:42:31 +00:00
if (packageJson.version) {
2020-03-20 20:28:31 +00:00
app.setVersion(packageJson.version);
2016-05-24 16:42:31 +00:00
}
2016-03-28 20:19:41 +00:00
if (packageJson.productName) {
2020-03-20 20:28:31 +00:00
app.name = packageJson.productName;
2016-03-28 20:19:41 +00:00
} else if (packageJson.name) {
2020-03-20 20:28:31 +00:00
app.name = packageJson.name;
2016-03-28 20:19:41 +00:00
}
2020-03-20 20:28:31 +00:00
appPath = packagePath;
}
2016-05-24 16:33:55 +00:00
try {
2020-03-20 20:28:31 +00:00
const filePath = Module._resolveFilename(packagePath, module, true);
app.setAppPath(appPath || path.dirname(filePath));
} catch (e) {
2020-03-20 20:28:31 +00:00
showErrorMessage(`Unable to find Electron app at ${packagePath}\n\n${e.message}`);
return;
}
2016-05-24 16:41:31 +00:00
// Run the app.
2020-03-20 20:28:31 +00:00
Module._load(packagePath, module, true);
2016-03-29 01:00:30 +00:00
} catch (e) {
2020-03-20 20:28:31 +00:00
console.error('App threw an error during load');
console.error(e.stack || e);
throw e;
}
}
function showErrorMessage (message: string) {
2020-03-20 20:28:31 +00:00
app.focus();
dialog.showErrorBox('Error launching app', message);
process.exit(1);
}
async function loadApplicationByURL (appUrl: string) {
2020-03-20 20:28:31 +00:00
const { loadURL } = await import('./default_app');
loadURL(appUrl);
}
async function loadApplicationByFile (appPath: string) {
2020-03-20 20:28:31 +00:00
const { loadFile } = await import('./default_app');
loadFile(appPath);
}
2017-09-28 04:10:52 +00:00
function startRepl () {
2016-06-13 16:46:33 +00:00
if (process.platform === 'win32') {
2020-03-20 20:28:31 +00:00
console.error('Electron REPL not currently supported on Windows');
process.exit(1);
2016-06-13 16:46:33 +00:00
}
// Prevent quitting.
2020-03-20 20:28:31 +00:00
app.on('window-all-closed', () => {});
const GREEN = '32';
const colorize = (color: string, s: string) => `\x1b[${color}m${s}\x1b[0m`;
const electronVersion = colorize(GREEN, `v${process.versions.electron}`);
const nodeVersion = colorize(GREEN, `v${process.versions.node}`);
console.info(`
Welcome to the Electron.js REPL \\[._.]/
You can access all Electron.js modules here as well as Node.js modules.
Using: Node.js ${nodeVersion} and Electron.js ${electronVersion}
`);
const { REPLServer } = require('repl');
const repl = new REPLServer({
prompt: '> '
}).on('exit', () => {
2020-03-20 20:28:31 +00:00
process.exit(0);
});
function defineBuiltin (context: any, name: string, getter: Function) {
const setReal = (val: any) => {
// Deleting the property before re-assigning it disables the
// getter/setter mechanism.
delete context[name];
context[name] = val;
};
Object.defineProperty(context, name, {
get: () => {
const lib = getter();
delete context[name];
Object.defineProperty(context, name, {
get: () => lib,
set: setReal,
configurable: true,
enumerable: false
});
return lib;
},
set: setReal,
configurable: true,
enumerable: false
});
}
defineBuiltin(repl.context, 'electron', () => electron);
for (const api of Object.keys(electron) as (keyof typeof electron)[]) {
defineBuiltin(repl.context, api, () => electron[api]);
}
// Copied from node/lib/repl.js. For better DX, we don't want to
// show e.g 'contentTracing' at a higher priority than 'const', so
// we only trigger custom tab-completion when no common words are
// potentially matches.
const commonWords = [
'async', 'await', 'break', 'case', 'catch', 'const', 'continue',
'debugger', 'default', 'delete', 'do', 'else', 'export', 'false',
'finally', 'for', 'function', 'if', 'import', 'in', 'instanceof', 'let',
'new', 'null', 'return', 'switch', 'this', 'throw', 'true', 'try',
'typeof', 'var', 'void', 'while', 'with', 'yield'
];
const electronBuiltins = [...Object.keys(electron), 'original-fs', 'electron'];
const defaultComplete = repl.completer;
repl.completer = (line: string, callback: Function) => {
const lastSpace = line.lastIndexOf(' ');
const currentSymbol = line.substring(lastSpace + 1, repl.cursor);
const filterFn = (c: string) => c.startsWith(currentSymbol);
const ignores = commonWords.filter(filterFn);
const hits = electronBuiltins.filter(filterFn);
if (!ignores.length && hits.length) {
callback(null, [hits, currentSymbol]);
} else {
defaultComplete.apply(repl, [line, callback]);
}
};
2016-03-22 20:34:46 +00:00
}
// Start the specified app if there is one specified in command line, otherwise
// start the default app.
if (option.file && !option.webdriver) {
2020-03-20 20:28:31 +00:00
const file = option.file;
const protocol = url.parse(file).protocol;
const extension = path.extname(file);
if (protocol === 'http:' || protocol === 'https:' || protocol === 'file:' || protocol === 'chrome:') {
2020-03-20 20:28:31 +00:00
loadApplicationByURL(file);
} else if (extension === '.html' || extension === '.htm') {
2020-03-20 20:28:31 +00:00
loadApplicationByFile(path.resolve(file));
} else {
2020-03-20 20:28:31 +00:00
loadApplicationPackage(file);
}
} else if (option.version) {
2020-03-20 20:28:31 +00:00
console.log('v' + process.versions.electron);
process.exit(0);
2017-11-10 22:58:21 +00:00
} else if (option.abi) {
2020-03-20 20:28:31 +00:00
console.log(process.versions.modules);
process.exit(0);
} else if (option.interactive) {
2020-03-20 20:28:31 +00:00
startRepl();
} else {
if (!option.noHelp) {
const welcomeMessage = `
Electron ${process.versions.electron} - Build cross platform desktop apps with JavaScript, HTML, and CSS
Usage: electron [options] [path]
A path to an Electron app may be specified. It must be one of the following:
- index.js file.
- Folder containing a package.json file.
- Folder containing an index.js file.
- .html/.htm file.
- http://, https://, or file:// URL.
Options:
-i, --interactive Open a REPL to the main process.
-r, --require Module to preload (option can be repeated).
-v, --version Print the version.
2020-03-20 20:28:31 +00:00
-a, --abi Print the Node ABI version.`;
2020-03-20 20:28:31 +00:00
console.log(welcomeMessage);
}
2020-03-20 20:28:31 +00:00
loadApplicationByFile('index.html');
2017-09-28 04:10:52 +00:00
}