feat: added ux.open()

README.md

@@ -50,6 +50,14 @@ await cli.prompt('sometext', 'https://google.com')
 
 ![url demo](assets/url.gif)
 
+# cli.open
+
+Open a url in the browser
+
+```typescript
+await cli.open('https://oclif.io')
+```
+
 # cli.action
 
 Shows a spinner

examples/open.ts

@@ -0,0 +1,3 @@
+import ux from '../src'
+
+ux.open('https://oclif.io')

package.json

@@ -15,6 +15,7 @@
     "fs-extra": "^6.0.1",
     "hyperlinker": "^1.0.0",
     "indent-string": "^3.2.0",
+    "is-wsl": "^1.1.0",
     "lodash": "^4.17.10",
     "password-prompt": "^1.0.6",
     "semver": "^5.5.0",

src/deps.ts

@@ -2,6 +2,7 @@ import screen = require('@oclif/screen')
 import ansiStyles = require('ansi-styles')
 import stripAnsi = require('strip-ansi')
 
+import open = require('./open')
 import prompt = require('./prompt')
 import styledHeader = require('./styled/header')
 import styledJSON = require('./styled/json')
@@ -15,6 +16,7 @@ export const deps = {
   get passwordPrompt(): any { return fetch('password-prompt') },
   get screen(): typeof screen { return fetch('@oclif/screen') },
 
+  get open(): typeof open.default { return fetch('./open').default },
   get prompt(): typeof prompt.default { return fetch('./prompt').default },
   get styledObject(): typeof styledObject.default { return fetch('./styled/object').default },
   get styledHeader(): typeof styledHeader.default { return fetch('./styled/header').default },

src/index.ts

@@ -22,6 +22,7 @@ export const ux = {
   get styledHeader() { return deps.styledHeader },
   get styledJSON() { return deps.styledJSON },
   get table() { return deps.table },
+  get open() { return deps.open },
 
   async done() {
     config.action.stop()

src/open.ts

@@ -0,0 +1,93 @@
+// this code is largely taken from opn
+import * as childProcess from 'child_process'
+import * as path from 'path'
+const isWsl = require('is-wsl')
+
+export namespace open {
+  export interface Options {
+    // wait: boolean
+    app?: string | string[]
+  }
+}
+
+export default function open(target: string, opts: open.Options = {}) {
+  // opts = {wait: true, ...opts}
+
+  let cmd
+  let appArgs: string[] = []
+  let args: string[] = []
+  const cpOpts: childProcess.SpawnOptions = {}
+
+  if (Array.isArray(opts.app)) {
+    appArgs = opts.app.slice(1)
+    opts.app = opts.app[0]
+  }
+
+  if (process.platform === 'darwin') {
+    cmd = 'open'
+
+    // if (opts.wait) {
+    //   args.push('-W')
+    // }
+
+    if (opts.app) {
+      args.push('-a', opts.app)
+    }
+  } else if (process.platform === 'win32' || isWsl) {
+    cmd = 'cmd' + (isWsl ? '.exe' : '')
+    args.push('/c', 'start', '""', '/b')
+    target = target.replace(/&/g, '^&')
+
+    // if (opts.wait) {
+    //   args.push('/wait')
+    // }
+
+    if (opts.app) {
+      args.push(opts.app)
+    }
+
+    if (appArgs.length > 0) {
+      args = args.concat(appArgs)
+    }
+  } else {
+    if (opts.app) {
+      cmd = opts.app
+    } else {
+      cmd = process.platform === 'android' ? 'xdg-open' : path.join(__dirname, 'xdg-open')
+    }
+
+    if (appArgs.length > 0) {
+      args = args.concat(appArgs)
+    }
+
+    // if (!opts.wait) {
+    // `xdg-open` will block the process unless
+    // stdio is ignored and it's detached from the parent
+    // even if it's unref'd
+    cpOpts.stdio = 'ignore'
+    cpOpts.detached = true
+    // }
+  }
+
+  args.push(target)
+
+  if (process.platform === 'darwin' && appArgs.length > 0) {
+    args.push('--args')
+    args = args.concat(appArgs)
+  }
+
+  const cp = childProcess.spawn(cmd, args, cpOpts)
+
+  return new Promise((resolve, reject) => {
+    cp.once('error', reject)
+
+    cp.once('close', code => {
+      if (code > 0) {
+        reject(new Error('Exited with code ' + code))
+        return
+      }
+
+      resolve(cp)
+    })
+  })
+}

yarn.lock

@@ -813,6 +813,10 @@ is-resolvable@^1.0.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/is-resolvable/-/is-resolvable-1.1.0.tgz#fb18f87ce1feb925169c9a407c19318a3206ed88"
 
+is-wsl@^1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/is-wsl/-/is-wsl-1.1.0.tgz#1f16e4aa22b04d1336b66188a66af3c600c3a66d"
+
 [email protected]:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/isarray/-/isarray-0.0.1.tgz#8a18acfca9a8f4177e09abfc6038939b05d1eedf"