message about automatic migrations

Author: zth

compiler/bsb/bsb_package_specs.ml

@@ -50,7 +50,7 @@ let supported_format (x : string) loc : Ext_module_system.t =
         {loc with Lexing.pos_cnum = loc.Lexing.pos_cnum + String.length x}
       in
       let loc = {Warnings.loc_start = loc; loc_end; loc_ghost = false} in
-      Location.deprecated loc
+      Location.deprecated ~can_be_automigrated:false loc
         (Printf.sprintf "Option \"%s\" is deprecated. Use \"%s\" instead." x
            Literals.esmodule)
   in

compiler/ext/warnings.ml

@@ -31,7 +31,7 @@ type top_level_unit_help = FunctionCall | Other
 type t =
   | Comment_start (*  1 *)
   | Comment_not_end (*  2 *)
-  | Deprecated of string * loc * loc (*  3 *)
+  | Deprecated of string * loc * loc * bool (*  3 *)
   | Fragile_match of string (*  4 *)
   | Partial_application (*  5 *)
   | Method_override of string list (*  7 *)
@@ -299,14 +299,21 @@ let () = reset ()
 let message = function
   | Comment_start -> "this is the start of a comment."
   | Comment_not_end -> "this is not the end of a comment."
-  | Deprecated (s, _, _) ->
+  | Deprecated (s, _, _, can_be_automigrated) ->
     (* Reduce \r\n to \n:
          - Prevents any \r characters being printed on Unix when processing
            Windows sources
          - Prevents \r\r\n being generated on Windows, which affects the
            testsuite
     *)
     "deprecated: " ^ Misc.normalise_eol s
+    ^
+    if can_be_automigrated then
+      "\n\n\
+      \  This can be automatically migrated by the ReScript migration tool. \
+       Run `rescript-tools migrate-all` to run all automatic migrations \
+       available in your project."
+    else ""
   | Fragile_match "" -> "this pattern-matching is fragile."
   | Fragile_match s ->
     "this pattern-matching is fragile.\n\
@@ -533,7 +540,7 @@ let message = function
        you implement this before running the code."
 
 let sub_locs = function
-  | Deprecated (_, def, use) ->
+  | Deprecated (_, def, use, _) ->
     [(def, "Definition"); (use, "Expected signature")]
   | _ -> []
 

compiler/ext/warnings.mli

@@ -24,7 +24,7 @@ type top_level_unit_help = FunctionCall | Other
 type t =
   | Comment_start (*  1 *)
   | Comment_not_end (*  2 *)
-  | Deprecated of string * loc * loc (*  3 *)
+  | Deprecated of string * loc * loc * bool (*  3 *)
   | Fragile_match of string (*  4 *)
   | Partial_application (*  5 *)
   | Method_override of string list (*  7 *)

compiler/ml/builtin_attributes.ml

@@ -132,7 +132,11 @@ let check_deprecated ?deprecated_context loc attrs s =
     !Cmt_utils.record_deprecated_used
       ?deprecated_context ?migration_template ?migration_in_pipe_chain_template
       loc txt;
-    Location.deprecated loc (cat s txt)
+    Location.deprecated
+      ~can_be_automigrated:
+        (Option.is_some migration_template
+        || Option.is_some migration_in_pipe_chain_template)
+      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/location.ml

@@ -298,7 +298,8 @@ let raise_errorf ?(loc = none) ?(sub = []) ?(if_highlight = "") =
   pp_ksprintf ~before:print_phanton_error_prefix (fun msg ->
       raise (Error {loc; msg; sub; if_highlight}))
 
-let deprecated ?(def = none) ?(use = none) loc msg =
-  prerr_warning loc (Warnings.Deprecated (msg, def, use))
+let deprecated ?(can_be_automigrated = false) ?(def = none) ?(use = none) loc
+    msg =
+  prerr_warning loc (Warnings.Deprecated (msg, def, use, can_be_automigrated))
 
 let map_loc f {txt; loc} = {txt = f txt; loc}

compiler/ml/location.mli

@@ -130,6 +130,7 @@ val default_error_reporter :
 val report_exception : formatter -> exn -> unit
 (** Reraise the exception if it is unknown. *)
 
-val deprecated : ?def:t -> ?use:t -> t -> string -> unit
+val deprecated :
+  ?can_be_automigrated:bool -> ?def:t -> ?use:t -> t -> string -> unit
 
 val map_loc : ('a -> 'b) -> 'a loc -> 'b loc

tests/build_tests/super_errors/expected/deprecated_with_automigration.res.expected

@@ -0,0 +1,11 @@
+
+  Warning number 3
+  /.../fixtures/deprecated_with_automigration.res:1:9-21
+
+  1 │ let _ = Js.Array2.map([1, 2], v => v + 1)
+  2 │ 
+
+  deprecated: Js.Array2.map
+  Use `Array.map` instead.
+
+  This can be automatically migrated by the ReScript migration tool. Run `rescript-tools migrate-all` to run all automatic migrations available in your project.

tests/build_tests/super_errors/fixtures/deprecated_with_automigration.res

@@ -0,0 +1 @@
+let _ = Js.Array2.map([1, 2], v => v + 1)