Add convertPathToPattern() method

sindresorhus · Nov 9, 2023 · 3bd00a6 · 3bd00a6
1 parent 2c06ae5
commit 3bd00a6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,3 +1,4 @@
+import type FastGlob from 'fast-glob';
 import {type Options as FastGlobOptions, type Entry} from 'fast-glob';
 
 export type GlobEntry = Entry;
@@ -203,3 +204,5 @@ export function isGitIgnored(options?: GitignoreOptions): Promise<GlobbyFilterFu
 @returns A filter function indicating whether a given path is ignored via a `.gitignore` file.
 */
 export function isGitIgnoredSync(options?: GitignoreOptions): GlobbyFilterFunction;
+
+export function convertPathToPattern(source: string): FastGlob.Pattern;
diff --git a/index.js b/index.js
@@ -260,3 +260,5 @@ export {
 	isGitIgnored,
 	isGitIgnoredSync,
 } from './ignore.js';
+
+export const {convertPathToPattern} = fastGlob;
diff --git a/readme.md b/readme.md
@@ -113,6 +113,10 @@ for await (const path of globbyStream('*.tmp')) {
 }
 ```
 
+### convertPathToPattern(path)
+
+Convert a path to a pattern. [Learn more.](https://github.com/mrmlnc/fast-glob#convertpathtopatternpath)
+
 ### generateGlobTasks(patterns, options?)
 
 Returns an `Promise<object[]>` in the format `{patterns: string[], options: Object}`, which can be passed as arguments to [`fast-glob`](https://github.com/mrmlnc/fast-glob). This is useful for other globbing-related packages.