make parsing of @deprecated with migration info an experimental feature

Author: zth

compiler/ml/builtin_attributes.ml

@@ -75,6 +75,12 @@ let cat s1 s2 =
 
 let rec deprecated_of_attrs = function
   | [] -> None
+  | ( {txt = "deprecated"; _},
+      PStr [{pstr_desc = Pstr_eval ({pexp_desc = Pexp_record _}, _)}] )
+    :: _ ->
+    (* Skip record payloads here. `deprecated_of_attrs_with_migrate` should be used if we want to 
+      parse record payloads. *)
+    None
   | ({txt = "ocaml.deprecated" | "deprecated"; _}, p) :: _ ->
     Some (string_of_opt_payload p)
   | _ :: tl -> deprecated_of_attrs tl
@@ -126,13 +132,18 @@ let rec deprecated_of_attrs_with_migrate = function
   | _ :: tl -> deprecated_of_attrs_with_migrate tl
 
 let check_deprecated ?deprecated_context loc attrs s =
-  match deprecated_of_attrs_with_migrate attrs with
-  | None -> ()
-  | Some (txt, migration_template, migration_in_pipe_chain_template) ->
-    !Cmt_utils.record_deprecated_used
-      ?deprecated_context ?migration_template ?migration_in_pipe_chain_template
-      loc txt;
-    Location.deprecated loc (cat s txt)
+  if Experimental_features.is_enabled DeprecatedMigrations then (
+    match deprecated_of_attrs_with_migrate attrs with
+    | None -> ()
+    | Some (txt, migration_template, migration_in_pipe_chain_template) ->
+      !Cmt_utils.record_deprecated_used
+        ?deprecated_context ?migration_template
+        ?migration_in_pipe_chain_template loc txt;
+      Location.deprecated loc (cat s txt))
+  else
+    match deprecated_of_attrs attrs with
+    | None -> ()
+    | Some txt -> Location.deprecated loc (cat s txt)
 
 let check_deprecated_inclusion ~def ~use loc attrs1 attrs2 s =
   match (deprecated_of_attrs attrs1, deprecated_of_attrs attrs2) with

compiler/ml/experimental_features.ml

@@ -1,12 +1,14 @@
-type feature = LetUnwrap
+type feature = LetUnwrap | DeprecatedMigrations
 
 let to_string (f : feature) : string =
   match f with
   | LetUnwrap -> "LetUnwrap"
+  | DeprecatedMigrations -> "DeprecatedMigrations"
 
 let from_string (s : string) : feature option =
   match s with
   | "LetUnwrap" -> Some LetUnwrap
+  | "DeprecatedMigrations" -> Some DeprecatedMigrations
   | _ -> None
 
 module FeatureSet = Set.Make (struct

compiler/ml/experimental_features.mli

@@ -1,4 +1,4 @@
-type feature = LetUnwrap
+type feature = LetUnwrap | DeprecatedMigrations
 
 val enable_from_string : string -> unit
 val is_enabled : feature -> bool

docs/docson/build-schema.json

@@ -492,6 +492,10 @@
         "LetUnwrap": {
           "type": "boolean",
           "description": "Enable `let?` syntax."
+        },
+        "DeprecatedMigrations": {
+          "type": "boolean",
+          "description": "Enable parsing of the `@deprecated` attribute with migration information."
         }
       },
       "additionalProperties": false

rewatch/CompilerConfigurationSpec.md

@@ -122,6 +122,7 @@ An object of feature flags to enable experimental compiler behavior. Only suppor
 Currently supported features:
 
 - LetUnwrap: Enable `let?` syntax.
+- DeprecatedMigrations: Enable parsing of the `@deprecated` attribute with migration information.
 
 ### Warnings
 

rewatch/src/config.rs

