mirror of
https://github.com/Snigdha-OS/documentation.git
synced 2025-09-10 19:54:57 +02:00
40 lines
1.6 KiB
TypeScript
40 lines
1.6 KiB
TypeScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
/** A re-export of the globby instance. */
|
|
export { default as Globby } from 'globby';
|
|
/**
|
|
* The default glob patterns we ignore when sourcing content.
|
|
* - Ignore files and folders starting with `_` recursively
|
|
* - Ignore tests
|
|
*/
|
|
export declare const GlobExcludeDefault: string[];
|
|
type Matcher = (str: string) => boolean;
|
|
/**
|
|
* A very thin wrapper around `Micromatch.makeRe`.
|
|
*
|
|
* @see {@link createAbsoluteFilePathMatcher}
|
|
* @param patterns A list of glob patterns. If the list is empty, it defaults to
|
|
* matching none.
|
|
* @returns A matcher handle that tells if a file path is matched by any of the
|
|
* patterns.
|
|
*/
|
|
export declare function createMatcher(patterns: string[]): Matcher;
|
|
/**
|
|
* We use match patterns like `"** /_* /**"` (ignore the spaces), where `"_*"`
|
|
* should only be matched within a subfolder. This function would:
|
|
* - Match `/user/sebastien/website/docs/_partials/xyz.md`
|
|
* - Ignore `/user/_sebastien/website/docs/partials/xyz.md`
|
|
*
|
|
* @param patterns A list of glob patterns.
|
|
* @param rootFolders A list of root folders to resolve the glob from.
|
|
* @returns A matcher handle that tells if a file path is matched by any of the
|
|
* patterns, resolved from the first root folder that contains the path.
|
|
* @throws Throws when the returned matcher receives a path that doesn't belong
|
|
* to any of the `rootFolders`.
|
|
*/
|
|
export declare function createAbsoluteFilePathMatcher(patterns: string[], rootFolders: string[]): Matcher;
|
|
//# sourceMappingURL=globUtils.d.ts.map
|