feat(breaking/version): raw versions only, usage cleanup (#603)

* docs(versions): fix usage guidelines

* fix(versions:update): add hidden arg

* test: add some configstore.clear() to make tests less flaky

* feat(BREAKING): always return raw versions

* refactor: use exported version type

README.md

@@ -268,8 +268,6 @@ rdme custompages:single path-to-markdown-file
 rdme versions
 ```
 
-If you wish to see the raw JSON output from our API in this response, supply the `--raw` flag.
-
 #### Get All Information About a Particular Version
 
 ```sh
@@ -281,7 +279,7 @@ If you wish to see the raw JSON output from our API in this response, supply the
 #### Create a New Version
 
 ```sh
-rdme versions:create <version> | --version={project-version}
+rdme versions:create <version>
 ```
 
 ##### Create a New Version
@@ -291,15 +289,15 @@ If you wish to automate the process of creating a new project version, and not h
 For example:
 
 ```sh
-rdme versions:create <version> | --version={project-version} --fork={version-fork} --main={boolean} --beta={boolean} --isPublic={boolean}
+rdme versions:create <version> --fork={version-fork} --main={true|false} --beta={true|false} --isPublic={true|false}
 ```
 
 See `rdme versions:create --help` for a full list of flags.
 
 #### Update a Version
 
 ```sh
-rdme versions:update --version={project-version}
+rdme versions:update <version>
 ```
 
 Like `versions:create`, if you wish to automate this process and not be blocked by CLI input, you can supply the necessary flags to this command. See `rdme versions:update --help` for more information.
@@ -309,7 +307,7 @@ Like `versions:create`, if you wish to automate this process and not be blocked
 You can remove a specific version from your project, as well as all of the attached specs
 
 ```sh
-rdme versions:delete --version={project-version}
+rdme versions:delete <version>
 ```
 
 ### Categories

__tests__/__snapshots__/index.test.ts.snap

@@ -103,10 +103,9 @@ Usage
 
 Options
 
-  --key string       Project API key                                                 
-  --version string   A specific project version to view.                             
-  --raw              Return raw output from the API instead of in a \\"pretty\\" format. 
-  -h, --help         Display this usage guide                                        
+  --key string       Project API key                     
+  --version string   A specific project version to view. 
+  -h, --help         Display this usage guide            
 
 Related commands
 

__tests__/cmds/logout.test.ts

@@ -6,6 +6,10 @@ import configStore from '../../src/lib/configstore';
 const cmd = new Command();
 
 describe('rdme logout', () => {
+  afterEach(() => {
+    configStore.clear();
+  });
+
   it("should report the user as logged out if they aren't logged in", () => {
     configStore.delete('email');
     configStore.delete('project');

__tests__/cmds/open.test.ts

@@ -7,6 +7,10 @@ import configStore from '../../src/lib/configstore';
 const cmd = new Command();
 
 describe('rdme open', () => {
+  afterEach(() => {
+    configStore.clear();
+  });
+
   it('should error if no project provided', () => {
     configStore.delete('project');
 

__tests__/cmds/versions/index.test.ts

@@ -1,3 +1,5 @@
+import type { Version } from '../../../src/cmds/versions';
+
 import nock from 'nock';
 
 import VersionsCommand from '../../../src/cmds/versions';
@@ -7,7 +9,7 @@ const key = 'API_KEY';
 const version = '1.0.0';
 const version2 = '2.0.0';
 
-const versionPayload = {
+const versionPayload: Version = {
   createdAt: '2019-06-17T22:39:56.462Z',
   is_deprecated: false,
   is_hidden: false,
@@ -17,7 +19,7 @@ const versionPayload = {
   version,
 };
 
-const version2Payload = {
+const version2Payload: Version = {
   createdAt: '2019-06-17T22:39:56.462Z',
   is_deprecated: false,
   is_hidden: false,
@@ -46,20 +48,8 @@ describe('rdme versions', () => {
       .basicAuth({ user: key })
       .reply(200, [versionPayload, version2Payload]);
 
-    const table = await versions.run({ key });
-    expect(table).toContain(version);
-    expect(table).toContain(version2);
-    mockRequest.done();
-  });
-
-  it('should make a request to get a list of existing versions and return them in a raw format', async () => {
-    const mockRequest = getAPIMock()
-      .get('/api/v1/version')
-      .basicAuth({ user: key })
-      .reply(200, [versionPayload, version2Payload]);
-
-    const raw = await versions.run({ key, raw: true });
-    expect(raw).toStrictEqual(JSON.stringify([versionPayload, version2Payload], null, 2));
+    const output = await versions.run({ key });
+    expect(output).toStrictEqual(JSON.stringify([versionPayload, version2Payload], null, 2));
     mockRequest.done();
   });
 
@@ -69,20 +59,8 @@ describe('rdme versions', () => {
       .basicAuth({ user: key })
       .reply(200, versionPayload);
 
-    const table = await versions.run({ key, version });
-    expect(table).toContain(version);
-    expect(table).not.toContain(version2);
-    mockRequest.done();
-  });
-
-  it('should get a specific version object if version flag provided and return it in a raw format', async () => {
-    const mockRequest = getAPIMock()
-      .get(`/api/v1/version/${version}`)
-      .basicAuth({ user: key })
-      .reply(200, versionPayload);
-
-    const raw = await versions.run({ key, version, raw: true });
-    expect(raw).toStrictEqual(JSON.stringify(versionPayload, null, 2));
+    const output = await versions.run({ key, version });
+    expect(output).toStrictEqual(JSON.stringify(versionPayload, null, 2));
     mockRequest.done();
   });
 });

__tests__/cmds/whoami.test.ts

@@ -6,6 +6,10 @@ import configStore from '../../src/lib/configstore';
 const cmd = new Command();
 
 describe('rdme whoami', () => {
+  afterEach(() => {
+    configStore.clear();
+  });
+
   it('should error if user is not authenticated', () => {
     configStore.delete('email');
     configStore.delete('project');

package.json

@@ -37,7 +37,6 @@
     "@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",
     "command-line-usage": "^6.0.2",
     "config": "^3.1.0",
@@ -67,7 +66,6 @@
     "@readme/better-ajv-errors": "^1.5.0",
     "@readme/eslint-config": "^10.1.0",
     "@readme/oas-examples": "^5.3.0",
-    "@types/cli-table": "^0.3.0",
     "@types/command-line-args": "^5.2.0",
     "@types/command-line-usage": "^5.0.2",
     "@types/config": "^3.3.0",

src/cmds/versions/create.ts

@@ -1,3 +1,4 @@
+import type { Version } from '.';
 import type { CommandOptions } from '../../lib/baseCommand';
 
 import config from 'config';
@@ -23,7 +24,7 @@ export default class CreateVersionCommand extends Command {
     super();
 
     this.command = 'versions:create';
-    this.usage = 'versions:create --version=<version> [options]';
+    this.usage = 'versions:create <version> [options]';
     this.description = 'Create a new version for your project.';
     this.cmdCategory = CommandCategories.VERSIONS;
     this.position = 2;
@@ -71,6 +72,15 @@ export default class CreateVersionCommand extends Command {
 
     const promptResponse = await promptTerminal(versionPrompt);
 
+    const body: Version = {
+      version,
+      codename: codename || '',
+      is_stable: main === 'true' || promptResponse.is_stable,
+      is_beta: beta === 'true' || promptResponse.is_beta,
+      from: fork || promptResponse.from,
+      is_hidden: promptResponse.is_stable ? false : !(isPublic === 'true' || promptResponse.is_hidden),
+    };
+
     return fetch(`${config.get('host')}/api/v1/version`, {
       method: 'post',
       headers: cleanHeaders(
@@ -80,14 +90,7 @@ export default class CreateVersionCommand extends Command {
           'Content-Type': 'application/json',
         })
       ),
-      body: JSON.stringify({
-        version,
-        codename: codename || '',
-        is_stable: main === 'true' || promptResponse.is_stable,
-        is_beta: beta === 'true' || promptResponse.is_beta,
-        from: fork || promptResponse.from,
-        is_hidden: promptResponse.is_stable ? false : !(isPublic === 'true' || promptResponse.is_hidden),
-      }),
+      body: JSON.stringify(body),
     })
       .then(handleRes)
       .then(() => {

src/cmds/versions/delete.ts

@@ -11,7 +11,7 @@ export default class DeleteVersionCommand extends Command {
     super();
 
     this.command = 'versions:delete';
-    this.usage = 'versions:delete --version=<version> [options]';
+    this.usage = 'versions:delete <version> [options]';
     this.description = 'Delete a version associated with your ReadMe project.';
     this.cmdCategory = CommandCategories.VERSIONS;
     this.position = 4;