@@ -229,6 +229,7 @@ pub enum DeprecationWarning {
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 pub enum ExperimentalFeature {
     LetUnwrap,
+    DeprecatedMigrations,
 }
 
 impl<'de> serde::Deserialize<'de> for ExperimentalFeature {
@@ -248,8 +249,9 @@ impl<'de> serde::Deserialize<'de> for ExperimentalFeature {
             {
                 match v {
                     "LetUnwrap" => Ok(ExperimentalFeature::LetUnwrap),
+                    "DeprecatedMigrations" => Ok(ExperimentalFeature::DeprecatedMigrations),
                     other => {
-                        let available = ["LetUnwrap"].join(", ");
+                        let available = ["LetUnwrap", "DeprecatedMigrations"].join(", ");
                         Err(DeError::custom(format!(
                             "Unknown experimental feature '{}'. Available features: {}",
                             other, available
@@ -549,6 +551,7 @@ impl Config {
                         "-enable-experimental".to_string(),
                         match feature {
                             ExperimentalFeature::LetUnwrap => "LetUnwrap",
+                            ExperimentalFeature::DeprecatedMigrations => "DeprecatedMigrations",
                         }
                         .to_string(),
                     ]

rewatch/tests/snapshots/bs-dev-dependency-used-by-non-dev-source.txt

@@ -1,69 +1,6 @@
-Cleaned 0/113
-Parsed 4 source files
-Compiled 3 modules
-
-  Warning number 3
-  /packages/new-namespace/src/Other_module.res:1:17-22
-
-  1 │ let bla = () => Js.log("bla")
-  2 │ 
-
-  deprecated: Js.log
-  Use `Console.log` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:6:16-33
-
-  4 │ let at = get
-  5 │ 
-  6 │ let includes = Js.Array2.includes
-  7 │ 
-  8 │ let head = t => t->get(0)
-
-  deprecated: Js.Array2.includes
-  Use `Array.includes` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:24:12-25
-
-  22 │ let flatMap = (t, fn) => t->map(fn)->concatMany
-  23 │ 
-  24 │ let mapi = Js.Array2.mapi
-  25 │ 
-  26 │ let flatten = t => t->flatMap(x => x)
-
-  deprecated: Js.Array2.mapi
-  Use `Array.mapWithIndex` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:32:14-29
-
-  30 │ let findIndex = (t, fn) => Js.Array.findIndex(fn, t)
-  31 │ 
-  32 │ let filter = Js.Array2.filter
-  33 │ 
-  34 │ let reject = (t, fn) => t->filter(el => !fn(el))
-
-  deprecated: Js.Array2.filter
-  Use `Array.filter` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:48:18-35
-
-  46 │ 
-  47 │ module String = {
-  48 │   let joinWith = Js.Array2.joinWith
-  49 │   let join = joinWith(_, "")
-  50 │ }
-
-  deprecated: Js.Array2.joinWith
-  Use `Array.joinUnsafe` instead.
-
-
+Cleaned 0/115
+Parsed 2 source files
+Compiled 2 modules
 
 The field 'bs-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
 Use 'dependencies' instead.

rewatch/tests/snapshots/dependency-cycle.txt

@@ -1,69 +1,6 @@
-Cleaned 0/110
-Parsed 6 source files
-Compiled 2 modules
-
-  Warning number 3
-  /packages/new-namespace/src/Other_module.res:1:17-22
-
-  1 │ let bla = () => Js.log("bla")
-  2 │ 
-
-  deprecated: Js.log
-  Use `Console.log` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:6:16-33
-
-  4 │ let at = get
-  5 │ 
-  6 │ let includes = Js.Array2.includes
-  7 │ 
-  8 │ let head = t => t->get(0)
-
-  deprecated: Js.Array2.includes
-  Use `Array.includes` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:24:12-25
-
-  22 │ let flatMap = (t, fn) => t->map(fn)->concatMany
-  23 │ 
-  24 │ let mapi = Js.Array2.mapi
-  25 │ 
-  26 │ let flatten = t => t->flatMap(x => x)
-
-  deprecated: Js.Array2.mapi
-  Use `Array.mapWithIndex` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:32:14-29
-
-  30 │ let findIndex = (t, fn) => Js.Array.findIndex(fn, t)
-  31 │ 
-  32 │ let filter = Js.Array2.filter
-  33 │ 
-  34 │ let reject = (t, fn) => t->filter(el => !fn(el))
-
-  deprecated: Js.Array2.filter
-  Use `Array.filter` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:48:18-35
-
-  46 │ 
-  47 │ module String = {
-  48 │   let joinWith = Js.Array2.joinWith
-  49 │   let join = joinWith(_, "")
-  50 │ }
-
-  deprecated: Js.Array2.joinWith
-  Use `Array.joinUnsafe` instead.
-
-
+Cleaned 0/115
+Parsed 1 source files
+Compiled 0 modules
 
 The field 'bs-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
 Use 'dependencies' instead.

rewatch/tests/snapshots/remove-file.txt

@@ -1,111 +1,30 @@
-Cleaned 0/110
-Parsed 4 source files
-Compiled 5 modules
+Cleaned 1/115
+Parsed 0 source files
+Compiled 1 modules
 
-  Warning number 3
-  /packages/dep02/src/Array.res:6:16-33
-
-  4 │ let at = get
-  5 │ 
-  6 │ let includes = Js.Array2.includes
-  7 │ 
-  8 │ let head = t => t->get(0)
-
-  deprecated: Js.Array2.includes
-  Use `Array.includes` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:24:12-25
-
-  22 │ let flatMap = (t, fn) => t->map(fn)->concatMany
-  23 │ 
-  24 │ let mapi = Js.Array2.mapi
-  25 │ 
-  26 │ let flatten = t => t->flatMap(x => x)
-
-  deprecated: Js.Array2.mapi
-  Use `Array.mapWithIndex` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:32:14-29
-
-  30 │ let findIndex = (t, fn) => Js.Array.findIndex(fn, t)
-  31 │ 
-  32 │ let filter = Js.Array2.filter
-  33 │ 
-  34 │ let reject = (t, fn) => t->filter(el => !fn(el))
-
-  deprecated: Js.Array2.filter
-  Use `Array.filter` instead.
-
-
-  Warning number 3
-  /packages/dep02/src/Array.res:48:18-35
-
-  46 │ 
-  47 │ module String = {
-  48 │   let joinWith = Js.Array2.joinWith
-  49 │   let join = joinWith(_, "")
-  50 │ }
-
-  deprecated: Js.Array2.joinWith
-  Use `Array.joinUnsafe` instead.
-
-
-  Warning number 3
-  /packages/new-namespace/src/Other_module.res:1:17-22
-
-  1 │ let bla = () => Js.log("bla")
-  2 │ 
+The field 'bs-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
+Use 'dependencies' instead.
 
-  deprecated: Js.log
-  Use `Console.log` instead.
+The field 'bs-dev-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
+Use 'dev-dependencies' instead.
 
+The field 'bsc-flags' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
+Use 'compiler-flags' instead.
 
-  Warning number 3
-  /packages/dep01/src/Dep01.res:2:9-14
+  We've found a bug for you!
+  /packages/dep01/src/Dep01.res:3:9-17
 
   1 │ let log = () => {
-  2 │         Js.log("02")
-  3 │         Dep02.log()
+  2 │         Js.log("02")
+  3 │         Dep02.log()
   4 │ }
-
-  deprecated: Js.log
-  Use `Console.log` instead.
-
-
-  Warning number 3
-  /packages/main/src/Main.res:1:1-6
-
-  1 │ Js.log("01")
-  2 │ Dep01.log()
-  3 │ 
-
-  deprecated: Js.log
-  Use `Console.log` instead.
-
-
-  Warning number 3
-  /packages/main/src/Main.res:4:1-6
-
-  2 │ Dep01.log()
-  3 │ 
-  4 │ Js.log(InternalDep.value)
   5 │ 
-  6 │ module Array = Belt.Array
-
-  deprecated: Js.log
-  Use `Console.log` instead.
-
 
+  The module or file Dep02 can't be found.
+  - If it's a third-party dependency:
+    - Did you add it to the "dependencies" or "dev-dependencies" in rescript.json?
+  - Did you include the file's directory to the "sources" in rescript.json?
+  
 
-The field 'bs-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
-Use 'dependencies' instead.
-
-The field 'bs-dev-dependencies' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
-Use 'dev-dependencies' instead.
 
-The field 'bsc-flags' found in the package config of '@testrepo/deprecated-config' is deprecated and will be removed in a future version.
-Use 'compiler-flags' instead.
+Incremental build failed. Error:   Failed to Compile. See Errors Above