Skip to content

Commit e3b7e06

Browse files
authored
docs(plugin-vue): update options in README (#11125)
1 parent e293bef commit e3b7e06

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

packages/plugin-vue/README.md

+24-21
Original file line numberDiff line numberDiff line change
@@ -20,45 +20,48 @@ export interface Options {
2020
include?: string | RegExp | (string | RegExp)[]
2121
exclude?: string | RegExp | (string | RegExp)[]
2222

23-
ssr?: boolean
2423
isProduction?: boolean
2524

25+
// options to pass on to vue/compiler-sfc
26+
script?: Partial<Pick<SFCScriptCompileOptions, 'babelParserPlugins'>>
27+
template?: Partial<
28+
Pick<
29+
SFCTemplateCompileOptions,
30+
| 'compiler'
31+
| 'compilerOptions'
32+
| 'preprocessOptions'
33+
| 'preprocessCustomRequire'
34+
| 'transformAssetUrls'
35+
>
36+
>
37+
style?: Partial<Pick<SFCStyleCompileOptions, 'trim'>>
38+
2639
/**
27-
* Transform Vue SFCs into custom elements (requires vue@^3.2.0)
28-
* - `true` -> all `*.vue` imports are converted into custom elements
29-
* - `string | RegExp` -> matched files are converted into custom elements
40+
* Transform Vue SFCs into custom elements.
41+
* - `true`: all `*.vue` imports are converted into custom elements
42+
* - `string | RegExp`: matched files are converted into custom elements
3043
*
3144
* @default /\.ce\.vue$/
3245
*/
3346
customElement?: boolean | string | RegExp | (string | RegExp)[]
3447

3548
/**
36-
* Enable Vue reactivity transform (experimental, requires vue@^3.2.25).
37-
* https://github.com/vuejs/core/tree/master/packages/reactivity-transform
38-
*
49+
* Enable Vue reactivity transform (experimental).
50+
* https://vuejs.org/guide/extras/reactivity-transform.html
3951
* - `true`: transform will be enabled for all vue,js(x),ts(x) files except
4052
* those inside node_modules
4153
* - `string | RegExp`: apply to vue + only matched files (will include
42-
* node_modules, so specify directories in necessary)
54+
* node_modules, so specify directories if necessary)
4355
* - `false`: disable in all cases
4456
*
4557
* @default false
4658
*/
4759
reactivityTransform?: boolean | string | RegExp | (string | RegExp)[]
4860

49-
// options to pass on to vue/compiler-sfc
50-
script?: Partial<Pick<SFCScriptCompileOptions, 'babelParserPlugins'>>
51-
template?: Partial<
52-
Pick<
53-
SFCTemplateCompileOptions,
54-
| 'compiler'
55-
| 'compilerOptions'
56-
| 'preprocessOptions'
57-
| 'preprocessCustomRequire'
58-
| 'transformAssetUrls'
59-
>
60-
>
61-
style?: Partial<Pick<SFCStyleCompileOptions, 'trim'>>
61+
/**
62+
* Use custom compiler-sfc instance. Can be used to force a specific version.
63+
*/
64+
compiler?: typeof _compiler
6265
}
6366
```
6467

0 commit comments

Comments
 (0)