Skip to content

Interface: ComponentDiscoveryOptions ​

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:24

Copyright (c) Meta Platforms, Inc. and affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

Properties ​

clean? ​

optional clean: boolean

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:53

Clean output directory before generating new files

Default ​

ts
true

enableWatcher? ​

optional enableWatcher: boolean

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:71

Enable dev watcher for incremental updates (serve mode)


exclude? ​

optional exclude: RegExp

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:41

File pattern to exclude

Default ​

ts
/node_modules/

include? ​

optional include: RegExp

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:35

File pattern to include

Default ​

ts
/\.(js|ts|jsx|tsx)$/

includeXmlDeclaration? ​

optional includeXmlDeclaration: boolean

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:68

Include XML declaration header in generated files

Default ​

ts
false

outputDir? ​

optional outputDir: string

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:29

Output directory for generated XML files

Default ​

ts
'generated/components'

scanPackages? ​

optional scanPackages: string[]

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:62

Additional node_modules packages to scan (advanced) Most users won't need this - only specify if you have framework components in specific packages that should be included despite being in node_modules

Default ​

ts
['@iwsdk']

verbose? ​

optional verbose: boolean

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:47

Enable verbose logging

Default ​

ts
false

watchDebounceMs? ​

optional watchDebounceMs: number

Defined in: packages/vite-plugin-metaspatial/src/discover-components/index.ts:73

Debounce delay (ms) for dev watcher

Privacy | Terms