From 85a8694dd9b4a924a474ba75261914511a216868 Mon Sep 17 00:00:00 2001
From: Gar <gar+gh@danger.computer>
Date: Sun, 28 Feb 2021 19:00:58 -0800
Subject: fix(npm.output): make output go through npm.output

All output that anything wants to make now goes through
`npm.output()`.  This is an incremental change getting us
closer to where we want to be with testing.

PR-URL: https://github.com/npm/cli/pull/2795
Credit: @wraithgar
Close: #2795
Reviewed-by: @ruyadorno, @isaacs
---
 lib/utils/audit-error.js  |  5 ++---
 lib/utils/npm-usage.js    |  5 ++---
 lib/utils/open-url.js     |  3 +--
 lib/utils/output.js       |  7 -------
 lib/utils/reify-output.js | 17 ++++++++---------
 5 files changed, 13 insertions(+), 24 deletions(-)
 delete mode 100644 lib/utils/output.js

(limited to 'lib/utils')

diff --git a/lib/utils/audit-error.js b/lib/utils/audit-error.js
index ae0749ff6..c58c1d16e 100644
--- a/lib/utils/audit-error.js
+++ b/lib/utils/audit-error.js
@@ -3,7 +3,6 @@
 // prints a JSON version of the error if it's --json
 // returns 'true' if there was an error, false otherwise
 
-const output = require('./output.js')
 const auditError = (npm, report) => {
   if (!report || !report.error)
     return false
@@ -18,7 +17,7 @@ const auditError = (npm, report) => {
   const { body: errBody } = error
   const body = Buffer.isBuffer(errBody) ? errBody.toString() : errBody
   if (npm.flatOptions.json) {
-    output(JSON.stringify({
+    npm.output(JSON.stringify({
       message: error.message,
       method: error.method,
       uri: error.uri,
@@ -27,7 +26,7 @@ const auditError = (npm, report) => {
       body,
     }, null, 2))
   } else
-    output(body)
+    npm.output(body)
 
   throw 'audit endpoint returned an error'
 }
diff --git a/lib/utils/npm-usage.js b/lib/utils/npm-usage.js
index 220f8037f..b77bca7be 100644
--- a/lib/utils/npm-usage.js
+++ b/lib/utils/npm-usage.js
@@ -1,6 +1,5 @@
 const didYouMean = require('./did-you-mean.js')
 const { dirname } = require('path')
-const output = require('./output.js')
 const { cmdList } = require('./cmd-list')
 
 module.exports = (npm, valid = true) => {
@@ -8,7 +7,7 @@ module.exports = (npm, valid = true) => {
   const usesBrowser = npm.config.get('viewer') === 'browser'
     ? ' (in a browser)' : ''
   npm.log.level = 'silent'
-  output(`
+  npm.output(`
 Usage: npm <command>
 
 npm install        install all the dependencies in your project
@@ -34,7 +33,7 @@ npm@${npm.version} ${dirname(dirname(__dirname))}
 `)
 
   if (npm.argv.length >= 1)
-    output(didYouMean(npm.argv[0], cmdList))
+    npm.output(didYouMean(npm.argv[0], cmdList))
 
   if (!valid)
     process.exitCode = 1
diff --git a/lib/utils/open-url.js b/lib/utils/open-url.js
index 1fe456bd0..41fac33ec 100644
--- a/lib/utils/open-url.js
+++ b/lib/utils/open-url.js
@@ -1,4 +1,3 @@
-const output = require('./output.js')
 const opener = require('opener')
 
 const { URL } = require('url')
@@ -16,7 +15,7 @@ const open = async (npm, url, errMsg) => {
       }, null, 2)
       : `${errMsg}:\n  ${url}\n`
 
-    output(alternateMsg)
+    npm.output(alternateMsg)
   }
 
   if (browser === false) {
diff --git a/lib/utils/output.js b/lib/utils/output.js
deleted file mode 100644
index 2d1549859..000000000
--- a/lib/utils/output.js
+++ /dev/null
@@ -1,7 +0,0 @@
-const log = require('npmlog')
-// output to stdout in a progress bar compatible way
-module.exports = (...msg) => {
-  log.clearProgress()
-  console.log(...msg)
-  log.showProgress()
-}
diff --git a/lib/utils/reify-output.js b/lib/utils/reify-output.js
index 216f0e902..ddad32121 100644
--- a/lib/utils/reify-output.js
+++ b/lib/utils/reify-output.js
@@ -10,7 +10,6 @@
 //   run `npm audit fix` to fix them, or `npm audit` for details
 
 const log = require('npmlog')
-const output = require('./output.js')
 const { depth } = require('treeverse')
 const ms = require('ms')
 const auditReport = require('npm-audit-report')
@@ -72,10 +71,10 @@ const reifyOutput = (npm, arb) => {
       summary.audit = npm.command === 'audit' ? auditReport
         : auditReport.toJSON().metadata
     }
-    output(JSON.stringify(summary, 0, 2))
+    npm.output(JSON.stringify(summary, 0, 2))
   } else {
     packagesChangedMessage(npm, summary)
-    packagesFundingMessage(summary)
+    packagesFundingMessage(npm, summary)
     printAuditReport(npm, auditReport)
   }
 }
@@ -98,7 +97,7 @@ const printAuditReport = (npm, report) => {
     auditLevel,
   })
   process.exitCode = process.exitCode || res.exitCode
-  output('\n' + res.report)
+  npm.output('\n' + res.report)
 }
 
 const packagesChangedMessage = (npm, { added, removed, changed, audited }) => {
@@ -136,18 +135,18 @@ const packagesChangedMessage = (npm, { added, removed, changed, audited }) => {
     msg.push(`audited ${audited} package${audited === 1 ? '' : 's'}`)
 
   msg.push(` in ${ms(Date.now() - npm.started)}`)
-  output(msg.join(''))
+  npm.output(msg.join(''))
 }
 
-const packagesFundingMessage = ({ funding }) => {
+const packagesFundingMessage = (npm, { funding }) => {
   if (!funding)
     return
 
-  output('')
+  npm.output('')
   const pkg = funding === 1 ? 'package' : 'packages'
   const is = funding === 1 ? 'is' : 'are'
-  output(`${funding} ${pkg} ${is} looking for funding`)
-  output('  run `npm fund` for details')
+  npm.output(`${funding} ${pkg} ${is} looking for funding`)
+  npm.output('  run `npm fund` for details')
 }
 
 module.exports = reifyOutput
-- 
cgit v1.2.3