@mintlify/common 1.0.1105 → 1.0.1107

package/dist/mintIgnore.d.ts

@@ -1,3 +1,4 @@
+import { type Ignore } from 'ignore';
 /**
  * Default patterns that Mintlify always ignores, regardless of .mintignore configuration.
  * These directories are typically version control, IDE configs, or dependencies.
@@ -15,8 +16,43 @@ export declare function processMintIgnoreString(mintIgnoreContent: string): stri
  * 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.
  *
+ * Compiles the patterns on every call, so this is for one-off checks only. To check
+ * many paths, build a matcher once with {@link createMintIgnoreMatcher} and pass it
+ * to {@link isMintIgnoredBy}.
+ *
  * @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;
+/**
+ * A reusable matcher produced by {@link createMintIgnoreMatcher}.
+ *
+ * Structural rather than the `ignore` package's own type, so callers can hold a
+ * matcher without taking a dependency on that package's typings.
+ */
+export type MintIgnoreMatcher = Pick<Ignore, 'ignores'>;
+/**
+ * Checks a path against a matcher the caller already built.
+ *
+ * Prefer this over {@link isMintIgnored} in loops. Building the matcher is the
+ * expensive half of the check, so hoisting it out of the loop with
+ * {@link createMintIgnoreMatcher} makes that cost visible and pays it once.
+ *
+ * @param filePath The path of the file to check.
+ * @param matcher A matcher from {@link createMintIgnoreMatcher}.
+ * @returns True if the file matches any of the matcher's patterns, false otherwise.
+ */
+export declare function isMintIgnoredBy(filePath: string, matcher: MintIgnoreMatcher): boolean;
+/**
+ * Compiles the default ignores plus any custom patterns into a reusable matcher.
+ *
+ * Compiling is orders of magnitude more expensive than testing a single path
+ * against the result, so anything checking more than a handful of paths should
+ * build one matcher here and pass it to {@link isMintIgnoredBy} rather than
+ * calling {@link isMintIgnored} per path.
+ *
+ * @param globs An array of custom glob patterns (output from processMintIgnoreString).
+ * @returns A matcher covering DEFAULT_MINT_IGNORES plus the provided patterns.
+ */
+export declare function createMintIgnoreMatcher(globs?: string[]): MintIgnoreMatcher;

package/dist/mintIgnore.js

@@ -35,12 +35,42 @@ export function processMintIgnoreString(mintIgnoreContent) {
  * 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.
  *
+ * Compiles the patterns on every call, so this is for one-off checks only. To check
+ * many paths, build a matcher once with {@link createMintIgnoreMatcher} and pass it
+ * to {@link isMintIgnoredBy}.
+ *
  * @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);
+    return isMintIgnoredBy(filePath, createMintIgnoreMatcher(globs));
+}
+/**
+ * Checks a path against a matcher the caller already built.
+ *
+ * Prefer this over {@link isMintIgnored} in loops. Building the matcher is the
+ * expensive half of the check, so hoisting it out of the loop with
+ * {@link createMintIgnoreMatcher} makes that cost visible and pays it once.
+ *
+ * @param filePath The path of the file to check.
+ * @param matcher A matcher from {@link createMintIgnoreMatcher}.
+ * @returns True if the file matches any of the matcher's patterns, false otherwise.
+ */
+export function isMintIgnoredBy(filePath, matcher) {
+    return matcher.ignores(filePath);
+}
+/**
+ * Compiles the default ignores plus any custom patterns into a reusable matcher.
+ *
+ * Compiling is orders of magnitude more expensive than testing a single path
+ * against the result, so anything checking more than a handful of paths should
+ * build one matcher here and pass it to {@link isMintIgnoredBy} rather than
+ * calling {@link isMintIgnored} per path.
+ *
+ * @param globs An array of custom glob patterns (output from processMintIgnoreString).
+ * @returns A matcher covering DEFAULT_MINT_IGNORES plus the provided patterns.
+ */
+export function createMintIgnoreMatcher(globs = []) {
+    return ignore().add(Array.from(new Set([...DEFAULT_MINT_IGNORES, ...globs])));
 }