@mintlify/previewing 4.0.790 → 4.0.792

package/dist/local-preview/listener/generate.js

@@ -1,4 +1,4 @@
-import { categorizeFilePaths, createPage, generateDecoratedDocsNavigationFromPages, } from '@mintlify/prebuild';
+import { categorizeFilePaths, createPage, generateDecoratedDocsNavigationFromPages, getMintIgnore, } from '@mintlify/prebuild';
 import { promises as _promises } from 'fs';
 import { join } from 'path';
 import { CMD_EXEC_PATH } from '../../constants.js';
@@ -20,7 +20,8 @@ const createFilenamePageMetadataMap = async ({ contentDirectoryPath, contentFile
     return pagesAcc;
 };
 export const generateNav = async (pagesAcc, docsConfig) => {
-    const { contentFilenames, openApiFiles, asyncApiFiles } = await categorizeFilePaths(CMD_EXEC_PATH);
+    const mintIgnore = await getMintIgnore(CMD_EXEC_PATH);
+    const { contentFilenames, openApiFiles, asyncApiFiles } = await categorizeFilePaths(CMD_EXEC_PATH, mintIgnore);
     const filenamePageMetadataMap = await createFilenamePageMetadataMap({
         contentDirectoryPath: CMD_EXEC_PATH,
         contentFilenames,

package/dist/local-preview/listener/getDocsState.js

@@ -1,10 +1,11 @@
-import { generateOpenApiAnchorsOrTabs, categorizeFilePaths, generateOpenApiDivisions, MintConfigUpdater, DocsConfigUpdater, } from '@mintlify/prebuild';
+import { generateOpenApiAnchorsOrTabs, categorizeFilePaths, generateOpenApiDivisions, getMintIgnore, MintConfigUpdater, DocsConfigUpdater, } from '@mintlify/prebuild';
 import { upgradeToDocsConfig } from '@mintlify/validation';
 import fse from 'fs-extra';
 import { join } from 'path';
 import { CMD_EXEC_PATH, CLIENT_PATH } from '../../constants.js';
 export const getDocsState = async () => {
-    const { openApiFiles } = await categorizeFilePaths(CMD_EXEC_PATH);
+    const mintIgnore = await getMintIgnore(CMD_EXEC_PATH);
+    const { openApiFiles } = await categorizeFilePaths(CMD_EXEC_PATH, mintIgnore);
     try {
         const mintConfig = await MintConfigUpdater.getConfig(join(CMD_EXEC_PATH, 'mint.json'));
         const docsConfig = upgradeToDocsConfig(mintConfig);

package/dist/local-preview/listener/index.d.ts

@@ -1,2 +1,5 @@
-declare const listener: (callback: () => void) => void;
+declare const listener: (callback: () => void, options?: {
+    localSchema?: boolean;
+    groups?: string[];
+}) => void;
 export default listener;

package/dist/local-preview/listener/index.js

@@ -1,6 +1,6 @@
 import { jsx as _jsx } from "react/jsx-runtime";
-import { findAndRemoveImports, hasImports, getFileCategory, openApiCheck, stringifyTree, } from '@mintlify/common';
-import { createPage, MintConfigUpdater, DocsConfigUpdater, preparseMdxTree, } from '@mintlify/prebuild';
+import { findAndRemoveImports, hasImports, getFileCategory, openApiCheck, stringifyTree, processMintIgnoreString, isMintIgnored, DEFAULT_MINT_IGNORES, } from '@mintlify/common';
+import { createPage, MintConfigUpdater, DocsConfigUpdater, preparseMdxTree, prebuild, } from '@mintlify/prebuild';
 import Chalk from 'chalk';
 import chokidar from 'chokidar';
 import { promises as _promises } from 'fs';
@@ -10,7 +10,7 @@ import yaml from 'js-yaml';
 import pathUtil from 'path';
 import { CMD_EXEC_PATH, NEXT_PROPS_PATH, NEXT_PUBLIC_PATH, CLIENT_PATH } from '../../constants.js';
 import { addChangeLog } from '../../logging-state.js';
-import { AddedLog, DeletedLog, EditedLog } from '../../logs.js';
+import { AddedLog, DeletedLog, EditedLog, WarningLog, InfoLog } from '../../logs.js';
 import { generateDependentSnippets } from './generateDependentSnippets.js';
 import { generatePagesWithImports } from './generatePagesWithImports.js';
 import { getDocsState } from './getDocsState.js';
@@ -19,36 +19,53 @@ import { updateCustomLanguages, updateGeneratedNav, updateOpenApiFiles, upsertOp
 import { isFileSizeValid, shouldRegenerateNavForPage } from './utils.js';
 const { readFile } = _promises;
 const frontmatterHashes = new Map();
-const listener = (callback) => {
+const listener = (callback, options = {}) => {
     chokidar
         .watch(CMD_EXEC_PATH, {
         ignoreInitial: true,
-        ignored: ['node_modules', '.git', '.idea'],
+        ignored: DEFAULT_MINT_IGNORES,
         cwd: CMD_EXEC_PATH,
     })
-        .on('add', (filename) => onAddEvent(filename, callback))
-        .on('change', (filename) => onChangeEvent(filename, callback))
-        .on('unlink', onUnlinkEvent);
+        .on('add', (filename) => onAddEvent(filename, callback, options))
+        .on('change', (filename) => onChangeEvent(filename, callback, options))
+        .on('unlink', (filename) => onUnlinkEvent(filename, options));
 };
-const onAddEvent = async (filename, callback) => {
+const getMintIgnoreGlobs = () => {
+    const mintIgnorePath = pathUtil.join(CMD_EXEC_PATH, '.mintignore');
+    if (fse.existsSync(mintIgnorePath)) {
+        const content = fse.readFileSync(mintIgnorePath, 'utf8');
+        return processMintIgnoreString(content);
+    }
+    return [];
+};
+const onAddEvent = async (filename, callback, options) => {
+    if (isMintIgnored(filename, getMintIgnoreGlobs())) {
+        return;
+    }
     try {
-        await onUpdateEvent(filename, callback);
+        await onUpdateEvent(filename, callback, options);
         addChangeLog(_jsx(AddedLog, { filename: filename }));
     }
     catch (error) {
         console.error(error.message);
     }
 };
-const onChangeEvent = async (filename, callback) => {
+const onChangeEvent = async (filename, callback, options) => {
+    if (isMintIgnored(filename, getMintIgnoreGlobs())) {
+        return;
+    }
     try {
-        await onUpdateEvent(filename, callback);
+        await onUpdateEvent(filename, callback, options);
         addChangeLog(_jsx(EditedLog, { filename: filename }));
     }
     catch (error) {
         console.error(error.message);
     }
 };
-const onUnlinkEvent = async (filename) => {
+const onUnlinkEvent = async (filename, options) => {
+    if (isMintIgnored(filename, getMintIgnoreGlobs())) {
+        return;
+    }
     try {
         const potentialCategory = getFileCategory(filename);
         const targetPath = getTargetPath(potentialCategory, filename);
@@ -72,6 +89,17 @@ const onUnlinkEvent = async (filename) => {
                 console.error('docs.json has been deleted.');
                 await validateConfigFiles();
                 break;
+            case 'mintIgnore':
+                addChangeLog(_jsx(WarningLog, { message: ".mintignore has been deleted. Rebuilding..." }));
+                try {
+                    await fse.emptyDir(NEXT_PUBLIC_PATH);
+                    await fse.emptyDir(NEXT_PROPS_PATH);
+                    await prebuild(CMD_EXEC_PATH, options);
+                }
+                catch (err) {
+                    console.error('Error rebuilding after .mintignore deletion:', err);
+                }
+                break;
         }
         addChangeLog(_jsx(DeletedLog, { filename: filename }));
     }
@@ -92,6 +120,8 @@ const getTargetPath = (potentialCategory, filePath) => {
             return pathUtil.join(NEXT_PROPS_PATH, 'openApiFiles.json');
         case 'generatedStaticFile':
             return pathUtil.join(NEXT_PUBLIC_PATH, filePath);
+        case 'mintIgnore':
+            return pathUtil.join(NEXT_PROPS_PATH, 'mint-ignore.json');
         case 'snippet':
         case 'staticFile':
         case 'snippet-v2':
@@ -122,7 +152,7 @@ const validateConfigFiles = async () => {
  * @param filename
  * @returns FileCategory
  */
-const onUpdateEvent = async (filename, callback) => {
+const onUpdateEvent = async (filename, callback, options = {}) => {
     const filePath = pathUtil.join(CMD_EXEC_PATH, filename);
     const potentialCategory = getFileCategory(filename);
     const targetPath = getTargetPath(potentialCategory, filename);
@@ -182,6 +212,18 @@ const onUpdateEvent = async (filename, callback) => {
             }
             break;
         }
+        case 'mintIgnore': {
+            try {
+                addChangeLog(_jsx(InfoLog, { message: ".mintignore has been updated. Rebuilding..." }));
+                await fse.emptyDir(NEXT_PUBLIC_PATH);
+                await fse.emptyDir(NEXT_PROPS_PATH);
+                await prebuild(CMD_EXEC_PATH, options);
+            }
+            catch (err) {
+                console.error(err.message);
+            }
+            break;
+        }
         case 'potentialYamlOpenApiSpec':
         case 'potentialJsonOpenApiSpec': {
             let doc;