Update babel-preset-stage (0,1,2,3) readme files (#10111) [skip ci]

* chore: update docs babel-preset-stage readme [ci skip] * fix: by PR request change [ci skip]
babel · Jul 4, 2019 · b066633 · b066633
1 parent d50e78d
commit b066633
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 5 deletions.
diff --git a/packages/babel-preset-stage-0/README.md b/packages/babel-preset-stage-0/README.md
@@ -32,7 +32,7 @@ If you want the same configuration as before:
     // Stage 3
     "@babel/plugin-syntax-dynamic-import",
     "@babel/plugin-syntax-import-meta",
-    ["@babel/plugin-proposal-class-properties", { "loose": false }],
+    ["@babel/plugin-proposal-class-properties", { "loose": true }],
     "@babel/plugin-proposal-json-strings"
   ]
 }
@@ -48,11 +48,18 @@ module.exports = function() {
     plugins: [
       require("@babel/plugin-syntax-dynamic-import"),
       [require("@babel/plugin-proposal-decorators"), { "legacy": true }],
-      [require("@babel/plugin-proposal-class-properties"), { "loose": false }],
+      [require("@babel/plugin-proposal-class-properties"), { "loose": true }],
     ],
     presets: [
       // ...
     ],
   };
 };
 ```
+
+**NOTE: Compatibility between `@babel/plugin-proposal-class-properties` and `@babel/plugin-proposal-decorators`**
+If you are including your plugins manually and using `@babel/plugin-proposal-class-properties`, make sure that `@babel/plugin-proposal-decorators` comes before `@babel/plugin-proposal-class-properties`.
+
+When using the `legacy: true` option of `@babel/plugin-proposal-decorators`, `@babel/plugin-proposal-class-properties` must be used in `loose: true` mode.
+
+If you are not using `@babel/plugin-proposal-decorators`, `loose` mode is not needed.
diff --git a/packages/babel-preset-stage-1/README.md b/packages/babel-preset-stage-1/README.md
@@ -29,7 +29,7 @@ If you want the same configuration as before:
     // Stage 3
     "@babel/plugin-syntax-dynamic-import",
     "@babel/plugin-syntax-import-meta",
-    ["@babel/plugin-proposal-class-properties", { "loose": false }],
+    ["@babel/plugin-proposal-class-properties", { "loose": true }],
     "@babel/plugin-proposal-json-strings"
   ]
 }
@@ -53,3 +53,10 @@ module.exports = function() {
   };
 };
 ```
+
+**NOTE: Compatibility between `@babel/plugin-proposal-class-properties` and `@babel/plugin-proposal-decorators`**
+If you are including your plugins manually and using `@babel/plugin-proposal-class-properties`, make sure that `@babel/plugin-proposal-decorators` comes before `@babel/plugin-proposal-class-properties`.
+
+When using the `legacy: true` option of `@babel/plugin-proposal-decorators`, `@babel/plugin-proposal-class-properties` must be used in `loose: true` mode.
+
+If you are not using `@babel/plugin-proposal-decorators`, `loose` mode is not needed.
diff --git a/packages/babel-preset-stage-2/README.md b/packages/babel-preset-stage-2/README.md
@@ -21,7 +21,7 @@ If you want the same configuration as before:
     // Stage 3
     "@babel/plugin-syntax-dynamic-import",
     "@babel/plugin-syntax-import-meta",
-    ["@babel/plugin-proposal-class-properties", { "loose": false }],
+    ["@babel/plugin-proposal-class-properties", { "loose": true }],
     "@babel/plugin-proposal-json-strings"
   ]
 }
@@ -45,3 +45,10 @@ module.exports = function() {
   };
 };
 ```
+
+**NOTE: Compatibility between `@babel/plugin-proposal-class-properties` and `@babel/plugin-proposal-decorators`**
+If you are including your plugins manually and using `@babel/plugin-proposal-class-properties`, make sure that `@babel/plugin-proposal-decorators` comes before `@babel/plugin-proposal-class-properties`.
+
+When using the `legacy: true` option of `@babel/plugin-proposal-decorators`, `@babel/plugin-proposal-class-properties` must be used in `loose: true` mode.
+
+If you are not using `@babel/plugin-proposal-decorators`, `loose` mode is not needed.
diff --git a/packages/babel-preset-stage-3/README.md b/packages/babel-preset-stage-3/README.md
@@ -29,11 +29,18 @@ module.exports = function() {
     plugins: [
       require("@babel/plugin-syntax-dynamic-import"),
       [require("@babel/plugin-proposal-decorators"), { "legacy": true }],
-      [require("@babel/plugin-proposal-class-properties"), { "loose": false }],
+      [require("@babel/plugin-proposal-class-properties"), { "loose": true }],
     ],
     presets: [
       // ...
     ],
   };
 };
 ```
+
+**NOTE: Compatibility between `@babel/plugin-proposal-class-properties` and `@babel/plugin-proposal-decorators`**
+If you are including your plugins manually and using `@babel/plugin-proposal-class-properties`, make sure that `@babel/plugin-proposal-decorators` comes before `@babel/plugin-proposal-class-properties`.
+
+When using the `legacy: true` option of `@babel/plugin-proposal-decorators`, `@babel/plugin-proposal-class-properties` must be used in `loose: true` mode.
+
+If you are not using `@babel/plugin-proposal-decorators`, `loose` mode is not needed.