chore: renaming src/cmds to src/commands (#1070)

## 🧰 Changes

recreating @erunion's work in #1069:

> This is a super minor addendum to the oclif work going on in
#1068 but I've renamed our
`src/cmds` directory to `src/commands` as when you run `oclif generate
command <command name>` that's the directory it wants to place a new
command into.
>
> We could _probably_ configure `src/cmds` somehow to be the place it
looks but I don't see anything in their [config
docs](https://oclif.io/docs/config) about it.

Co-authored-by: Jon Ursenbach <[email protected]>

CONTRIBUTING.md

@@ -89,7 +89,7 @@ act -j simple
 
 ### Usage of `console`
 
-As you'll learn in our commands logic (see [`bin/run.js`](bin/run.js) and the [`src/cmds`](src/cmds) directory), we wrap our command outputs in resolved/rejected [`Promise` objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) and use [`bin/run.js`](bin/run.js) file to log the results to the console and return the correct status code. This is so we can write more resilient tests, ensure that the proper exit codes are being returned, and make debugging easier.
+As you'll learn in our commands logic (see [`bin/run.js`](bin/run.js) and the [`src/commands`](src/commands) directory), we wrap our command outputs in resolved/rejected [`Promise` objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) and use [`bin/run.js`](bin/run.js) file to log the results to the console and return the correct status code. This is so we can write more resilient tests, ensure that the proper exit codes are being returned, and make debugging easier.
 
 When writing command logic, avoid using `console` statements (and correspondingly, avoid mocking `console` statements in tests) when possible.
 

__tests__/cmds/categories/create.test.ts → __tests__/commands/categories/create.test.ts

@@ -1,7 +1,7 @@
 import nock from 'nock';
 import { describe, beforeAll, afterEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/categories/create.js';
+import Command from '../../../src/commands/categories/create.js';
 import getAPIMock, { getAPIMockWithVersionHeader } from '../../helpers/get-api-mock.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';
 

__tests__/cmds/categories/index.test.ts → __tests__/commands/categories/index.test.ts

@@ -1,7 +1,7 @@
 import nock from 'nock';
 import { describe, beforeAll, afterEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/categories/index.js';
+import Command from '../../../src/commands/categories/index.js';
 import getAPIMock, { getAPIMockWithVersionHeader } from '../../helpers/get-api-mock.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';
 

__tests__/cmds/changelogs/index.test.ts → __tests__/commands/changelogs/index.test.ts

@@ -6,7 +6,7 @@ import frontMatter from 'gray-matter';
 import nock from 'nock';
 import { describe, beforeAll, afterAll, beforeEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/changelogs.js';
+import Command from '../../../src/commands/changelogs.js';
 import APIError from '../../../src/lib/apiError.js';
 import getAPIMock from '../../helpers/get-api-mock.js';
 import hashFileContents from '../../helpers/hash-file-contents.js';

__tests__/cmds/changelogs/single.test.ts → __tests__/commands/changelogs/single.test.ts

@@ -6,7 +6,7 @@ import frontMatter from 'gray-matter';
 import nock from 'nock';
 import { describe, beforeAll, afterAll, beforeEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/changelogs.js';
+import Command from '../../../src/commands/changelogs.js';
 import APIError from '../../../src/lib/apiError.js';
 import getAPIMock from '../../helpers/get-api-mock.js';
 import hashFileContents from '../../helpers/hash-file-contents.js';

__tests__/cmds/custompages/index.test.ts → __tests__/commands/custompages/index.test.ts

@@ -6,7 +6,7 @@ import frontMatter from 'gray-matter';
 import nock from 'nock';
 import { describe, beforeAll, afterAll, beforeEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/custompages.js';
+import Command from '../../../src/commands/custompages.js';
 import APIError from '../../../src/lib/apiError.js';
 import getAPIMock from '../../helpers/get-api-mock.js';
 import hashFileContents from '../../helpers/hash-file-contents.js';

__tests__/cmds/custompages/single.test.ts → __tests__/commands/custompages/single.test.ts

@@ -6,7 +6,7 @@ import frontMatter from 'gray-matter';
 import nock from 'nock';
 import { describe, beforeAll, afterAll, beforeEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/custompages.js';
+import Command from '../../../src/commands/custompages.js';
 import APIError from '../../../src/lib/apiError.js';
 import getAPIMock from '../../helpers/get-api-mock.js';
 import hashFileContents from '../../helpers/hash-file-contents.js';

__tests__/cmds/docs/index.test.ts → __tests__/commands/docs/index.test.ts

@@ -10,7 +10,7 @@ import nock from 'nock';
 import prompts from 'prompts';
 import { describe, beforeAll, afterAll, beforeEach, afterEach, it, expect, vi, type MockInstance } from 'vitest';
 
-import Command from '../../../src/cmds/docs/index.js';
+import Command from '../../../src/commands/docs/index.js';
 import APIError from '../../../src/lib/apiError.js';
 import getAPIMock, { getAPIMockWithVersionHeader } from '../../helpers/get-api-mock.js';
 import { after, before } from '../../helpers/get-gha-setup.js';

__tests__/cmds/docs/multiple.test.ts → __tests__/commands/docs/multiple.test.ts

@@ -5,7 +5,7 @@ import frontMatter from 'gray-matter';
 import nock from 'nock';
 import { describe, beforeAll, afterAll, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/docs/index.js';
+import Command from '../../../src/commands/docs/index.js';
 import getAPIMock, { getAPIMockWithVersionHeader } from '../../helpers/get-api-mock.js';
 import hashFileContents from '../../helpers/hash-file-contents.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';

__tests__/cmds/docs/prune.test.ts → __tests__/commands/docs/prune.test.ts

@@ -3,7 +3,7 @@ import nock from 'nock';
 import prompts from 'prompts';
 import { describe, beforeAll, afterAll, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/docs/prune.js';
+import Command from '../../../src/commands/docs/prune.js';
 import getAPIMock, { getAPIMockWithVersionHeader } from '../../helpers/get-api-mock.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';
 

__tests__/cmds/docs/single.test.ts → __tests__/commands/docs/single.test.ts

@@ -6,7 +6,7 @@ import frontMatter from 'gray-matter';
 import nock from 'nock';
 import { describe, beforeAll, afterAll, beforeEach, afterEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/docs/index.js';
+import Command from '../../../src/commands/docs/index.js';
 import APIError from '../../../src/lib/apiError.js';
 import getAPIMock, { getAPIMockWithVersionHeader } from '../../helpers/get-api-mock.js';
 import hashFileContents from '../../helpers/hash-file-contents.js';

__tests__/cmds/login.test.ts → __tests__/commands/login.test.ts

@@ -2,7 +2,7 @@ import nock from 'nock';
 import prompts from 'prompts';
 import { describe, beforeAll, afterAll, afterEach, it, expect } from 'vitest';
 
-import Command from '../../src/cmds/login.js';
+import Command from '../../src/commands/login.js';
 import APIError from '../../src/lib/apiError.js';
 import configStore from '../../src/lib/configstore.js';
 import getAPIMock from '../helpers/get-api-mock.js';

__tests__/cmds/logout.test.ts → __tests__/commands/logout.test.ts

@@ -1,7 +1,7 @@
 import { describe, afterEach, beforeAll, it, expect } from 'vitest';
 
 import pkg from '../../package.json';
-import Command from '../../src/cmds/logout.js';
+import Command from '../../src/commands/logout.js';
 import configStore from '../../src/lib/configstore.js';
 import { runCommand } from '../helpers/setup-oclif-config.js';
 

__tests__/cmds/open.test.ts → __tests__/commands/open.test.ts

@@ -1,10 +1,10 @@
-import type { Version } from '../../src/cmds/versions/index.js';
+import type { Version } from '../../src/commands/versions/index.js';
 
 import chalk from 'chalk';
 import { describe, afterEach, beforeAll, it, expect } from 'vitest';
 
 import pkg from '../../package.json';
-import Command from '../../src/cmds/open.js';
+import Command from '../../src/commands/open.js';
 import configStore from '../../src/lib/configstore.js';
 import getAPIMock from '../helpers/get-api-mock.js';
 import { runCommand } from '../helpers/setup-oclif-config.js';

__tests__/cmds/openapi/convert.test.ts → __tests__/commands/openapi/convert.test.ts

@@ -3,7 +3,7 @@ import fs from 'node:fs';
 import prompts from 'prompts';
 import { describe, it, expect, vi, beforeAll, beforeEach, afterEach } from 'vitest';
 
-import Command from '../../../src/cmds/openapi/convert.js';
+import Command from '../../../src/commands/openapi/convert.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';
 
 const successfulConversion = () => 'Your API definition has been converted and bundled and saved to output.json!';

__tests__/cmds/openapi/index.test.ts → __tests__/commands/openapi/index.test.ts

@@ -7,7 +7,7 @@ import nock from 'nock';
 import prompts from 'prompts';
 import { describe, beforeAll, beforeEach, afterEach, it, expect, vi, type MockInstance } from 'vitest';
 
-import Command from '../../../src/cmds/openapi/index.js';
+import Command from '../../../src/commands/openapi/index.js';
 import APIError from '../../../src/lib/apiError.js';
 import config from '../../../src/lib/config.js';
 import petstoreWeird from '../../__fixtures__/petstore-simple-weird-version.json' with { type: 'json' };

__tests__/cmds/openapi/inspect.test.ts → __tests__/commands/openapi/inspect.test.ts

@@ -4,7 +4,7 @@ import assert from 'node:assert';
 
 import { describe, it, expect, beforeAll } from 'vitest';
 
-import Command from '../../../src/cmds/openapi/inspect.js';
+import Command from '../../../src/commands/openapi/inspect.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';
 
 describe('rdme openapi:inspect', () => {

__tests__/cmds/openapi/reduce.test.ts → __tests__/commands/openapi/reduce.test.ts

@@ -5,7 +5,7 @@ import chalk from 'chalk';
 import prompts from 'prompts';
 import { describe, beforeAll, beforeEach, afterEach, it, expect, vi, type MockInstance } from 'vitest';
 
-import Command from '../../../src/cmds/openapi/reduce.js';
+import Command from '../../../src/commands/openapi/reduce.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';
 
 const successfulReduction = () => 'Your reduced API definition has been saved to output.json! 🤏';

__tests__/cmds/openapi/validate.test.ts → __tests__/commands/openapi/validate.test.ts

@@ -7,7 +7,7 @@ import chalk from 'chalk';
 import prompts from 'prompts';
 import { describe, beforeAll, beforeEach, afterEach, it, expect, vi, type MockInstance } from 'vitest';
 
-import Command from '../../../src/cmds/openapi/validate.js';
+import Command from '../../../src/commands/openapi/validate.js';
 import { after, before } from '../../helpers/get-gha-setup.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';
 

__tests__/cmds/versions/create.test.ts → __tests__/commands/versions/create.test.ts

@@ -2,7 +2,7 @@ import nock from 'nock';
 import prompts from 'prompts';
 import { describe, beforeAll, afterEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/versions/create.js';
+import Command from '../../../src/commands/versions/create.js';
 import APIError from '../../../src/lib/apiError.js';
 import getAPIMock from '../../helpers/get-api-mock.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';

__tests__/cmds/versions/delete.test.ts → __tests__/commands/versions/delete.test.ts

@@ -1,7 +1,7 @@
 import nock from 'nock';
 import { describe, beforeAll, afterEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/versions/delete.js';
+import Command from '../../../src/commands/versions/delete.js';
 import APIError from '../../../src/lib/apiError.js';
 import getAPIMock from '../../helpers/get-api-mock.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';

__tests__/cmds/versions/index.test.ts → __tests__/commands/versions/index.test.ts

@@ -1,9 +1,9 @@
-import type { Version } from '../../../src/cmds/versions/index.js';
+import type { Version } from '../../../src/commands/versions/index.js';
 
 import nock from 'nock';
 import { describe, beforeAll, afterEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/versions/index.js';
+import Command from '../../../src/commands/versions/index.js';
 import getAPIMock from '../../helpers/get-api-mock.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';
 

__tests__/cmds/versions/update.test.ts → __tests__/commands/versions/update.test.ts

@@ -2,7 +2,7 @@ import nock from 'nock';
 import prompts from 'prompts';
 import { describe, beforeAll, afterEach, it, expect } from 'vitest';
 
-import Command from '../../../src/cmds/versions/update.js';
+import Command from '../../../src/commands/versions/update.js';
 import APIError from '../../../src/lib/apiError.js';
 import getAPIMock from '../../helpers/get-api-mock.js';
 import { runCommand } from '../../helpers/setup-oclif-config.js';

__tests__/cmds/whoami.test.ts → __tests__/commands/whoami.test.ts

@@ -1,7 +1,7 @@
 import { describe, afterEach, it, expect, beforeAll } from 'vitest';
 
 import pkg from '../../package.json';
-import Command from '../../src/cmds/whoami.js';
+import Command from '../../src/commands/whoami.js';
 import configStore from '../../src/lib/configstore.js';
 import { runCommand } from '../helpers/setup-oclif-config.js';
 

package.json

@@ -178,7 +178,7 @@
         "description": "Sync or prune Guides pages in your ReadMe developer hub."
       },
       "openapi": {
-        "description": "Manage your API definition. Supports OpenAPI, Swagger, Postman."
+        "description": "Manage your API definition. Supports OpenAPI, Swagger, and Postman."
       },
       "versions": {
         "description": "Manage your documentation versions."

src/index.ts

@@ -1,22 +1,22 @@
-import CategoriesCreateCommand from './cmds/categories/create.js';
-import CategoriesCommand from './cmds/categories/index.js';
-import ChangelogsCommand from './cmds/changelogs.js';
-import CustomPagesCommand from './cmds/custompages.js';
-import DocsCommand from './cmds/docs/index.js';
-import DocsPruneCommand from './cmds/docs/prune.js';
-import LoginCommand from './cmds/login.js';
-import LogoutCommand from './cmds/logout.js';
-import OpenCommand from './cmds/open.js';
-import OpenAPIConvertCommand from './cmds/openapi/convert.js';
-import OpenAPICommand from './cmds/openapi/index.js';
-import OpenAPIInspectCommand from './cmds/openapi/inspect.js';
-import OpenAPIReduceCommand from './cmds/openapi/reduce.js';
-import OpenAPIValidateCommand from './cmds/openapi/validate.js';
-import CreateVersionCommand from './cmds/versions/create.js';
-import DeleteVersionCommand from './cmds/versions/delete.js';
-import VersionsCommand from './cmds/versions/index.js';
-import UpdateVersionCommand from './cmds/versions/update.js';
-import WhoAmICommand from './cmds/whoami.js';
+import CategoriesCreateCommand from './commands/categories/create.js';
+import CategoriesCommand from './commands/categories/index.js';
+import ChangelogsCommand from './commands/changelogs.js';
+import CustomPagesCommand from './commands/custompages.js';
+import DocsCommand from './commands/docs/index.js';
+import DocsPruneCommand from './commands/docs/prune.js';
+import LoginCommand from './commands/login.js';
+import LogoutCommand from './commands/logout.js';
+import OpenCommand from './commands/open.js';
+import OpenAPIConvertCommand from './commands/openapi/convert.js';
+import OpenAPICommand from './commands/openapi/index.js';
+import OpenAPIInspectCommand from './commands/openapi/inspect.js';
+import OpenAPIReduceCommand from './commands/openapi/reduce.js';
+import OpenAPIValidateCommand from './commands/openapi/validate.js';
+import CreateVersionCommand from './commands/versions/create.js';
+import DeleteVersionCommand from './commands/versions/delete.js';
+import VersionsCommand from './commands/versions/index.js';
+import UpdateVersionCommand from './commands/versions/update.js';
+import WhoAmICommand from './commands/whoami.js';
 
 export { default as createGHA } from './lib/hooks/createGHA.js';
 export { default as prerun } from './lib/hooks/prerun.js';

src/lib/createGHA/index.ts

@@ -60,7 +60,7 @@ function getKey(args: CommandFlag, opts: ParsedOpts): string | false {
 /**
  * Constructs the command string that we pass into the workflow file.
  */
-function constructCmdString(commandId: string, args: CommandArg, flags: CommandFlag, opts: ParsedOpts): string {
+function constructCommandString(commandId: string, args: CommandArg, flags: CommandFlag, opts: ParsedOpts): string {
   const argsString = Object.keys(args)
     .map(arg => {
       return opts[arg];
@@ -264,7 +264,7 @@ export default async function createGHA(
     branch,
     cleanCommand: cleanFileName(commandId),
     command: commandId,
-    commandString: constructCmdString(commandId, args, flags, parsedOpts),
+    commandString: constructCommandString(commandId, args, flags, parsedOpts),
     rdmeVersion: `v${majorPkgVersion}`,
     timestamp: new Date().toISOString(),
   };

src/lib/prompts.ts

@@ -1,4 +1,4 @@
-import type { Version } from '../cmds/versions/index.js';
+import type { Version } from '../commands/versions/index.js';
 import type { Choice, PromptObject } from 'prompts';
 
 import parse from 'parse-link-header';

src/lib/syncDocsPath.ts

@@ -1,7 +1,7 @@
 import type { ReadDocMetadata } from './readDoc.js';
-import type ChangelogsCommand from '../cmds/changelogs.js';
-import type CustomPagesCommand from '../cmds/custompages.js';
-import type DocsCommand from '../cmds/docs/index.js';
+import type ChangelogsCommand from '../commands/changelogs.js';
+import type CustomPagesCommand from '../commands/custompages.js';
+import type DocsCommand from '../commands/docs/index.js';
 
 import fs from 'node:fs/promises';
 import path from 'node:path';

src/lib/versionSelect.ts

@@ -1,5 +1,5 @@
 import type { APIErrorResponse } from './apiError.js';
-import type { Version } from '../cmds/versions/index.js';
+import type { Version } from '../commands/versions/index.js';
 
 import APIError from './apiError.js';
 import isCI from './isCI.js';