chore(plugin-vue): comments and readme

vitejs · Dec 12, 2021 · 69106f4 · 69106f4
1 parent 51138cc
commit 69106f4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 10 deletions.
diff --git a/packages/plugin-vue/README.md b/packages/plugin-vue/README.md
@@ -22,7 +22,7 @@ export interface Options {
   isProduction?: boolean
 
   /**
-   * Transform Vue SFCs into custom elements (requires Vue >= 3.2.0)
+   * 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
    *
@@ -31,10 +31,8 @@ export interface Options {
   customElement?: boolean | string | RegExp | (string | RegExp)[]
 
   /**
-   * Enable Vue ref transform (experimental).
-   * https://github.com/vuejs/vue-next/tree/master/packages/ref-transform
-   *
-   * **requires Vue \>= 3.2.5**
+   * Enable Vue reactivity transform (experimental, requires vue@^3.2.25).
+   * https://github.com/vuejs/vue-next/tree/master/packages/reactivity-transform
    *
    * - `true`: transform will be enabled for all vue,js(x),ts(x) files except
    *           those inside node_modules
@@ -44,7 +42,7 @@ export interface Options {
    *
    * @default false
    */
-  refTransform?: boolean | string | RegExp | (string | RegExp)[]
+  reactivityTransform?: boolean | string | RegExp | (string | RegExp)[]
 
   // options to pass on to vue/compiler-sfc
   script?: Partial<SFCScriptCompileOptions>

diff --git a/packages/plugin-vue/src/index.ts b/packages/plugin-vue/src/index.ts
@@ -33,7 +33,6 @@ export interface Options {
 
   /**
    * Transform Vue SFCs into custom elements.
-   * **requires Vue \>= 3.2.0 & Vite \>= 2.4.4**
    * - `true`: all `*.vue` imports are converted into custom elements
    * - `string | RegExp`: matched files are converted into custom elements
    *
@@ -44,9 +43,6 @@ export interface Options {
   /**
    * Enable Vue reactivity transform (experimental).
    * https://github.com/vuejs/vue-next/tree/master/packages/reactivity-transform
-   *
-   * **requires vue\@^3.2.25**
-   *
    * - `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