@mintlify/cli 4.0.1077 → 4.0.1078

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1077",
+  "version": "4.0.1078",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -95,5 +95,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "8df236c3a874c2c179b018ee4dd5a4384e552724"
+  "gitHead": "9649cbed95403dc2d61e4f4a3b02a307ad7528ea"
 }

package/src/cli.tsx

@@ -1,4 +1,3 @@
-import { validate, getOpenApiDocumentFromUrl, isAllowedLocalSchemaUrl } from '@mintlify/common';
 import {
   buildGraph,
   getBrokenExternalLinks,
@@ -19,12 +18,14 @@ import {
 } from '@mintlify/previewing';
 import { checkUrl } from '@mintlify/scraping';
 import { render, Text } from 'ink';
+import fs from 'node:fs/promises';
 import path from 'path';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
 import { accessibilityCheck } from './accessibilityCheck.js';
 import { setTelemetryEnabled } from './config.js';
+import { CMD_EXEC_PATH } from './constants.js';
 import {
   checkPort,
   checkNodeVersion,
@@ -32,13 +33,13 @@ import {
   getVersions,
   suppressConsoleWarnings,
   terminate,
-  readLocalOpenApiFile,
 } from './helpers.js';
 import { init } from './init.js';
 import { login } from './login.js';
 import { logout } from './logout.js';
 import { mdxLinter } from './mdxLinter.js';
 import { migrateMdx } from './migrateMdx.js';
+import { checkOpenApiFile, getOpenApiFilenamesFromDocsConfig } from './openApiCheck.js';
 import { scrapeSite, scrapePage, scrapeOpenApi } from './scrape.js';
 import { status } from './status.js';
 import { createTelemetryMiddleware } from './telemetry/middleware.js';
@@ -154,6 +155,24 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
             .usage('usage: mintlify validate [options]')
             .example('mintlify validate', 'validate the build'),
         async (argv) => {
+          if (!argv['disable-openapi']) {
+            let openApiFilenames: string[] = [];
+
+            try {
+              const docsJson = await fs.readFile(path.join(CMD_EXEC_PATH, 'docs.json'), 'utf-8');
+              openApiFilenames = getOpenApiFilenamesFromDocsConfig(JSON.parse(docsJson));
+            } catch {}
+
+            const results = await Promise.all(
+              openApiFilenames.map((file) => checkOpenApiFile(file, argv['local-schema']))
+            );
+
+            if (results.some((valid) => !valid)) {
+              await terminate(1);
+              return;
+            }
+          }
+
           const { cli: cliVersion } = getVersions();
           await validateBuild({
             ...argv,
@@ -200,7 +219,7 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
       )
       .command(
         'openapi-check <filename>',
-        'check if an openapi spec is valid',
+        false,
         (yargs) =>
           yargs
             .positional('filename', {
@@ -216,42 +235,11 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
                 'use a locally hosted schema file (note: only https protocol is supported in production)',
             }),
         async ({ filename, 'local-schema': localSchema }) => {
-          try {
-            if (isAllowedLocalSchemaUrl(filename, localSchema)) {
-              await getOpenApiDocumentFromUrl(filename);
-              addLog(<SuccessLog message="OpenAPI definition is valid." />);
-              await terminate(0);
-            }
-
-            if (filename.startsWith('http://') && !localSchema) {
-              addLog(
-                <WarningLog message="include the --local-schema flag to check locally hosted OpenAPI files" />
-              );
-              addLog(<WarningLog message="only https protocol is supported in production" />);
-              await terminate(0);
-            }
-
-            const document = await readLocalOpenApiFile(filename);
-
-            if (!document) {
-              throw new Error(
-                'failed to parse OpenAPI spec: could not parse file correctly, please check for any syntax errors.'
-              );
-            }
-            await validate(document);
-            addLog(<SuccessLog message="OpenAPI definition is valid." />);
-          } catch (err) {
-            if (err && typeof err === 'object' && 'code' in err && err.code === 'ENOENT') {
-              addLog(
-                <ErrorLog message={`file not found, please check the path provided: ${filename}`} />
-              );
-            } else {
-              addLog(<ErrorLog message={err instanceof Error ? err.message : 'unknown error'} />);
-            }
-            await terminate(1);
-          }
-
-          await terminate(0);
+          addLog(
+            <WarningLog message="openapi-check is deprecated, use `mintlify validate` instead" />
+          );
+          const valid = await checkOpenApiFile(filename, localSchema);
+          await terminate(valid ? 0 : 1);
         }
       )
       .command(

package/src/openApiCheck.tsx

@@ -0,0 +1,51 @@
+import { validate, getOpenApiDocumentFromUrl, isAllowedLocalSchemaUrl } from '@mintlify/common';
+import { addLog, ErrorLog, SuccessLog, WarningLog } from '@mintlify/previewing';
+import type { DocsConfig } from '@mintlify/validation';
+
+import { readLocalOpenApiFile } from './helpers.js';
+
+export const getOpenApiFilenamesFromDocsConfig = (config: Pick<DocsConfig, 'api'>): string[] => {
+  const openapi = config.api?.openapi;
+  if (openapi === undefined) return [];
+  if (typeof openapi === 'string') return [openapi];
+  if (Array.isArray(openapi)) return openapi;
+  return [openapi.source];
+};
+
+export const checkOpenApiFile = async (
+  filename: string,
+  localSchema: boolean
+): Promise<boolean> => {
+  try {
+    if (isAllowedLocalSchemaUrl(filename, localSchema)) {
+      await getOpenApiDocumentFromUrl(filename);
+      addLog(<SuccessLog message="OpenAPI definition is valid." />);
+      return true;
+    }
+
+    if (filename.startsWith('http://') && !localSchema) {
+      addLog(
+        <WarningLog message="include the --local-schema flag to check locally hosted OpenAPI files" />
+      );
+      addLog(<WarningLog message="only https protocol is supported in production" />);
+      return true;
+    }
+
+    const document = await readLocalOpenApiFile(filename);
+    if (!document) {
+      throw new Error(
+        'failed to parse OpenAPI spec: could not parse file correctly, please check for any syntax errors.'
+      );
+    }
+    await validate(document);
+    addLog(<SuccessLog message="OpenAPI definition is valid." />);
+    return true;
+  } catch (err) {
+    if (err && typeof err === 'object' && 'code' in err && err.code === 'ENOENT') {
+      addLog(<ErrorLog message={`file not found, please check the path provided: ${filename}`} />);
+    } else {
+      addLog(<ErrorLog message={err instanceof Error ? err.message : 'unknown error'} />);
+    }
+    return false;
+  }
+};