Replace npmlog with consola (#829)

mapbox · Nov 27, 2024 · 1159038 · 1159038
1 parent 095bd4a
commit 1159038
Show file tree

Hide file tree

Showing 14 changed files with 37 additions and 106 deletions.
diff --git a/lib/info.js b/lib/info.js
@@ -4,7 +4,7 @@ module.exports = exports = info;
 
 exports.usage = 'Lists all published binaries (requires aws-sdk)';
 
-const log = require('npmlog');
+const log = require('./util/log.js');
 const versioning = require('./util/versioning.js');
 const s3_setup = require('./util/s3_setup.js');
 

diff --git a/lib/install.js b/lib/install.js
@@ -6,7 +6,7 @@ exports.usage = 'Attempts to install pre-built binary for module';
 
 const fs = require('fs');
 const path = require('path');
-const log = require('npmlog');
+const log = require('./util/log.js');
 const existsAsync = fs.exists || path.exists;
 const versioning = require('./util/versioning.js');
 const napi = require('./util/napi.js');
@@ -24,7 +24,7 @@ try {
 }
 
 function place_binary(uri, targetDir, opts, callback) {
-  log.http('GET', uri);
+  log.log('GET', uri);
 
   // Try getting version info from the currently running npm.
   const envVersionInfo = process.env.npm_config_user_agent ||
@@ -57,7 +57,7 @@ function place_binary(uri, targetDir, opts, callback) {
   if (proxyUrl) {
     const ProxyAgent = require('https-proxy-agent');
     agent = new ProxyAgent(proxyUrl);
-    log.http('download', 'proxy agent configured using: "%s"', proxyUrl);
+    log.log('download', `proxy agent configured using: "${proxyUrl}"`);
   }
 
   fetch(sanitized, { agent })
@@ -71,7 +71,7 @@ function place_binary(uri, targetDir, opts, callback) {
         let extractions = 0;
         const countExtractions = (entry) => {
           extractions += 1;
-          log.info('install', 'unpacking %s', entry.path);
+          log.info('install', `unpacking ${entry.path}`);
         };
 
         dataStream.pipe(extract(targetDir, countExtractions))
@@ -148,7 +148,7 @@ function print_fallback_error(err, opts, package_json) {
     full_message += fallback_message;
     log.warn('Tried to download(' + err.statusCode + '): ' + opts.hosted_tarball);
     log.warn(full_message);
-    log.http(err.message);
+    log.error(err.message);
   } else {
     // If we do not have a statusCode that means an unexpected error
     // happened and prevented an http response, so we output the exact error

diff --git a/lib/main.js b/lib/main.js
@@ -7,7 +7,7 @@
 process.title = 'node-pre-gyp';
 
 const node_pre_gyp = require('../');
-const log = require('npmlog');
+const log = require('./util/log.js');
 
 /**
  * Process and execute the selected commands.
@@ -35,8 +35,8 @@ if (prog.opts && Object.hasOwnProperty.call(prog, 'color') && !prog.opts.color)
 
 log.info('it worked if it ends with', 'ok');
 log.verbose('cli', process.argv);
-log.info('using', process.title + '@%s', prog.version);
-log.info('using', 'node@%s | %s | %s', process.versions.node, process.platform, process.arch);
+log.info(`using ${process.title}@${prog.version}`);
+log.info(`using node@${process.versions.node} | ${process.platform} | ${process.arch} `);
 
 
 /**
@@ -58,7 +58,7 @@ if (dir) {
     if (e.code === 'ENOENT') {
       log.warn('chdir', dir + ' is not a directory');
     } else {
-      log.warn('chdir', 'error during chdir() "%s"', e.message);
+      log.warn('chdir', `error during chdir() "${e.message}"`);
     }
   }
 }

diff --git a/lib/node-pre-gyp.js b/lib/node-pre-gyp.js
@@ -20,8 +20,7 @@ const mocking = exports.mockS3Http('get');
 const fs = require('fs');
 const path = require('path');
 const nopt = require('nopt');
-const log = require('npmlog');
-log.disableProgress();
+const log = require('./util/log.js');
 const napi = require('./util/napi.js');
 
 const EE = require('events').EventEmitter;
@@ -43,9 +42,6 @@ const cli_commands = [
 ];
 const aliases = {};
 
-// differentiate node-pre-gyp's logs from npm's
-log.heading = 'node-pre-gyp';
-
 if (mocking) {
   log.warn(`mocking s3 to ${process.env.node_pre_gyp_mock_s3}`);
 }

diff --git a/lib/package.js b/lib/package.js
@@ -6,7 +6,7 @@ exports.usage = 'Packs binary (and enclosing directory) into locally staged tarb
 
 const fs = require('fs');
 const path = require('path');
-const log = require('npmlog');
+const log = require('./util/log.js');
 const versioning = require('./util/versioning.js');
 const napi = require('./util/napi.js');
 const existsAsync = fs.exists || path.exists;

diff --git a/lib/publish.js b/lib/publish.js
@@ -6,7 +6,7 @@ exports.usage = 'Publishes pre-built binary (requires aws-sdk)';
 
 const fs = require('fs');
 const path = require('path');
-const log = require('npmlog');
+const log = require('./util/log.js');
 const versioning = require('./util/versioning.js');
 const napi = require('./util/napi.js');
 const s3_setup = require('./util/s3_setup.js');

diff --git a/lib/testbinary.js b/lib/testbinary.js
@@ -5,7 +5,7 @@ module.exports = exports = testbinary;
 exports.usage = 'Tests that the binary.node can be required';
 
 const path = require('path');
-const log = require('npmlog');
+const log = require('./util/log.js');
 const cp = require('child_process');
 const versioning = require('./util/versioning.js');
 const napi = require('./util/napi.js');

diff --git a/lib/testpackage.js b/lib/testpackage.js
@@ -6,7 +6,7 @@ exports.usage = 'Tests that the staged package is valid';
 
 const fs = require('fs');
 const path = require('path');
-const log = require('npmlog');
+const log = require('./util/log.js');
 const existsAsync = fs.exists || path.exists;
 const versioning = require('./util/versioning.js');
 const napi = require('./util/napi.js');

diff --git a/lib/unpublish.js b/lib/unpublish.js
@@ -4,7 +4,7 @@ module.exports = exports = unpublish;
 
 exports.usage = 'Unpublishes pre-built binary (requires aws-sdk)';
 
-const log = require('npmlog');
+const log = require('./util/log.js');
 const versioning = require('./util/versioning.js');
 const napi = require('./util/napi.js');
 const s3_setup = require('./util/s3_setup.js');

diff --git a/lib/util/log.js b/lib/util/log.js
@@ -0,0 +1,9 @@
+'use strict';
+
+const { createConsola } = require('consola/basic');
+
+// match the default behavior of npm and node-gyp  where stdout is reserved for output that is expected
+// to be used programmatically (usually json)
+const log = createConsola({ stdout: process.stderr });
+
+module.exports = exports = log;
diff --git a/lib/util/napi.js b/lib/util/napi.js
@@ -113,7 +113,7 @@ module.exports.expand_commands = function(package_json, opts, commands) {
 };
 
 module.exports.get_napi_build_versions = function(package_json, opts, warnings) { // opts may be undefined
-  const log = require('npmlog');
+  const log = require('./log.js');
   let napi_build_versions = [];
   const supported_napi_version = module.exports.get_napi_version(opts ? opts.target : undefined);
   // remove duplicates, verify each napi version can actually be built

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -23,11 +23,11 @@
     "node": ">=18"
   },
   "dependencies": {
+    "consola": "^3.2.3",
     "detect-libc": "^2.0.0",
     "https-proxy-agent": "^5.0.0",
     "node-fetch": "^2.6.7",
     "nopt": "^8.0.0",
-    "npmlog": "^7.0.1",
     "semver": "^7.5.3",
     "tar": "^7.4.0"
   },

diff --git a/test/build.test.js b/test/build.test.js
@@ -137,8 +137,7 @@ apps.forEach((app) => {
   test(app.name + ' configures with unparsed options ' + app.args, (t) => {
     run('node-pre-gyp', 'configure', '--loglevel=info -- -Dfoo=bar', app, {}, (err, stdout, stderr) => {
       t.ifError(err);
-      const clean = stdout.replaceAll('\n', '');
-      t.equal(clean, '');
+      t.equal(stderr.trim().slice(-2), 'ok');
       t.ok(stderr.search(/(gyp info spawn args).*(-Dfoo=bar)/) > -1);
       t.end();
     });