@mintlify/previewing 4.0.1547 → 4.0.1549

package/dist/__tests__/validate-build.test.js

@@ -1,10 +1,11 @@
-import { prebuild } from '@mintlify/prebuild';
+import { getWarnings, prebuild } from '@mintlify/prebuild';
 import { isOnline } from '../local-preview/is-online.js';
-import { checkBuild } from '../local-preview/validate-build.js';
+import validateBuild, { checkBuild } from '../local-preview/validate-build.js';
 import { addLog } from '../logging-state.js';
+import { WarningLog } from '../logs.js';
 vi.mock('@mintlify/prebuild', async (importOriginal) => {
     const mod = await importOriginal();
-    return { ...mod, prebuild: vi.fn() };
+    return { ...mod, prebuild: vi.fn(), getWarnings: vi.fn(() => []) };
 });
 vi.mock('../local-preview/is-online.js', () => ({ isOnline: vi.fn() }));
 vi.mock('fs-extra', () => {
@@ -30,13 +31,22 @@ describe('checkBuild', () => {
         vi.mocked(isOnline).mockResolvedValue(true);
         vi.spyOn(process, 'chdir').mockImplementation(() => undefined);
     });
+    it('logs nothing', async () => {
+        vi.mocked(prebuild).mockRejectedValue(new Error('Build validation failed with 1 warning(s). See above for details.'));
+        const result = await checkBuild(argv);
+        expect(result).toMatchObject({
+            passed: false,
+            error: expect.stringContaining('Build validation failed'),
+        });
+        expect(addLog).not.toHaveBeenCalled();
+    });
     it('passes when prebuild succeeds', async () => {
         vi.mocked(prebuild).mockResolvedValue(undefined);
-        expect(await checkBuild(argv)).toEqual({ passed: true });
+        expect(await checkBuild(argv)).toEqual({ passed: true, warnings: [] });
     });
     it('returns a build failure instead of exiting', async () => {
         vi.mocked(prebuild).mockRejectedValue(new Error('boom'));
-        expect(await checkBuild(argv)).toEqual({ passed: false, error: 'boom' });
+        expect(await checkBuild(argv)).toEqual({ passed: false, error: 'boom', warnings: [] });
     });
     it.each([
         ['passes', () => vi.mocked(prebuild).mockResolvedValue(undefined)],
@@ -56,3 +66,19 @@ describe('checkBuild', () => {
         expect(prebuild).not.toHaveBeenCalled();
     });
 });
+describe('validateBuild', () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+        vi.mocked(isOnline).mockResolvedValue(true);
+        vi.spyOn(process, 'chdir').mockImplementation(() => undefined);
+        vi.spyOn(process, 'exit').mockImplementation(() => undefined);
+    });
+    it('prints the collected warnings before the failure', async () => {
+        vi.mocked(prebuild).mockRejectedValue(new Error('Build validation failed with 1 warning(s).'));
+        vi.mocked(getWarnings).mockReturnValue([{ type: 'missing-file', message: 'missing a.mdx' }]);
+        await validateBuild(argv);
+        const logged = vi.mocked(addLog).mock.calls.map(([node]) => node);
+        expect(logged).toContainEqual(expect.objectContaining({ type: WarningLog, props: { message: 'missing a.mdx' } }));
+        expect(process.exit).toHaveBeenCalledWith(1);
+    });
+});

package/dist/local-preview/validate-build.d.ts

@@ -1,10 +1,17 @@
+import { type Warning } from '@mintlify/prebuild';
 import { ArgumentsCamelCase } from 'yargs';
-export type BuildValidationResult = {
+export type BuildValidationResult = ({
     passed: true;
 } | {
     passed: false;
     error: string;
+}) & {
+    warnings: Warning[];
 };
+/**
+ * Runs the strict prebuild and returns its result without logging: warnings are collected
+ * instead of printed.
+ */
 export declare const checkBuild: (argv: ArgumentsCamelCase) => Promise<BuildValidationResult>;
 declare const validateBuild: (argv: ArgumentsCamelCase, onSuccess?: () => Promise<void>) => Promise<never>;
 export default validateBuild;

package/dist/local-preview/validate-build.js

@@ -1,12 +1,16 @@
 import { jsx as _jsx } from "react/jsx-runtime";
-import { prebuild } from '@mintlify/prebuild';
+import { getWarnings, prebuild, setWarningsSilent } from '@mintlify/prebuild';
 import fse, { pathExists } from 'fs-extra';
 import { CLIENT_PATH, CMD_EXEC_PATH, VERSION_PATH, NEXT_PUBLIC_PATH, NEXT_PROPS_PATH, PREVIEW_PATH, configureSharedPreviewPath, } from '../constants.js';
 import { addLog, clearLogs } from '../logging-state.js';
-import { ErrorLog, SpinnerLog, SuccessLog } from '../logs.js';
+import { ErrorLog, SpinnerLog, SuccessLog, WarningLog } from '../logs.js';
 import { timeDev, timeDevSync } from './dev-timing.js';
 import { isOnline } from './is-online.js';
 import { silentUpdateClient } from './update.js';
+/**
+ * Runs the strict prebuild and returns its result without logging: warnings are collected
+ * instead of printed.
+ */
 export const checkBuild = async (argv) => {
     configureSharedPreviewPath();
     const hasInternet = await timeDev('check internet', () => isOnline());
@@ -41,21 +45,24 @@ export const checkBuild = async (argv) => {
     timeDevSync('switch to local client directory', () => {
         process.chdir(CLIENT_PATH);
     });
+    const runPrebuild = () => timeDev('prebuild content', () => prebuild(CMD_EXEC_PATH, {
+        localSchema,
+        groups,
+        disableOpenApi,
+        strict: true,
+        skipStaticFiles: true,
+    }));
+    setWarningsSilent(true);
     try {
-        await timeDev('prebuild content', () => prebuild(CMD_EXEC_PATH, {
-            localSchema,
-            groups,
-            disableOpenApi,
-            strict: true,
-            skipStaticFiles: true,
-        }));
-        return { passed: true };
+        await runPrebuild();
+        return { passed: true, warnings: getWarnings() };
     }
     catch (err) {
         const errorText = err instanceof Error && err.message ? err.message : 'build validation failed';
-        return { passed: false, error: errorText };
+        return { passed: false, error: errorText, warnings: getWarnings() };
     }
     finally {
+        setWarningsSilent(false);
         process.chdir(cwd);
     }
 };
@@ -65,6 +72,7 @@ const validateBuild = async (argv, onSuccess) => {
     try {
         const result = await checkBuild(argv);
         clearLogs();
+        result.warnings.forEach(({ message }) => addLog(_jsx(WarningLog, { message: message })));
         if (result.passed) {
             addLog(_jsx(SuccessLog, { message: "build validation passed" }));
             await onSuccess?.();