.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / fast-glob / out / managers / options.d.ts
1 import { EntryItem } from '../types/entries';\r
2 import { Pattern } from '../types/patterns';\r
3 export declare type TransformFunction<T> = (entry: EntryItem) => T;\r
4 export interface IOptions<T = EntryItem> {\r
5     /**\r
6      * The current working directory in which to search.\r
7      */\r
8     cwd: string;\r
9     /**\r
10      * The deep option can be set to true to traverse the entire directory structure,\r
11      * or it can be set to a number to only traverse that many levels deep.\r
12      */\r
13     deep: number | boolean;\r
14     /**\r
15      * Add an array of glob patterns to exclude matches.\r
16      */\r
17     ignore: Pattern[];\r
18     /**\r
19      * Allow patterns to match filenames starting with a period (files & directories),\r
20      * even if the pattern does not explicitly have a period in that spot.\r
21      */\r
22     dot: boolean;\r
23     /**\r
24      * Return `fs.Stats` with `path` property instead of file path.\r
25      */\r
26     stats: boolean;\r
27     /**\r
28      * Return only files.\r
29      */\r
30     onlyFiles: boolean;\r
31     /**\r
32      * Return only directories.\r
33      */\r
34     onlyDirectories: boolean;\r
35     /**\r
36      * Follow symlinked directories when expanding `**` patterns.\r
37      */\r
38     followSymlinkedDirectories: boolean;\r
39     /**\r
40      * Prevent duplicate results.\r
41      */\r
42     unique: boolean;\r
43     /**\r
44      * Add a `/` character to directory entries.\r
45      */\r
46     markDirectories: boolean;\r
47     /**\r
48      * Return absolute paths for matched entries.\r
49      */\r
50     absolute: boolean;\r
51     /**\r
52      * Disable expansion of brace patterns.\r
53      */\r
54     nobrace: boolean;\r
55     /**\r
56      * Enable expansion of brace patterns.\r
57      */\r
58     brace: boolean;\r
59     /**\r
60      * Disable matching with globstars (`**`).\r
61      */\r
62     noglobstar: boolean;\r
63     /**\r
64      * Enable matching with globstars (`**`).\r
65      */\r
66     globstar: boolean;\r
67     /**\r
68      * Disable extglob support, so that extglobs are regarded as literal characters.\r
69      */\r
70     noext: boolean;\r
71     /**\r
72      * Enable extglob support, so that extglobs are regarded as literal characters.\r
73      */\r
74     extension: boolean;\r
75     /**\r
76      * Disable a case-insensitive regex for matching files.\r
77      */\r
78     nocase: boolean;\r
79     /**\r
80      * Enable a case-insensitive regex for matching files.\r
81      */\r
82     case: boolean;\r
83     /**\r
84      * Allow glob patterns without slashes to match a file path based on its basename.\r
85      * For example, `a?b` would match the path `/xyz/123/acb`, but not `/xyz/acb/123`.\r
86      */\r
87     matchBase: boolean;\r
88     /**\r
89      * Allows you to transform a path or `fs.Stats` object before sending to the array.\r
90      */\r
91     transform: TransformFunction<T> | null;\r
92 }\r
93 export declare type IPartialOptions<T = EntryItem> = Partial<IOptions<T>>;\r
94 export declare function prepare(options?: IPartialOptions): IOptions;\r