feat(logger): add GHA-aware notices/warnings

.eslintrc

@@ -20,7 +20,10 @@
      * We should be returning Promise-wrapped values in our main command functions
      * so we can write robust tests and take advantage of `bin/rdme`,
      * which we use for printing function outputs and returning correct exit codes.
+     *
+     * Furthermore, we should also be using our custom loggers (see src/lib/logger.js)
+     * instead of using console.info() or console.warn() statements.
      */
-    "no-console": ["warn", { "allow": ["info", "warn"] }]
+    "no-console": ["warn"]
   }
 }

__tests__/cmds/docs.test.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const nock = require('nock');
 const chalk = require('chalk');
 const fs = require('fs');

__tests__/cmds/openapi.test.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const nock = require('nock');
 const chalk = require('chalk');
 const config = require('config');

__tests__/cmds/validate.test.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const fs = require('fs');
 const chalk = require('chalk');
 const Command = require('../../src/cmds/validate');

__tests__/lib/fetch.test.js

@@ -9,6 +9,7 @@ describe('#fetch()', () => {
     // List of all GitHub Actions env variables:
     // https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
     beforeEach(() => {
+      process.env.GITHUB_ACTION = '__repo-owner_name-of-action-repo';
       process.env.GITHUB_ACTIONS = 'true';
       process.env.GITHUB_REPOSITORY = 'octocat/Hello-World';
       process.env.GITHUB_RUN_ATTEMPT = '3';
@@ -18,6 +19,7 @@ describe('#fetch()', () => {
     });
 
     afterEach(() => {
+      delete process.env.GITHUB_ACTION;
       delete process.env.GITHUB_ACTIONS;
       delete process.env.GITHUB_REPOSITORY;
       delete process.env.GITHUB_RUN_ATTEMPT;

package.json

@@ -35,6 +35,7 @@
   },
   "dependencies": {
     "@actions/core": "^1.6.0",
+    "@npmcli/ci-detect": "^2.0.0",
     "chalk": "^4.1.2",
     "cli-table": "^0.3.1",
     "command-line-args": "^5.2.0",

src/cmds/docs/edit.js

@@ -6,7 +6,7 @@ const APIError = require('../../lib/apiError');
 const { getProjectVersion } = require('../../lib/versionSelect');
 const fetch = require('../../lib/fetch');
 const { cleanHeaders, handleRes } = require('../../lib/fetch');
-const { debug } = require('../../lib/logger');
+const { debug, info } = require('../../lib/logger');
 
 const writeFile = promisify(fs.writeFile);
 const readFile = promisify(fs.readFile);
@@ -101,7 +101,7 @@ module.exports = class EditDocsCommand {
             if (res.error) {
               return reject(new APIError(res));
             }
-            console.info('Doc successfully updated. Cleaning up local file.');
+            info('Doc successfully updated. Cleaning up local file.');
             await unlink(filename);
             debug('file unlinked');
             // Normally we should resolve with a value that is logged to the console,

src/cmds/openapi.js

@@ -2,7 +2,7 @@ const APIError = require('../lib/apiError');
 const chalk = require('chalk');
 const { cleanHeaders } = require('../lib/fetch');
 const config = require('config');
-const { debug, oraOptions } = require('../lib/logger');
+const { debug, warn, oraOptions } = require('../lib/logger');
 const fetch = require('../lib/fetch');
 const { handleRes } = require('../lib/fetch');
 const { getProjectVersion } = require('../lib/versionSelect');
@@ -66,12 +66,10 @@ module.exports = class OpenAPICommand {
     }
 
     if (version && id) {
-      console.warn(
-        chalk.yellow(
-          `⚠️  Warning! We'll be using the version associated with the \`--${
-            opts.token ? 'token' : 'id'
-          }\` option, so the \`--version\` option will be ignored.`
-        )
+      warn(
+        `We'll be using the version associated with the \`--${
+          opts.token ? 'token' : 'id'
+        }\` option, so the \`--version\` option will be ignored.`
       );
     }
 

src/cmds/swagger.js

@@ -1,6 +1,5 @@
-const chalk = require('chalk');
 const OpenAPICommand = require('./openapi');
-const { debug } = require('../lib/logger');
+const { debug, warn } = require('../lib/logger');
 
 module.exports = class SwaggerCommand extends OpenAPICommand {
   constructor() {
@@ -16,7 +15,7 @@ module.exports = class SwaggerCommand extends OpenAPICommand {
     debug(`command: ${this.command}`);
     debug(`opts: ${JSON.stringify(opts)}`);
 
-    console.warn(chalk.yellow('⚠️  Warning! `rdme swagger` has been deprecated. Please use `rdme openapi` instead.'));
+    warn('`rdme swagger` has been deprecated. Please use `rdme openapi` instead.');
     return super.run(opts);
   }
 };

src/lib/isGitHub.js

@@ -1,7 +1,9 @@
+const ciDetect = require('@npmcli/ci-detect');
+
 /**
  * Small env check to determine if we're in a GitHub Actions environment
  * @link https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
  */
 module.exports = function isGHA() {
-  return process.env.GITHUB_ACTIONS === 'true';
+  return ciDetect() === 'github-actions';
 };

src/lib/logger.js

@@ -1,3 +1,4 @@
+const chalk = require('chalk');
 const config = require('config');
 const core = require('@actions/core');
 const debugPackage = require('debug')(config.get('cli'));
@@ -13,6 +14,28 @@ module.exports.debug = function debug(input) {
   return debugPackage(input);
 };
 
+/**
+ * Wrapper for warn statements.
+ * @param {String} input
+ */
+module.exports.warn = function warn(input) {
+  /* istanbul ignore next */
+  if (isGHA() && process.env.NODE_ENV !== 'testing') return core.warning(input);
+  // eslint-disable-next-line no-console
+  return console.warn(chalk.yellow(`⚠️  Warning! ${input}`));
+};
+
+/**
+ * Wrapper for info/notice statements.
+ * @param {String} input
+ */
+module.exports.info = function info(input) {
+  /* istanbul ignore next */
+  if (isGHA() && process.env.NODE_ENV !== 'testing') return core.notice(input);
+  // eslint-disable-next-line no-console
+  return console.info(input);
+};
+
 module.exports.oraOptions = function oraOptions() {
   // Disables spinner in tests so it doesn't pollute test output
   const opts = { isSilent: process.env.NODE_ENV === 'testing' };

src/lib/prepareOas.js

@@ -3,7 +3,7 @@ const fs = require('fs');
 const OASNormalize = require('oas-normalize');
 const ora = require('ora');
 
-const { debug, oraOptions } = require('./logger');
+const { debug, info, oraOptions } = require('./logger');
 
 /**
  * Normalizes, validates, and (optionally) bundles an OpenAPI definition.
@@ -27,7 +27,7 @@ module.exports = async function prepare(path, command) {
           return;
         }
 
-        console.info(
+        info(
           chalk.yellow(`We found ${file} and are attempting to ${command === 'openapi' ? 'upload' : 'validate'} it.`)
         );
         resolve(file);