ExportisIgnoredByIgnoreFiles and isIgnoredByIgnoreFilesSync for s…

…ome bottom level scene
sindresorhus · jiawei397 · Sep 10, 2024 · Sep 10, 2024 · Sep 10, 2024 · 2e0a0caba998598245b09fc20b8cea20645f88d8
commit 2e0a0caba998598245b09fc20b8cea20645f88d8
diff --git a/index.d.ts b/index.d.ts
@@ -205,3 +205,43 @@
 export function isGitIgnoredSync(options?: GitignoreOptions): GlobbyFilterFunction;
 
 export function convertPathToPattern(source: string): FastGlob.Pattern;
+
+
+/**
+ * Check if a path is ignored by the ignore files.
+ * @param patterns - See the supported [glob patterns](https://github.com/sindresorhus/globby#globbing-patterns).
+ * @param options - See the [`fast-glob` options](https://github.com/mrmlnc/fast-glob#options-3) in addition to the ones in this package.
+ *
+ * @returns A filter function indicating whether a given path is ignored via the ignore files.
+ *
+ * @example
+ * ```
+ * import {isIgnoredByIgnoreFiles} from 'globby';
+ *
+ * const isIgnored = await isIgnoredByIgnoreFiles('**\/.gitignore');
+ *
+ * console.log(isIgnored('some/file'));
+ * ```
+ */
+export function isIgnoredByIgnoreFiles(
+	patterns: string | readonly string[],
+	options?: Options
+): Promise<GlobbyFilterFunction>;
+
+/**
+ * Check if a path is ignored by the ignore files.
+ * @see {@link isIgnoredByIgnoreFiles}
+ *
+ * @example
+ * ```js
+ * import {isIgnoredByIgnoreFilesSync} from 'globby';
+ *
+ * const isIgnored = isIgnoredByIgnoreFilesSync('**\/.gitignore');
+ *
+ * console.log(isIgnored('some/file'));
+ * ```
+ */
+export function isIgnoredByIgnoreFilesSync(
+	patterns: string | readonly string[],
+	options?: Options
+): GlobbyFilterFunction;
diff --git a/index.js b/index.js
@@ -259,6 +259,8 @@
 export {
 	isGitIgnored,
 	isGitIgnoredSync,
+	isIgnoredByIgnoreFiles,
+	isIgnoredByIgnoreFilesSync
 } from './ignore.js';
 
 export const {convertPathToPattern} = fastGlob;
diff --git a/readme.md b/readme.md
@@ -157,6 +157,39 @@ Returns a `(path: URL | string) => boolean` indicating whether a given path is i
 
 Takes `cwd?: URL | string` as options.
 
+
+### isIgnoredByIgnoreFiles(patterns, options?)
+
+Returns a `Promise<(path: URL | string) => boolean>` indicating whether a given path is ignored via an ignore file.
+
+This is a more generic form of the `isGitIgnored` function, allowing you to find ignore files with a [compatible syntax](http://git-scm.com/docs/gitignore). For instance, this works with Babel's `.babelignore`, Prettier's `.prettierignore`, or ESLint's `.eslintignore` files.
+
+Takes `cwd?: URL | string` as options.
+
+```js
+import {isIgnoredByIgnoreFiles} from 'globby';
+
+const isIgnored = await isIgnoredByIgnoreFiles("**/.gitignore");
+
+console.log(isIgnored('some/file'));
+```
+
+### isIgnoredByIgnoreFilesSync(patterns, options?)
+
+Returns a `(path: URL | string) => boolean` indicating whether a given path is ignored via an ignore file.
+
+This is a more generic form of the `isGitIgnoredSync` function, allowing you to find ignore files with a [compatible syntax](http://git-scm.com/docs/gitignore). For instance, this works with Babel's `.babelignore`, Prettier's `.prettierignore`, or ESLint's `.eslintignore` files.
+
+Takes `cwd?: URL | string` as options.
+
+```js
+import {isIgnoredByIgnoreFilesSync} from 'globby';
+
+const isIgnored = isIgnoredByIgnoreFilesSync("**/.gitignore");
+
+console.log(isIgnored('some/file'));
+```
+
 ## Globbing patterns
 
 Just a quick overview.