File tree Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Original file line number Diff line number Diff line change @@ -3,14 +3,49 @@ import { ComponentsDir, ComponentsOptions } from '@nuxt/schema'
3
3
import { HookData } from './types'
4
4
5
5
export interface ModuleOptions {
6
+ /**
7
+ * Directory where files metas are outputed upon parsing.
8
+ *
9
+ * It will create `component-meta.d.ts` and `component-meta.mjs` files.
10
+ */
6
11
outputDir ?: string
12
+ /**
13
+ * Nuxt root directory.
14
+ *
15
+ * Should be auto-filled by the module/process.
16
+ */
7
17
rootDir ?: string
18
+ /**
19
+ * Debug level: true, false or 2.
20
+ *
21
+ * 2 will log every timings for components parsing.
22
+ */
8
23
debug ?: boolean | 2
24
+ /**
25
+ * Components directories pushed in the include list.
26
+ */
9
27
componentDirs : ( string | ComponentsDir ) [ ]
28
+ /**
29
+ * Components options pushed in include list.
30
+ */
10
31
components ?: ComponentsOptions [ ]
32
+ /**
33
+ * Component paths and/or path regexps to be excluded.
34
+ */
11
35
exclude ?: ( string | RegExp | ( ( component : any ) => boolean ) ) [ ]
36
+ /**
37
+ * vue-component-meta checker options.
38
+ */
12
39
checkerOptions ?: MetaCheckerOptions
40
+ /**
41
+ * Extra transformers to be run on top of each component code.
42
+ *
43
+ * `component` will be the Nuxt component options for this component and `code` the code of the component.
44
+ */
13
45
transformers ?: ( ( component : any , code : string ) => ( { component : any ; code : string } ) ) [ ]
46
+ /**
47
+ * Filter all components that are not global.
48
+ */
14
49
globalsOnly ?: boolean
15
50
}
16
51
You can’t perform that action at this time.
0 commit comments