@browserless/cli 9.9.8 → 9.10.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2019 Microlink <hello@microlink.io> (microlink.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/package.json

@@ -2,7 +2,7 @@
   "name": "@browserless/cli",
   "description": "CLI to interact with Browserless capabilities",
   "homepage": "https://browserless.js.org",
-  "version": "9.9.8",
+  "version": "9.10.0",
   "bin": {
     "browserless": "src/index.js"
   },
@@ -36,10 +36,11 @@
     "dark-mode": "~3.0.0",
     "lodash": "~4.17.21",
     "meow": "~9.0.0",
-    "ora": "~5.4.1",
+    "nanospinner": "~1.1.0",
     "picocolors": "~1.0.0",
     "pretty-bytes": "~5.6.0",
     "process-stats": "~3.7.0",
+    "restore-cursor": "~3.1.0",
     "signal-exit": "~4.0.1",
     "term-img": "~5.0.0",
     "unique-random-array": "~2.0.0"
@@ -55,5 +56,5 @@
     "test": "exit 0"
   },
   "license": "MIT",
-  "gitHead": "26bcbf5732cc81ca6b998f4a22060ca84225c0dd"
+  "gitHead": "c7e170ee4c1ab15de1031d9e6f7af4f04b7a03ab"
 }

package/src/commands/goto.js

@@ -1,9 +1,6 @@
 'use strict'
 
-const { setTimeout } = require('timers/promises')
-
 module.exports = async ({ url, browserless, opts }) => {
   const page = await browserless.page()
-  await browserless.goto(page, { url, ...opts })
-  await setTimeout(8.64e7)
+  return [await browserless.goto(page, { url, ...opts })]
 }

package/src/commands/html.js

@@ -1,6 +1,6 @@
 'use strict'
 
 module.exports = async ({ url, browserless, opts }) => {
-  const result = await browserless.html(url, opts)
-  return result
+  const html = await browserless.html(url, opts)
+  return [html]
 }

package/src/commands/lighthouse.js

@@ -1,9 +1,14 @@
 'use strict'
 
-const lighthouse = require('../../../lighthouse/src')
+const createLighthouse = require('../../../lighthouse/src')
 
 module.exports = async ({ url, browserless, opts }) => {
-  const getBrowserless = () => browserless
-  const report = await lighthouse(url, { getBrowserless, ...opts })
-  return JSON.stringify(report, null, 2)
+  const lighthouse = createLighthouse(async teardown => {
+    teardown(() => browserless.destroyContext())
+    return browserless
+  })
+
+  const report = await lighthouse(url)
+
+  return [JSON.stringify(report), JSON.stringify(report, null, 2)]
 }

package/src/commands/pdf.js

@@ -1,6 +1,3 @@
 'use strict'
 
-module.exports = async ({ url, browserless, opts }) => {
-  const result = await browserless.pdf(url, opts)
-  return result
-}
+module.exports = async ({ url, browserless, opts }) => [await browserless.pdf(url, opts)]

package/src/commands/ping.js

@@ -15,5 +15,5 @@ module.exports = async ({ url, browserless, opts }) => {
 
   const result = await ping(url, opts)
 
-  return result
+  return [JSON.stringify(result), JSON.stringify(result, null, 2)]
 }

package/src/commands/screenshot.js

@@ -56,5 +56,5 @@ module.exports = async ({ url, browserless, opts }) => {
 
   const screenshot = await browserless.screenshot(url, opts)
 
-  return termImg(screenshot, { width: '50%' })
+  return [screenshot, termImg(Buffer.from(screenshot), { width: '50%' })]
 }

package/src/commands/status.js

@@ -5,5 +5,5 @@ module.exports = async ({ url, browserless, opts }) => {
   const response = await page.goto(url, opts)
   const status = response.status()
   await page.close()
-  return status
+  return [JSON.stringify(status), JSON.stringify(status, null, 2)]
 }

package/src/commands/text.js

@@ -2,5 +2,5 @@
 
 module.exports = async ({ url, browserless, opts }) => {
   const result = await browserless.text(url, opts)
-  return result
+  return [result]
 }

