@redocly/cli 1.8.1 → 1.9.0

package/src/cms/commands/push-status.ts

@@ -5,6 +5,7 @@ import { Spinner } from '../../utils/spinner';
 import { DeploymentError } from '../utils';
 import { yellow } from 'colorette';
 import { ReuniteApiClient, getApiKeys, getDomain } from '../api';
+import { capitalize } from '../../utils/js-utils';
 
 import type { DeploymentStatus, PushResponse, ScorecardItem } from '../api/types';
 
@@ -177,15 +178,15 @@ function displayDeploymentAndBuildStatus({
     case 'success':
       spinner.stop();
       return process.stdout.write(
-        `${colors.green(
-          `🚀 ${buildType.toLocaleUpperCase()} deployment succeeded.`
-        )}\n${colors.magenta('Preview URL')}: ${colors.cyan(previewUrl!)}\n`
+        `${colors.green(`🚀 ${capitalize(buildType)} deploy success.`)}\n${colors.magenta(
+          `${capitalize(buildType)} URL`
+        )}: ${colors.cyan(previewUrl!)}\n`
       );
     case 'failed':
       spinner.stop();
       throw new DeploymentError(
-        `${colors.red(`❌ ${buildType.toLocaleUpperCase()} deployment failed.`)}\n${colors.magenta(
-          'Preview URL'
+        `${colors.red(`❌ ${capitalize(buildType)} deploy fail.`)}\n${colors.magenta(
+          `${capitalize(buildType)} URL`
         )}: ${colors.cyan(previewUrl!)}`
       );
     case 'pending':

package/src/commands/join.ts

@@ -49,6 +49,7 @@ let potentialConflictsTotal = 0;
 type JoinDocumentContext = {
   api: string;
   apiFilename: string;
+  apiTitle?: string;
   tags: Oas3Tag[];
   potentialConflicts: any;
   tagsPrefix: string;
@@ -209,6 +210,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     const context = {
       api,
       apiFilename,
+      apiTitle: info?.title,
       tags,
       potentialConflicts,
       tagsPrefix,
@@ -218,7 +220,6 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
       populateTags(context);
     }
     collectServers(openapi);
-    collectInfoDescriptions(openapi, context);
     collectExternalDocs(openapi, context);
     collectPaths(openapi, context);
     collectComponents(openapi, context);
@@ -242,6 +243,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
   function populateTags({
     api,
     apiFilename,
+    apiTitle,
     tags,
     potentialConflicts,
     tagsPrefix,
@@ -285,9 +287,10 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
       }
 
       if (!withoutXTagGroups) {
-        createXTagGroups(apiFilename);
+        const groupName = apiTitle || apiFilename;
+        createXTagGroups(groupName);
         if (!tagDuplicate) {
-          populateXTagGroups(entrypointTagName, getIndexGroup(apiFilename));
+          populateXTagGroups(entrypointTagName, getIndexGroup(groupName));
         }
       }
 
@@ -302,20 +305,20 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     }
   }
 
-  function getIndexGroup(apiFilename: string): number {
-    return joinedDef[xTagGroups].findIndex((item: any) => item.name === apiFilename);
+  function getIndexGroup(name: string): number {
+    return joinedDef[xTagGroups].findIndex((item: any) => item.name === name);
   }
 
-  function createXTagGroups(apiFilename: string) {
+  function createXTagGroups(name: string) {
     if (!joinedDef.hasOwnProperty(xTagGroups)) {
       joinedDef[xTagGroups] = [];
     }
 
-    if (!joinedDef[xTagGroups].some((g: any) => g.name === apiFilename)) {
-      joinedDef[xTagGroups].push({ name: apiFilename, tags: [] });
+    if (!joinedDef[xTagGroups].some((g: any) => g.name === name)) {
+      joinedDef[xTagGroups].push({ name, tags: [] });
     }
 
-    const indexGroup = getIndexGroup(apiFilename);
+    const indexGroup = getIndexGroup(name);
 
     if (!joinedDef[xTagGroups][indexGroup].hasOwnProperty(Tags)) {
       joinedDef[xTagGroups][indexGroup][Tags] = [];
@@ -344,27 +347,6 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     }
   }
 
-  function collectInfoDescriptions(
-    openapi: Oas3Definition,
-    { apiFilename, componentsPrefix }: JoinDocumentContext
-  ) {
-    const { info } = openapi;
-    if (info?.description) {
-      const groupIndex = joinedDef[xTagGroups] ? getIndexGroup(apiFilename) : -1;
-      if (
-        joinedDef.hasOwnProperty(xTagGroups) &&
-        groupIndex !== -1 &&
-        joinedDef[xTagGroups][groupIndex]['tags'] &&
-        joinedDef[xTagGroups][groupIndex]['tags'].length
-      ) {
-        joinedDef[xTagGroups][groupIndex]['description'] = addComponentsPrefix(
-          info.description,
-          componentsPrefix!
-        );
-      }
-    }
-  }
-
   function collectExternalDocs(openapi: Oas3Definition, { api }: JoinDocumentContext) {
     const { externalDocs } = openapi;
     if (externalDocs) {
@@ -380,7 +362,14 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
 
   function collectPaths(
     openapi: Oas3Definition,
-    { apiFilename, api, potentialConflicts, tagsPrefix, componentsPrefix }: JoinDocumentContext
+    {
+      apiFilename,
+      apiTitle,
+      api,
+      potentialConflicts,
+      tagsPrefix,
+      componentsPrefix,
+    }: JoinDocumentContext
   ) {
     const { paths } = openapi;
     const operationsSet = new Set(keysOf<typeof OPENAPI3_METHOD>(OPENAPI3_METHOD));
@@ -532,6 +521,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
         populateTags({
           api,
           apiFilename,
+          apiTitle,
           tags: formatTags(tags),
           potentialConflicts,
           tagsPrefix,
@@ -542,6 +532,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
         populateTags({
           api,
           apiFilename,
+          apiTitle,
           tags: formatTags(['other']),
           potentialConflicts,
           tagsPrefix: tagsPrefix || apiFilename,
@@ -599,7 +590,14 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
   function collectWebhooks(
     oasVersion: SpecVersion,
     openapi: Oas3_1Definition,
-    { apiFilename, api, potentialConflicts, tagsPrefix, componentsPrefix }: JoinDocumentContext
+    {
+      apiFilename,
+      apiTitle,
+      api,
+      potentialConflicts,
+      tagsPrefix,
+      componentsPrefix,
+    }: JoinDocumentContext
   ) {
     const webhooks = oasVersion === SpecVersion.OAS3_1 ? 'webhooks' : 'x-webhooks';
     const openapiWebhooks = openapi[webhooks];
@@ -628,6 +626,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
             populateTags({
               api,
               apiFilename,
+              apiTitle,
               tags: formatTags(tags),
               potentialConflicts,
               tagsPrefix,
@@ -802,7 +801,7 @@ async function validateApi(
 function crawl(object: any, visitor: any) {
   if (!isObject(object)) return;
   for (const key of Object.keys(object)) {
-    visitor(object, key);
+    visitor(object[key], key);
     crawl(object[key], visitor);
   }
 }

package/src/commands/push.ts

@@ -55,7 +55,7 @@ export function commonPushHandler({
   if (project && mountPath) {
     return handleCMSPush;
   }
-  return handlePush;
+  return transformPush(handlePush);
 }
 
 export async function handlePush(argv: PushOptions, config: Config): Promise<void> {
@@ -354,8 +354,7 @@ export function getDestinationProps(
 }
 
 type BarePushArgs = Omit<PushOptions, 'destination' | 'branchName'> & {
-  maybeDestination?: string;
-  maybeBranchName?: string;
+  apis?: string[];
   branch?: string;
   destination?: string;
 };
@@ -364,9 +363,7 @@ export const transformPush =
   (callback: typeof handlePush) =>
   (
     {
-      api: maybeApiOrDestination,
-      maybeDestination,
-      maybeBranchName,
+      apis,
       branch,
       'batch-id': batchId,
       'job-id': jobId,
@@ -374,6 +371,8 @@ export const transformPush =
     }: BarePushArgs & { 'batch-id'?: string },
     config: Config
   ) => {
+    const [maybeApiOrDestination, maybeDestination, maybeBranchName] = apis || [];
+
     if (batchId) {
       process.stderr.write(
         yellow(
@@ -410,12 +409,10 @@ export const transformPush =
       apiFile = maybeApiOrDestination;
     }
 
-    destination = rest.destination || destination;
-
     return callback(
       {
         ...rest,
-        destination,
+        destination: rest.destination ?? destination,
         api: apiFile,
         branchName: branch ?? maybeBranchName,
         'job-id': jobId || batchId,

package/src/commands/stats.ts

@@ -46,15 +46,37 @@ function printStatsJson(statsAccumulator: StatsAccumulator) {
   process.stdout.write(JSON.stringify(json, null, 2));
 }
 
-function printStats(statsAccumulator: StatsAccumulator, api: string, format: string) {
-  process.stderr.write(`Document: ${colors.magenta(api)} stats:\n\n`);
+function printStatsMarkdown(statsAccumulator: StatsAccumulator) {
+  let output = '| Feature  | Count  |\n| --- | --- |\n';
+  for (const key of Object.keys(statsAccumulator)) {
+    output +=
+      '| ' +
+      statsAccumulator[key as StatsName].metric +
+      ' | ' +
+      statsAccumulator[key as StatsName].total +
+      ' |\n';
+  }
+  process.stdout.write(output);
+}
+
+function printStats(
+  statsAccumulator: StatsAccumulator,
+  api: string,
+  startedAt: number,
+  format: string
+) {
   switch (format) {
     case 'stylish':
+      process.stderr.write(`Document: ${colors.magenta(api)} stats:\n\n`);
       printStatsStylish(statsAccumulator);
+      printExecutionTime('stats', startedAt, api);
       break;
     case 'json':
       printStatsJson(statsAccumulator);
       break;
+    case 'markdown':
+      printStatsMarkdown(statsAccumulator);
+      break;
   }
 }
 
@@ -107,6 +129,5 @@ export async function handleStats(argv: StatsOptions, config: Config) {
     ctx,
   });
 
-  printStats(statsAccumulator, path, argv.format);
-  printExecutionTime('stats', startedAt, path);
+  printStats(statsAccumulator, path, startedAt, argv.format);
 }

package/src/index.ts

@@ -46,7 +46,7 @@ yargs
         },
         format: {
           description: 'Use a specific output format.',
-          choices: ['stylish', 'json'] as ReadonlyArray<OutputFormat>,
+          choices: ['stylish', 'json', 'markdown'] as ReadonlyArray<OutputFormat>,
           default: 'stylish' as OutputFormat,
         },
       }),

package/src/utils/js-utils.ts

@@ -15,3 +15,10 @@ export function keysOf<T>(obj: T) {
   if (!obj) return [];
   return Object.keys(obj) as (keyof T)[];
 }
+
+export function capitalize(s: string) {
+  if (s?.length > 0) {
+    return s[0].toUpperCase() + s.slice(1);
+  }
+  return s;
+}

package/src/utils/update-version-notifier.ts

@@ -64,27 +64,27 @@ const renderUpdateBanner = (current: string, latest: string) => {
   const maxLength = Math.max(...messageLines.map((line) => cleanColors(line).length));
 
   const border = yellow('═'.repeat(maxLength + SPACE_TO_BORDER));
-
-  const banner = `
-    ${yellow('╔' + border + '╗')}
-    ${yellow('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║')}
-    ${messageLines
-      .map((line, index) => {
-        return getLineWithPadding(maxLength, line, index);
-      })
-      .join('\n')}
-    ${yellow('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║')}
-    ${yellow('╚' + border + '╝')}
-  `;
-
+  const extraSpaces = ' '.repeat(SPACE_TO_BORDER);
+
+  const banner = [
+    '',
+    extraSpaces + yellow('╔' + border + '╗'),
+    extraSpaces + yellow('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║'),
+    messageLines.map(getLineWithPadding(maxLength, extraSpaces)).join('\n'),
+    extraSpaces + yellow('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║'),
+    extraSpaces + yellow('╚' + border + '╝'),
+    '',
+    '',
+  ].join('\n');
   process.stderr.write(banner);
 };
 
-const getLineWithPadding = (maxLength: number, line: string, index: number): string => {
-  const padding = ' '.repeat(maxLength - cleanColors(line).length);
-  const extraSpaces = index !== 0 ? ' '.repeat(SPACE_TO_BORDER) : '';
-  return `${extraSpaces}${yellow('║')}  ${line}${padding}  ${yellow('║')}`;
-};
+const getLineWithPadding =
+  (maxLength: number, extraSpaces: string) =>
+  (line: string): string => {
+    const padding = ' '.repeat(maxLength - cleanColors(line).length);
+    return `${extraSpaces}${yellow('║')}  ${line}${padding}  ${yellow('║')}`;
+  };
 
 const isNeedToBeCached = (): boolean => {
   try {