@mintlify/common 1.0.612 → 1.0.613

package/dist/getFileCategory.d.ts

@@ -1,4 +1,4 @@
-export type PotentialFileCategory = 'page' | 'snippet' | 'mintConfig' | 'potentialYamlOpenApiSpec' | 'potentialJsonOpenApiSpec' | 'staticFile' | 'snippet-v2' | 'css' | 'js' | 'docsConfig' | 'generatedStaticFile' | null;
+export type PotentialFileCategory = 'page' | 'snippet' | 'mintConfig' | 'potentialYamlOpenApiSpec' | 'potentialJsonOpenApiSpec' | 'staticFile' | 'snippet-v2' | 'css' | 'js' | 'docsConfig' | 'generatedStaticFile' | 'mintIgnore' | null;
 export type FileCategory = Omit<PotentialFileCategory, 'potentialYamlOpenApiSpec' | 'potentialJsonOpenApiSpec'> | 'openApi' | null;
 export declare const generatedStaticFiles: readonly ["llms.txt", "robots.txt", "sitemap.xml", "llms-full.txt"];
 export type GeneratedStaticFile = (typeof generatedStaticFiles)[number];

package/dist/getFileCategory.js

@@ -82,6 +82,9 @@ export const getFileCategory = (filePath) => {
     if (parsed.base === 'docs.json') {
         return 'docsConfig';
     }
+    if (parsed.base === '.mintignore') {
+        return 'mintIgnore';
+    }
     const fileName = parsed.name;
     const extension = parsed.ext;
     if (generatedStaticFiles.includes(parsed.base)) {

package/dist/index.d.ts

@@ -24,3 +24,4 @@ export * from './slugify.js';
 export * from './services/aws.js';
 export * from './truncateAtWordBoundary.js';
 export * from './api-reference/parseApiTargetFromMetadata.js';
+export * from './mintIgnore.js';

package/dist/index.js

@@ -24,3 +24,4 @@ export * from './slugify.js';
 export * from './services/aws.js';
 export * from './truncateAtWordBoundary.js';
 export * from './api-reference/parseApiTargetFromMetadata.js';
+export * from './mintIgnore.js';

package/dist/mintIgnore.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Default patterns that Mintlify always ignores, regardless of .mintignore configuration.
+ * These directories are typically version control, IDE configs, or dependencies.
+ */
+export declare const DEFAULT_MINT_IGNORES: string[];
+/**
+ * Processes the contents of a .mintignore file and returns an array of relevant patterns.
+ * The ignore package automatically handles comments (lines starting with #) and empty lines.
+ *
+ * @param mintIgnoreContent The content of the .mintignore file.
+ * @returns An array of glob patterns.
+ */
+export declare function processMintIgnoreString(mintIgnoreContent: string): string[];
+/**
+ * Checks if a file path is ignored based on the provided glob patterns and default ignores.
+ * Always includes DEFAULT_MINT_IGNORES in addition to any custom patterns provided.
+ *
+ * @param filePath The path of the file to check.
+ * @param globs An array of custom glob patterns (output from processMintIgnoreString).
+ * @returns True if the file matches any of the ignore patterns (default or custom), false otherwise.
+ */
+export declare function isMintIgnored(filePath: string, globs?: string[]): boolean;

package/dist/mintIgnore.js

@@ -0,0 +1,36 @@
+import ignore from 'ignore';
+/**
+ * Default patterns that Mintlify always ignores, regardless of .mintignore configuration.
+ * These directories are typically version control, IDE configs, or dependencies.
+ */
+export const DEFAULT_MINT_IGNORES = [
+    '.git',
+    '.github',
+    '.claude',
+    '.agents',
+    '.idea',
+    'node_modules',
+];
+/**
+ * Processes the contents of a .mintignore file and returns an array of relevant patterns.
+ * The ignore package automatically handles comments (lines starting with #) and empty lines.
+ *
+ * @param mintIgnoreContent The content of the .mintignore file.
+ * @returns An array of glob patterns.
+ */
+export function processMintIgnoreString(mintIgnoreContent) {
+    return mintIgnoreContent.split(/\r?\n/).map((line) => line.trim());
+}
+/**
+ * Checks if a file path is ignored based on the provided glob patterns and default ignores.
+ * Always includes DEFAULT_MINT_IGNORES in addition to any custom patterns provided.
+ *
+ * @param filePath The path of the file to check.
+ * @param globs An array of custom glob patterns (output from processMintIgnoreString).
+ * @returns True if the file matches any of the ignore patterns (default or custom), false otherwise.
+ */
+export function isMintIgnored(filePath, globs = []) {
+    const allPatterns = Array.from(new Set([...DEFAULT_MINT_IGNORES, ...globs]));
+    const ig = ignore().add(allPatterns);
+    return ig.ignores(filePath);
+}