feat(open): rdme open should have a flag for opening the dash (#671)

* feat(open): add --dash option

* feat(open): add logic to open project dash

* refactor(versionSelect): add parameter to automatically return stable version

* test: add tests for `rdme open` with `--dash` flag

* Merge branch 'main' into darren/rm-5741

* chore: copy changes

* refactor: add check to ensure user is logged in

* test: update `open --dash` test

Author: darrenyong

__tests__/cmds/open.test.ts

@@ -1,8 +1,11 @@
+import type { Version } from '../../src/cmds/versions';
+
 import chalk from 'chalk';
 import config from 'config';
 
 import Command from '../../src/cmds/open';
 import configStore from '../../src/lib/configstore';
+import getAPIMock from '../helpers/get-api-mock';
 
 const cmd = new Command();
 
@@ -30,4 +33,53 @@ describe('rdme open', () => {
 
     return expect(cmd.run({ mockOpen })).resolves.toBe(`Opening ${chalk.green(projectUrl)} in your browser...`);
   });
+
+  describe('open --dash', () => {
+    it('should open the dash', () => {
+      expect.assertions(2);
+      configStore.set('project', 'subdomain');
+      configStore.set('apiKey', '12345');
+
+      const version = '1.0';
+      const key = '12345';
+      const versionPayload: Version = {
+        createdAt: '2019-06-17T22:39:56.462Z',
+        is_deprecated: false,
+        is_hidden: false,
+        is_beta: false,
+        is_stable: true,
+        codename: '',
+        version,
+      };
+
+      const mockRequest = getAPIMock().get('/api/v1/version').basicAuth({ user: key }).reply(200, [versionPayload]);
+
+      const dashUrl = 'https://dash.readme.com/project/subdomain/v1.0/overview';
+
+      function mockOpen(url: string) {
+        expect(url).toBe(dashUrl);
+        return Promise.resolve();
+      }
+
+      return expect(cmd.run({ mockOpen, dash: true, key: '12345' })).resolves.toBe(
+        `Opening ${chalk.green(dashUrl)} in your browser...`
+      );
+      mockRequest.done();
+    });
+
+    it('should require user to be logged in', () => {
+      configStore.set('project', 'subdomain');
+
+      const dashUrl = 'https://dash.readme.com/project/subdomain/v1.0/overview';
+
+      function mockOpen(url: string) {
+        expect(url).toBe(dashUrl);
+        return Promise.resolve();
+      }
+
+      return expect(cmd.run({ mockOpen, dash: true, key: '12345' })).rejects.toStrictEqual(
+        new Error(`Please login using \`${config.get('cli')} login\`.`)
+      );
+    });
+  });
 });

src/cmds/open.ts

@@ -6,9 +6,11 @@ import open from 'open';
 
 import Command, { CommandCategories } from '../lib/baseCommand';
 import configStore from '../lib/configstore';
+import { getProjectVersion } from '../lib/versionSelect';
 
 export type Options = {
   mockOpen?: (url: string) => Promise<void>;
+  dash?: boolean;
 };
 
 export default class OpenCommand extends Command {
@@ -21,21 +23,41 @@ export default class OpenCommand extends Command {
     this.cmdCategory = CommandCategories.UTILITIES;
     this.position = 1;
 
-    this.args = [];
+    this.args = [
+      {
+        name: 'dash',
+        type: Boolean,
+        description: 'Opens your current ReadMe project dashboard.',
+      },
+    ];
   }
 
   async run(opts: CommandOptions<Options>) {
     await super.run(opts);
 
+    const { dash } = opts;
     const project = configStore.get('project');
     Command.debug(`project: ${project}`);
 
     if (!project) {
       return Promise.reject(new Error(`Please login using \`${config.get('cli')} login\`.`));
     }
 
-    const hubURL: string = config.get('hub');
-    const url = hubURL.replace('{project}', project);
+    let url: string;
+
+    if (dash) {
+      const key = configStore.get('apiKey');
+      if (!key) {
+        return Promise.reject(new Error(`Please login using \`${config.get('cli')} login\`.`));
+      }
+
+      const selectedVersion = await getProjectVersion(undefined, key, true);
+      const dashURL: string = config.get('host');
+      url = `${dashURL}/project/${project}/v${selectedVersion}/overview`;
+    } else {
+      const hubURL: string = config.get('hub');
+      url = hubURL.replace('{project}', project);
+    }
 
     return (opts.mockOpen || open)(url, {
       wait: false,

src/lib/versionSelect.ts

@@ -15,7 +15,7 @@ import promptTerminal from './promptWrapper';
  * @param key project API key
  * @returns a cleaned up project version
  */
-export async function getProjectVersion(versionFlag: string, key: string): Promise<string> {
+export async function getProjectVersion(versionFlag: string, key: string, returnStable = false): Promise<string> {
   try {
     if (versionFlag) {
       return await fetch(`${config.get('host')}/api/v1/version/${versionFlag}`, {
@@ -36,6 +36,11 @@ export async function getProjectVersion(versionFlag: string, key: string): Promi
       headers: cleanHeaders(key),
     }).then(res => handleRes(res));
 
+    if (returnStable) {
+      const stableVersion = versionList.find(v => v.is_stable === true);
+      return stableVersion.version;
+    }
+
     const { versionSelection } = await promptTerminal({
       type: 'select',
       name: 'versionSelection',