docs(plugin-vue): update options in README (#11125)

vitejs · Nov 29, 2022 · 23d79b8 · 23d79b8
1 parent 515caa5
commit 23d79b8
Showing 1 changed file with 24 additions and 21 deletions.
diff --git a/packages/plugin-vue/README.md b/packages/plugin-vue/README.md
@@ -20,45 +20,48 @@ export interface Options {
   include?: string | RegExp | (string | RegExp)[]
   exclude?: string | RegExp | (string | RegExp)[]
 
-  ssr?: boolean
   isProduction?: boolean
 
+  // options to pass on to vue/compiler-sfc
+  script?: Partial<Pick<SFCScriptCompileOptions, 'babelParserPlugins'>>
+  template?: Partial<
+    Pick<
+      SFCTemplateCompileOptions,
+      | 'compiler'
+      | 'compilerOptions'
+      | 'preprocessOptions'
+      | 'preprocessCustomRequire'
+      | 'transformAssetUrls'
+    >
+  >
+  style?: Partial<Pick<SFCStyleCompileOptions, 'trim'>>
+
   /**
-   * Transform Vue SFCs into custom elements (requires vue@^3.2.0)
-   * - `true` -> all `*.vue` imports are converted into custom elements
-   * - `string | RegExp` -> matched files are converted into custom elements
+   * Transform Vue SFCs into custom elements.
+   * - `true`: all `*.vue` imports are converted into custom elements
+   * - `string | RegExp`: matched files are converted into custom elements
    *
    * @default /\.ce\.vue$/
    */
   customElement?: boolean | string | RegExp | (string | RegExp)[]
 
   /**
-   * Enable Vue reactivity transform (experimental, requires vue@^3.2.25).
-   * https://github.com/vuejs/core/tree/master/packages/reactivity-transform
-   *
+   * Enable Vue reactivity transform (experimental).
+   * https://vuejs.org/guide/extras/reactivity-transform.html
    * - `true`: transform will be enabled for all vue,js(x),ts(x) files except
    *           those inside node_modules
    * - `string | RegExp`: apply to vue + only matched files (will include
-   *                      node_modules, so specify directories in necessary)
+   *                      node_modules, so specify directories if necessary)
    * - `false`: disable in all cases
    *
    * @default false
    */
   reactivityTransform?: boolean | string | RegExp | (string | RegExp)[]
 
-  // options to pass on to vue/compiler-sfc
-  script?: Partial<Pick<SFCScriptCompileOptions, 'babelParserPlugins'>>
-  template?: Partial<
-    Pick<
-      SFCTemplateCompileOptions,
-      | 'compiler'
-      | 'compilerOptions'
-      | 'preprocessOptions'
-      | 'preprocessCustomRequire'
-      | 'transformAssetUrls'
-    >
-  >
-  style?: Partial<Pick<SFCStyleCompileOptions, 'trim'>>
+  /**
+   * Use custom compiler-sfc instance. Can be used to force a specific version.
+   */
+  compiler?: typeof _compiler
 }
 ```