package/src/index.js

@@ -2,6 +2,7 @@
 
 'use strict'
 
+const restoreCursor = require('restore-cursor')
 const createBrowser = require('browserless')
 const beautyError = require('beauty-error')
 const { onExit } = require('signal-exit')
@@ -10,15 +11,12 @@ const fs = require('fs')
 
 const commands = fs.readdirSync(path.resolve(__dirname, 'commands'))
 
-const { HEADLESS } = process.env
-
 const cli = require('meow')({
   pkg: require('../package.json'),
   help: require('./help')(commands),
   flags: {
     headless: {
-      type: 'boolean',
-      default: HEADLESS !== undefined ? HEADLESS === 'true' : true
+      default: 'new'
     },
     codeScheme: {
       type: 'string',
@@ -35,32 +33,32 @@ const { verbose, headless } = cli.flags
 
 const spinner = verbose ? require('./spinner') : { start: () => {}, stop: () => {} }
 
+process.on('SIGINT', () => {
+  spinner.stop({ force: true })
+  process.exit(1)
+})
+
 const run = async () => {
   if (cli.input.length === 0) return cli.showHelp()
   spinner.start()
   const [command, rawUrl] = cli.input
   const url = new URL(rawUrl).toString()
   const fn = require(`./commands/${command}`)
-
   const browser = createBrowser({ headless })
-  const browserless = await browser.createContext()
-
   onExit(browser.close)
-
-  const result = await fn({ url, browserless, opts: cli.flags })
-
-  return result
+  const browserless = await browser.createContext()
+  return fn({ url, browserless, opts: cli.flags })
 }
 
 run()
-  .then(result => {
-    const stats = spinner.stop(result)
-    if (result) console.log(result)
-    if (stats) console.error(`\n${stats}`)
+  .then(([result, preview = result]) => {
+    spinner.stop({ result })
+    if (typeof preview === 'string') console.log(preview)
     process.exit()
   })
   .catch(error => {
-    spinner.stop()
+    spinner.clear()
+    restoreCursor()
     console.error(beautyError(error))
     process.exit(1)
   })

package/src/spinner.js

@@ -1,9 +1,9 @@
 'use strict'
 
 const createProcStats = require('process-stats')
+const { createSpinner } = require('nanospinner')
 const prettyBytes = require('pretty-bytes')
 const { gray } = require('picocolors')
-const ora = require('ora')
 
 const TICK_INTERVAL = 100
 const procStats = createProcStats({ tick: TICK_INTERVAL })
@@ -13,31 +13,34 @@ const stats = () => {
   const time = `time${gray(`=${uptime.pretty}`)}`
   const cpu = `cpu${gray(`=${cpuUsage.pretty}`)}`
   const memory = `memory${gray(`=${memUsed.pretty}`)}`
-
   return `${time} ${cpu} ${memory}`
 }
 
-const spinner = ora({
-  color: 'white'
-})
+const spinner = createSpinner(stats(), { color: 'white' })
 let timer
 
 const start = () => {
   console.log()
-  spinner.start()
-
+  spinner.start(stats())
   timer = setInterval(() => {
-    spinner.text = stats()
+    spinner.update({ text: stats() })
   }, TICK_INTERVAL)
 }
 
-const stop = (str = '') => {
-  spinner.stop()
-  clearInterval(timer)
-  const sizeValue = `=${prettyBytes(Buffer.from(JSON.stringify(str)).byteLength)}`
-  const info = `${stats()} size=${gray(sizeValue)}`
+const stop = ({ result, force = false } = {}) => {
+  if (force) {
+    spinner.error({ text: stats() })
+  } else {
+    const sizeValue = `=${prettyBytes(Buffer.from(result).length)}`
+    const text = `${stats()} size=${gray(sizeValue)}\n`
+    spinner.success({ text })
+  }
   procStats.destroy()
-  return info
+  clearInterval(timer)
 }
 
-module.exports = { start, stop }
+module.exports = {
+  ...spinner,
+  start,
+  stop
+}