From a03bd10d4cd377cf8a68e0c08bf0836e460278c4 Mon Sep 17 00:00:00 2001 From: Wee Date: Sun, 7 Apr 2019 22:42:42 +0800 Subject: [PATCH 1/2] feat(docz-core): auto open browser when start dev mode --- core/docz-core/src/commands/dev.ts | 2 + core/docz-core/src/utils/open-browser.ts | 127 +++++++++++++++++++++++ 2 files changed, 129 insertions(+) create mode 100644 core/docz-core/src/utils/open-browser.ts diff --git a/core/docz-core/src/commands/dev.ts b/core/docz-core/src/commands/dev.ts index d411f278e..9b3c06552 100644 --- a/core/docz-core/src/commands/dev.ts +++ b/core/docz-core/src/commands/dev.ts @@ -10,6 +10,7 @@ import { Socket } from '../lib/Socket' import { parseConfig } from '../config/docz' import { onSignal } from '../utils/on-signal' import { bundler as webpack } from '../bundler' +import { openBrowser } from '../utils/open-browser' import * as states from '../states' export const dev = async (args: Arguments) => { @@ -40,6 +41,7 @@ export const dev = async (args: Arguments) => { try { await dataServer.start() + openBrowser(`http://${config.host}:${config.port}`) } catch (err) { logger.fatal('Failed to process data server') logger.error(err) diff --git a/core/docz-core/src/utils/open-browser.ts b/core/docz-core/src/utils/open-browser.ts new file mode 100644 index 000000000..df2f98b3b --- /dev/null +++ b/core/docz-core/src/utils/open-browser.ts @@ -0,0 +1,127 @@ +/* tslint:disable */ +/** + * Copyright (c) 2015-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +'use strict' + +var chalk = require('chalk') +var execSync = require('child_process').execSync +var spawn = require('cross-spawn') +var opn = require('opn') + +// https://github.com/sindresorhus/opn#app +var OSX_CHROME = 'google chrome' + +const Actions = Object.freeze({ + NONE: 0, + BROWSER: 1, + SCRIPT: 2, +}) + +function getBrowserEnv() { + // Attempt to honor this environment variable. + // It is specific to the operating system. + // See https://github.com/sindresorhus/opn#app for documentation. + const value = process.env.BROWSER + let action + if (!value) { + // Default. + action = Actions.BROWSER + } else if (value.toLowerCase().endsWith('.js')) { + action = Actions.SCRIPT + } else if (value.toLowerCase() === 'none') { + action = Actions.NONE + } else { + action = Actions.BROWSER + } + return { action, value } +} + +function executeNodeScript(scriptPath: any, url: any) { + const extraArgs = process.argv.slice(2) + const child = spawn('node', [scriptPath, ...extraArgs, url], { + stdio: 'inherit', + }) + child.on('close', (code: any) => { + if (code !== 0) { + console.log() + console.log( + chalk.red( + 'The script specified as BROWSER environment variable failed.' + ) + ) + console.log(chalk.cyan(scriptPath) + ' exited with code ' + code + '.') + console.log() + return + } + }) + return true +} + +function startBrowserProcess(browser: any, url: any) { + // If we're on OS X, the user hasn't specifically + // requested a different browser, we can try opening + // Chrome with AppleScript. This lets us reuse an + // existing tab when possible instead of creating a new one. + const shouldTryOpenChromeWithAppleScript = + process.platform === 'darwin' && + (typeof browser !== 'string' || browser === OSX_CHROME) + + if (shouldTryOpenChromeWithAppleScript) { + try { + // Try our best to reuse existing tab + // on OS X Google Chrome with AppleScript + execSync('ps cax | grep "Google Chrome"') + execSync('osascript openChrome.applescript "' + encodeURI(url) + '"', { + cwd: __dirname, + stdio: 'ignore', + }) + return true + } catch (err) { + // Ignore errors. + } + } + + // Another special case: on OS X, check if BROWSER has been set to "open". + // In this case, instead of passing `open` to `opn` (which won't work), + // just ignore it (thus ensuring the intended behavior, i.e. opening the system browser): + // https://github.com/facebook/create-react-app/pull/1690#issuecomment-283518768 + if (process.platform === 'darwin' && browser === 'open') { + browser = undefined + } + + // Fallback to opn + // (It will always open new tab) + try { + var options = { app: browser, wait: false } + opn(url, options).catch(() => {}) // Prevent `unhandledRejection` error. + return true + } catch (err) { + return false + } +} + +/** + * Reads the BROWSER environment variable and decides what to do with it. Returns + * true if it opened a browser or ran a node.js script, otherwise false. + */ +export function openBrowser(url: any) { + const { action, value } = getBrowserEnv() + switch (action) { + case Actions.NONE: + // Special case: BROWSER="none" will prevent opening completely. + return false + case Actions.SCRIPT: + return executeNodeScript(value, url) + case Actions.BROWSER: + return startBrowserProcess(value, url) + default: + throw new Error('Not implemented.') + } +} + +// module.exports = openBrowser From 8db9eb70a06c3adb769e4742423a259c60d951f3 Mon Sep 17 00:00:00 2001 From: Wee Date: Tue, 9 Apr 2019 15:03:11 +0800 Subject: [PATCH 2/2] fix(docz-core): optional open browser when starting dev --- core/docz-core/src/commands/dev.ts | 2 +- core/docz-core/src/config/argv.ts | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/core/docz-core/src/commands/dev.ts b/core/docz-core/src/commands/dev.ts index 9b3c06552..490149431 100644 --- a/core/docz-core/src/commands/dev.ts +++ b/core/docz-core/src/commands/dev.ts @@ -41,7 +41,7 @@ export const dev = async (args: Arguments) => { try { await dataServer.start() - openBrowser(`http://${config.host}:${config.port}`) + if (args.open || args.o) openBrowser(`http://${config.host}:${config.port}`) } catch (err) { logger.fatal('Failed to process data server') logger.error(err) diff --git a/core/docz-core/src/config/argv.ts b/core/docz-core/src/config/argv.ts index 23f348bfe..fe0027939 100644 --- a/core/docz-core/src/config/argv.ts +++ b/core/docz-core/src/config/argv.ts @@ -203,4 +203,10 @@ export const setArgs = (yargs: Yargs) => { type: 'string', default: getEnv('docz.separator', '-'), }) + .option('open', { + alias: 'o', + describe: 'auto open browser in dev mode', + type: 'boolean', + default: false, + }) }