feat: minor refactor of how we debug and log out data in commands

.eslintrc

@@ -30,15 +30,6 @@
      */
     "class-methods-use-this": ["error", { "exceptMethods": ["run"] }],
 
-    "import/order": ["error", {
-      "alphabetize": {
-        "order": "asc",
-        "caseInsensitive": true
-      },
-      "groups": ["type", "builtin", "external", "internal", "parent", "sibling", "index", "object"],
-      "newlines-between": "always"
-    }],
-
     /**
      * This is a small rule to prevent us from using console.log() statements in our commands.
      *

package.json

@@ -60,7 +60,7 @@
     "update-notifier": "^5.1.0"
   },
   "devDependencies": {
-    "@readme/eslint-config": "^9.0.0",
+    "@readme/eslint-config": "^10.0.0",
     "@readme/oas-examples": "^5.3.0",
     "@types/cli-table": "^0.3.0",
     "@types/command-line-args": "^5.2.0",

src/cmds/categories/create.ts

@@ -7,7 +7,6 @@ import { Headers } from 'node-fetch';
 import Command, { CommandCategories } from '../../lib/baseCommand';
 import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
 import getCategories from '../../lib/getCategories';
-import { debug } from '../../lib/logger';
 import { getProjectVersion } from '../../lib/versionSelect';
 
 interface Category {
@@ -73,7 +72,7 @@ export default class CategoriesCreateCommand extends Command {
 
     const selectedVersion = await getProjectVersion(version, key, false);
 
-    debug(`selectedVersion: ${selectedVersion}`);
+    Command.debug(`selectedVersion: ${selectedVersion}`);
 
     async function matchCategory() {
       const allCategories = await getCategories(key, selectedVersion);

src/cmds/categories/index.ts

@@ -2,7 +2,6 @@ import type { CommandOptions } from '../../lib/baseCommand';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
 import getCategories from '../../lib/getCategories';
-import { debug } from '../../lib/logger';
 import { getProjectVersion } from '../../lib/versionSelect';
 
 export default class CategoriesCommand extends Command {
@@ -32,7 +31,7 @@ export default class CategoriesCommand extends Command {
 
     const selectedVersion = await getProjectVersion(version, key, true);
 
-    debug(`selectedVersion: ${selectedVersion}`);
+    Command.debug(`selectedVersion: ${selectedVersion}`);
 
     const allCategories = await getCategories(key, selectedVersion);
 

src/cmds/changelogs/index.ts

@@ -4,7 +4,6 @@ import chalk from 'chalk';
 import config from 'config';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
-import { debug } from '../../lib/logger';
 import pushDoc, { readdirRecursive } from '../../lib/pushDoc';
 
 export type Options = {
@@ -56,7 +55,7 @@ export default class ChangelogsCommand extends Command {
       file => file.toLowerCase().endsWith('.md') || file.toLowerCase().endsWith('.markdown')
     );
 
-    debug(`number of files: ${files.length}`);
+    Command.debug(`number of files: ${files.length}`);
 
     if (!files.length) {
       return Promise.reject(new Error(`We were unable to locate Markdown files in ${folder}.`));

src/cmds/custompages/index.ts

@@ -4,7 +4,6 @@ import chalk from 'chalk';
 import config from 'config';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
-import { debug } from '../../lib/logger';
 import pushDoc, { readdirRecursive } from '../../lib/pushDoc';
 
 export type Options = {
@@ -59,7 +58,7 @@ export default class CustomPagesCommand extends Command {
         file.toLowerCase().endsWith('.markdown')
     );
 
-    debug(`number of files: ${files.length}`);
+    Command.debug(`number of files: ${files.length}`);
 
     if (!files.length) {
       return Promise.reject(new Error(`We were unable to locate Markdown or HTML files in ${folder}.`));

src/cmds/docs/edit.ts

@@ -11,7 +11,6 @@ import editor from 'editor';
 import APIError from '../../lib/apiError';
 import Command, { CommandCategories } from '../../lib/baseCommand';
 import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
-import { debug, info } from '../../lib/logger';
 import { getProjectVersion } from '../../lib/versionSelect';
 
 const writeFile = promisify(fs.writeFile);
@@ -60,7 +59,7 @@ export default class EditDocsCommand extends Command {
 
     const selectedVersion = await getProjectVersion(version, key, true);
 
-    debug(`selectedVersion: ${selectedVersion}`);
+    Command.debug(`selectedVersion: ${selectedVersion}`);
 
     const filename = `${slug}.md`;
 
@@ -77,15 +76,15 @@ export default class EditDocsCommand extends Command {
 
     await writeFile(filename, existingDoc.body);
 
-    debug(`wrote to local file: ${filename}, opening editor`);
+    Command.debug(`wrote to local file: ${filename}, opening editor`);
 
     return new Promise((resolve, reject) => {
       (opts.mockEditor || editor)(filename, async (code: number) => {
-        debug(`editor closed with code ${code}`);
+        Command.debug(`editor closed with code ${code}`);
         if (code !== 0) return reject(new Error('Non zero exit code from $EDITOR'));
         const updatedDoc = await readFile(filename, 'utf8');
 
-        debug(`read edited contents of ${filename}, sending to ReadMe`);
+        Command.debug(`read edited contents of ${filename}, sending to ReadMe`);
 
         return fetch(`${config.get('host')}/api/v1/docs/${slug}`, {
           method: 'put',
@@ -104,16 +103,19 @@ export default class EditDocsCommand extends Command {
         })
           .then(res => res.json())
           .then(async res => {
-            debug(`response from PUT request: ${res}`);
+            Command.debug(`response from PUT request: ${res}`);
             // The reason we aren't using our handleRes() function here is
             // because we need to use the `reject` function from
             // the Promise that's wrapping this function.
             if (res.error) {
               return reject(new APIError(res));
             }
-            info('Doc successfully updated. Cleaning up local file.');
+
+            Command.info('Doc successfully updated. Cleaning up local file.');
+
             await unlink(filename);
-            debug('file unlinked');
+            Command.debug('file unlinked');
+
             // Normally we should resolve with a value that is logged to the console,
             // but since we need to wait for the temporary file to be removed,
             // it's okay to resolve the promise with no value.

src/cmds/docs/index.ts

@@ -4,7 +4,6 @@ import chalk from 'chalk';
 import config from 'config';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
-import { debug } from '../../lib/logger';
 import pushDoc, { readdirRecursive } from '../../lib/pushDoc';
 import { getProjectVersion } from '../../lib/versionSelect';
 
@@ -58,14 +57,14 @@ export default class DocsCommand extends Command {
     // Ideally we should ignore this parameter entirely if the category is included.
     const selectedVersion = await getProjectVersion(version, key, false);
 
-    debug(`selectedVersion: ${selectedVersion}`);
+    Command.debug(`selectedVersion: ${selectedVersion}`);
 
     // Strip out non-markdown files
     const files = readdirRecursive(folder).filter(
       file => file.toLowerCase().endsWith('.md') || file.toLowerCase().endsWith('.markdown')
     );
 
-    debug(`number of files: ${files.length}`);
+    Command.debug(`number of files: ${files.length}`);
 
     if (!files.length) {
       return Promise.reject(new Error(`We were unable to locate Markdown files in ${folder}.`));

src/cmds/docs/single.ts

@@ -4,7 +4,6 @@ import chalk from 'chalk';
 import config from 'config';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
-import { debug } from '../../lib/logger';
 import pushDoc from '../../lib/pushDoc';
 import { getProjectVersion } from '../../lib/versionSelect';
 
@@ -62,7 +61,7 @@ export default class SingleDocCommand extends Command {
     // Ideally we should ignore this parameter entirely if the category is included.
     const selectedVersion = await getProjectVersion(version, key, false);
 
-    debug(`selectedVersion: ${selectedVersion}`);
+    Command.debug(`selectedVersion: ${selectedVersion}`);
 
     const createdDoc = await pushDoc(key, selectedVersion, dryRun, filePath, this.cmdCategory);
 

src/cmds/open.ts

@@ -6,7 +6,6 @@ import open from 'open';
 
 import Command, { CommandCategories } from '../lib/baseCommand';
 import configStore from '../lib/configstore';
-import { debug } from '../lib/logger';
 
 export type Options = {
   mockOpen?: (url: string) => Promise<void>;
@@ -29,7 +28,7 @@ export default class OpenCommand extends Command {
     super.run(opts);
 
     const project = configStore.get('project');
-    debug(`project: ${project}`);
+    Command.debug(`project: ${project}`);
 
     if (!project) {
       return Promise.reject(new Error(`Please login using \`${config.get('cli')} login\`.`));

src/cmds/openapi.ts

@@ -10,7 +10,7 @@ import parse from 'parse-link-header';
 
 import Command, { CommandCategories } from '../lib/baseCommand';
 import fetch, { cleanHeaders, handleRes } from '../lib/fetch';
-import { debug, info, warn, oraOptions } from '../lib/logger';
+import { oraOptions } from '../lib/logger';
 import prepareOas from '../lib/prepareOas';
 import * as promptHandler from '../lib/prompts';
 import streamSpecToRegistry from '../lib/streamSpecToRegistry';
@@ -81,32 +81,36 @@ export default class OpenAPICommand extends Command {
     }
 
     if (version && id) {
-      warn("We'll be using the version associated with the `--id` option, so the `--version` option will be ignored.");
+      Command.warn(
+        "We'll be using the version associated with the `--id` option, so the `--version` option will be ignored."
+      );
     }
 
     // Reason we're hardcoding in command here is because `swagger` command
     // relies on this and we don't want to use `swagger` in this function
     const { bundledSpec, specPath, specType, specVersion } = await prepareOas(spec, 'openapi');
 
     if (useSpecVersion) {
-      info(`Using the version specified in your API definition for your ReadMe project version (${specVersion})`);
+      Command.info(
+        `Using the version specified in your API definition for your ReadMe project version (${specVersion})`
+      );
       selectedVersion = specVersion;
     }
 
     if (!id) {
       selectedVersion = await getProjectVersion(selectedVersion, key, true);
     }
 
-    debug(`selectedVersion: ${selectedVersion}`);
+    Command.debug(`selectedVersion: ${selectedVersion}`);
 
     async function success(data: Response) {
       const message = !isUpdate
         ? `You've successfully uploaded a new ${specType} file to your ReadMe project!`
         : `You've successfully updated an existing ${specType} file on your ReadMe project!`;
 
-      debug(`successful ${data.status} response`);
+      Command.debug(`successful ${data.status} response`);
       const body = await data.json();
-      debug(`successful response payload: ${JSON.stringify(body)}`);
+      Command.debug(`successful response payload: ${JSON.stringify(body)}`);
 
       return Promise.resolve(
         [
@@ -211,23 +215,23 @@ export default class OpenAPICommand extends Command {
     }
 
     if (!id) {
-      debug('no id parameter, retrieving list of API specs');
+      Command.debug('no id parameter, retrieving list of API specs');
       const apiSettings = await getSpecs('/api/v1/api-specification');
 
       const totalPages = Math.ceil(parseInt(apiSettings.headers.get('x-total-count'), 10) / 10);
       const parsedDocs = parse(apiSettings.headers.get('link'));
-      debug(`total pages: ${totalPages}`);
-      debug(`pagination result: ${JSON.stringify(parsedDocs)}`);
+      Command.debug(`total pages: ${totalPages}`);
+      Command.debug(`pagination result: ${JSON.stringify(parsedDocs)}`);
 
       const apiSettingsBody = await apiSettings.json();
-      debug(`api settings list response payload: ${JSON.stringify(apiSettingsBody)}`);
+      Command.debug(`api settings list response payload: ${JSON.stringify(apiSettingsBody)}`);
       if (!apiSettingsBody.length) return createSpec();
 
       const { option }: { option: 'create' | 'update' } = await prompt(
         promptHandler.createOasPrompt(apiSettingsBody, parsedDocs, totalPages, getSpecs)
       );
 
-      debug(`selection result: ${option}`);
+      Command.debug(`selection result: ${option}`);
       if (!option) return null;
       return option === 'create' ? createSpec() : updateSpec(option);
     }

src/cmds/swagger.ts

@@ -1,7 +1,7 @@
 import type { CommandOptions } from '../lib/baseCommand';
 import type { Options } from './openapi';
 
-import { warn } from '../lib/logger';
+import Command from '../lib/baseCommand';
 
 import OpenAPICommand from './openapi';
 
@@ -16,7 +16,7 @@ export default class SwaggerCommand extends OpenAPICommand {
   }
 
   async run(opts: CommandOptions<Options>) {
-    warn('`rdme swagger` has been deprecated. Please use `rdme openapi` instead.');
+    Command.warn('`rdme swagger` has been deprecated. Please use `rdme openapi` instead.');
     return super.run(opts);
   }
 }

src/cmds/versions/delete.ts

@@ -4,7 +4,6 @@ import config from 'config';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
 import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
-import { debug } from '../../lib/logger';
 import { getProjectVersion } from '../../lib/versionSelect';
 
 export default class DeleteVersionCommand extends Command {
@@ -41,7 +40,7 @@ export default class DeleteVersionCommand extends Command {
       return Promise.reject(e);
     });
 
-    debug(`selectedVersion: ${selectedVersion}`);
+    Command.debug(`selectedVersion: ${selectedVersion}`);
 
     return fetch(`${config.get('host')}/api/v1/version/${selectedVersion}`, {
       method: 'delete',

src/cmds/versions/update.ts

@@ -6,7 +6,6 @@ import { Headers } from 'node-fetch';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
 import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
-import { debug } from '../../lib/logger';
 import * as promptHandler from '../../lib/prompts';
 import { getProjectVersion } from '../../lib/versionSelect';
 
@@ -68,7 +67,7 @@ export default class UpdateVersionCommand extends Command {
       return Promise.reject(e);
     });
 
-    debug(`selectedVersion: ${selectedVersion}`);
+    Command.debug(`selectedVersion: ${selectedVersion}`);
 
     const foundVersion = await fetch(`${config.get('host')}/api/v1/version/${selectedVersion}`, {
       method: 'get',