Merge pull request ocaml#13837 from Octachron/aligned_spellchecking_hints

error messages: align spellchecking hints

Author: Octachron

Changes

@@ -336,6 +336,11 @@ Working version
   occurences of `'a`
   (Samuel Vivien, review by Florian Angeletti)
 
+- #13817: align spellchecking hints with the possibly misspelled identifier/
+              Error: Unbound type constructor "aray"
+              Hint:              Did you mean "array"?
+  (Florian Angeletti, suggestion by Daniel Bünzli, review by Gabriel Scherer)
+
 ### Internal/compiler-libs changes:
 
 - #13314: Comment the code of Translclass

testsuite/tests/messages/highlight_tabs.ml

@@ -9,5 +9,5 @@ Line 1, characters 10-13:
 1 | 		let x = abc
     		        ^^^
 Error: Unbound value "abc"
-Hint: Did you mean "abs"?
+Hint:   Did you mean "abs"?
 |}];;

testsuite/tests/messages/spellcheck.ml

@@ -9,7 +9,7 @@
 
 #directery "foo/";;
 [%%expect {|
-Unknown directive "directery".
+ Unknown directive "directery".
 Hint: Did you mean "directory"?
 |}];;
 
@@ -22,7 +22,7 @@ Line 1, characters 8-19:
 1 | let _ = Fun.pratect
             ^^^^^^^^^^^
 Error: Unbound value "Fun.pratect"
-Hint: Did you mean "Fun.protect"?
+Hint:   Did you mean "Fun.protect"?
 |}];;
 
 type 'a t = 'a aray
@@ -31,7 +31,7 @@ Line 1, characters 15-19:
 1 | type 'a t = 'a aray
                    ^^^^
 Error: Unbound type constructor "aray"
-Hint: Did you mean "array"?
+Hint:              Did you mean "array"?
 |}];;
 
 module _ = Stdlib.Aray
@@ -40,7 +40,7 @@ Line 1, characters 11-22:
 1 | module _ = Stdlib.Aray
                ^^^^^^^^^^^
 Error: Unbound module "Stdlib.Aray"
-Hint: Did you mean "Stdlib.Array"?
+Hint:    Did you mean "Stdlib.Array"?
 |}];;
 
 let x = Same 42
@@ -49,7 +49,7 @@ Line 1, characters 8-12:
 1 | let x = Same 42
             ^^^^
 Error: Unbound constructor "Same"
-Hint: Did you mean "Some"?
+Hint:         Did you mean "Some"?
 |}];;
 
 let x : int option = Same 42
@@ -59,7 +59,7 @@ Line 1, characters 21-25:
                          ^^^^
 Error: This variant expression is expected to have type "int option"
        There is no constructor "Same" within type "option"
-Hint: Did you mean "Some"?
+Hint:             Did you mean "Some"?
 |}];;
 
 let x = { content = 42 }
@@ -68,7 +68,7 @@ Line 1, characters 10-17:
 1 | let x = { content = 42 }
               ^^^^^^^
 Error: Unbound record field "content"
-Hint: Did you mean "contents"?
+Hint:          Did you mean "contents"?
 |}];;
 
 let x : int ref = { content = 42 }
@@ -78,7 +78,7 @@ Line 1, characters 20-27:
                         ^^^^^^^
 Error: This record expression is expected to have type "int ref"
        There is no field "content" within type "ref"
-Hint: Did you mean "contents"?
+Hint:       Did you mean "contents"?
 |}];;
 
 class foobar = object end
@@ -89,7 +89,7 @@ Line 2, characters 23-29:
 2 | let _ = object inherit foobaz end
                            ^^^^^^
 Error: Unbound class "foobaz"
-Hint: Did you mean "foobar"?
+Hint:   Did you mean "foobar"?
 |}];;
 
 module type Foobar = sig end
@@ -100,7 +100,7 @@ Line 2, characters 13-19:
 2 | module Foo : Foobaz = struct end
                  ^^^^^^
 Error: Unbound module type "Foobaz"
-Hint: Did you mean "Foobar"?
+Hint:         Did you mean "Foobar"?
 |}];;
 
 class type foobar = object end
@@ -111,7 +111,7 @@ Line 2, characters 9-15:
 2 | let _ : #foobaz = object end
              ^^^^^^
 Error: Unbound class type "foobaz"
-Hint: Did you mean "foobar"?
+Hint:        Did you mean "foobar"?
 |}];;
 
 let _ =
@@ -124,7 +124,7 @@ let _ =
 Line 5, characters 22-33:
 5 |     method update n = foobaz <- n
                           ^^^^^^^^^^^
-Error: The value "foobaz" is not an instance variable
+Error:   The value "foobaz" is not an instance variable
 Hint: Did you mean "foobar"?
 |}];;
 
@@ -136,7 +136,7 @@ let _ = function (foobar | foobaz) -> ()
 Line 1, characters 17-34:
 1 | let _ = function (foobar | foobaz) -> ()
                      ^^^^^^^^^^^^^^^^^
-Error: Variable "foobar" must occur on both sides of this "|" pattern
+Error:    Variable "foobar" must occur on both sides of this "|" pattern
 Hint: Did you mean "foobaz"?
 |}];;
 
@@ -148,23 +148,23 @@ Line 2, characters 13-19:
 2 | let _ = fun {foobaz} -> ()
                  ^^^^^^
 Error: Unbound record field "foobaz"
-Hint: Did you mean "foobar"?
+Hint:          Did you mean "foobar"?
 |}];;
 let _ = { foobaz = 42 }
 [%%expect {|
 Line 1, characters 10-16:
 1 | let _ = { foobaz = 42 }
               ^^^^^^
 Error: Unbound record field "foobaz"
-Hint: Did you mean "foobar"?
+Hint:          Did you mean "foobar"?
 |}];;
 let _ = fun x -> x.foobaz
 [%%expect {|
 Line 1, characters 19-25:
 1 | let _ = fun x -> x.foobaz
                        ^^^^^^
 Error: Unbound record field "foobaz"
-Hint: Did you mean "foobar"?
+Hint:          Did you mean "foobar"?
 |}];;
 
 type bar = Foobar of int
@@ -175,7 +175,7 @@ Line 2, characters 8-14:
 2 | let _ = Foobaz 42
             ^^^^^^
 Error: Unbound constructor "Foobaz"
-Hint: Did you mean "Foobar"?
+Hint:         Did you mean "Foobar"?
 |}];;
 
 type baz = K of { foobar : int }
@@ -185,7 +185,7 @@ type baz = K of { foobar : int; }
 Line 2, characters 12-18:
 2 | let _ = K { foobaz = 42 }
                 ^^^^^^
-Error: The field "foobaz" is not part of the record argument for the "baz.K" constructor
+Error:   The field "foobaz" is not part of the record argument for the "baz.K" constructor
 Hint: Did you mean "foobar"?
 |}];;
 
@@ -198,7 +198,7 @@ Line 3, characters 17-21:
 3 |   method other = self#foobaz
                      ^^^^
 Error: This expression has no method "foobaz"
-Hint: Did you mean "foobar"?
+Hint:                   Did you mean "foobar"?
 |}];;
 
 
@@ -211,7 +211,7 @@ Line 3, characters 18-35:
 3 |   method myself = {< foobaz = 42 >}
                       ^^^^^^^^^^^^^^^^^
 Error: Unbound instance variable "foobaz"
-Hint: Did you mean "foobar"?
+Hint:               Did you mean "foobar"?
 |}];;
 
 let closely = ()
@@ -226,5 +226,5 @@ Line 5, characters 9-17:
 5 | let () = M.closer
              ^^^^^^^^
 Error: Unbound value "M.closer"
-Hint: Did you mean "M.close"?
+Hint:   Did you mean "M.close"?
 |}]

testsuite/tests/typing-core-bugs/missing_rec_hint.ml

@@ -49,7 +49,7 @@ Line 2, characters 13-19:
 2 | let value2 = value2 (* typo: should be value1 *) + 1 in
                  ^^^^^^
 Error: Unbound value "value2"
-Hint: Did you mean "value1"?
+Hint:   Did you mean "value1"?
 |}];;
 
 let foobar1 () = () in
@@ -61,7 +61,7 @@ Line 2, characters 17-24:
 2 | let foobar2 () = foobar2 () (* typo? or missing "rec"? *) in
                      ^^^^^^^
 Error: Unbound value "foobar2"
-Hint: Did you mean "foobar1"?
+Hint:   Did you mean "foobar1"?
 Hint: If this is a recursive definition,
 you should add the "rec" keyword on line 2
 |}];;

testsuite/tests/typing-core-bugs/repeated_did_you_mean.ml

@@ -18,5 +18,5 @@ Line 7, characters 8-11:
 7 | let _ = fox;;
             ^^^
 Error: Unbound value "fox"
-Hint: Did you mean "foo"?
+Hint:   Did you mean "foo"?
 |}]

testsuite/tests/typing-extensions/disambiguation.ml

@@ -30,7 +30,7 @@ Line 1, characters 11-15:
                ^^^^
 Error: This variant expression is expected to have type "t"
        There is no constructor "Alph" within type "t"
-Hint: Did you mean "Aleph" or "Alpha"?
+Hint:             Did you mean "Aleph" or "Alpha"?
 |}]
 
 open M;;
@@ -41,7 +41,7 @@ Line 2, characters 12-16:
                 ^^^^
 Error: This variant expression is expected to have type "M.w"
        There is no constructor "Alha" within type "M.w"
-Hint: Did you mean "Alpha"?
+Hint:             Did you mean "Alpha"?
 |}]
 
 let z: t = Bet;;
@@ -51,7 +51,7 @@ Line 1, characters 11-14:
                ^^^
 Error: This variant expression is expected to have type "t"
        There is no constructor "Bet" within type "t"
-Hint: Did you mean "Beth"?
+Hint:             Did you mean "Beth"?
 |}]
 
 
@@ -65,7 +65,7 @@ Line 3, characters 9-13:
              ^^^^
 Error: This variant expression is expected to have type "t"
        There is no constructor "Gamm" within type "t"
-Hint: Did you mean "Gamma"?
+Hint:             Did you mean "Gamma"?
 |}];;
 
 raise Not_Found;;
@@ -75,7 +75,7 @@ Line 1, characters 6-15:
           ^^^^^^^^^
 Error: This variant expression is expected to have type "exn"
        There is no constructor "Not_Found" within type "exn"
-Hint: Did you mean "Not_found"?
+Hint:             Did you mean "Not_found"?
 |}]
 
 (** Aliasing *)
@@ -156,7 +156,7 @@ Line 7, characters 13-17:
                  ^^^^
 Error: This variant expression is expected to have type "P.p"
        There is no constructor "Alha" within type "x"
-Hint: Did you mean "Alpha"?
+Hint:             Did you mean "Alpha"?
 |}]
 
 module M = struct type t = .. type t += T end
@@ -197,7 +197,7 @@ Line 3, characters 8-12:
             ^^^^
 Error: This variant expression is expected to have type "exn"
        There is no constructor "Locl" within type "exn"
-Hint: Did you mean "Local"?
+Hint:             Did you mean "Local"?
 |}]
 
 let x =

testsuite/tests/typing-labeled-tuples/labeled_tuples.ml

@@ -296,7 +296,7 @@ Line 1, characters 22-30:
 1 | type bad_t = {x : lbl:bad_type * int}
                           ^^^^^^^^
 Error: Unbound type constructor "bad_type"
-Hint: Did you mean "bad_t"?
+Hint:              Did you mean "bad_t"?
 |}]
 
 type tx = { x : foo:int * bar:int }

testsuite/tests/typing-misc/polyvars.ml

@@ -124,7 +124,7 @@ let f (x : [`A | `B] as 'a) (y : [> 'a]) = ();;
 Line 1, characters 61-63:
 1 | let f : ([`A | `B ] as 'a) -> [> 'a] -> unit = fun x (y : [> 'a]) -> ();;
                                                                  ^^
-Error: The type "'a" does not expand to a polymorphic variant type
+Error:    The type "'a" does not expand to a polymorphic variant type
 Hint: Did you mean "`a"?
 |}]
 

testsuite/tests/typing-misc/printing.ml

@@ -9,7 +9,7 @@ type t = [ 'A_name | `Hi ];;
 Line 1, characters 11-18:
 1 | type t = [ 'A_name | `Hi ];;
                ^^^^^^^
-Error: The type "'A_name" does not expand to a polymorphic variant type
+Error:    The type "'A_name" does not expand to a polymorphic variant type
 Hint: Did you mean "`A_name"?
 |}];;
 

testsuite/tests/typing-misc/records.ml

@@ -298,5 +298,5 @@ Line 6, characters 13-20:
 6 |            ; Coq__10.f2 = 0
                  ^^^^^^^
 Error: Unbound module "Coq__10"
-Hint: Did you mean "Coq__11"?
+Hint:    Did you mean "Coq__11"?
 |}]

testsuite/tests/typing-misc/typetexp_errors.ml

@@ -8,7 +8,7 @@ Line 1, characters 32-35:
 1 | type ('a,'at,'any,'en) t = A of 'an
                                     ^^^
 Error: The type variable "'an" is unbound in this type declaration.
-Hint: Did you mean "'a", "'any", "'at" or "'en"?
+Hint:       Did you mean "'a", "'any", "'at" or "'en"?
 |}
 ]
 

testsuite/tests/typing-modules/pr6633.ml

@@ -26,7 +26,7 @@ Line 2, characters 26-32:
 2 | module Foo = functor (E : EqualF) -> struct end;;
                               ^^^^^^
 Error: Unbound module type "EqualF"
-Hint: Did you mean "Equals"?
+Hint:         Did you mean "Equals"?
 |}]
 
 (* If a module is used as a module type it should trigger the hint

testsuite/tests/typing-sigsubst/sig_local_aliases.ml

@@ -50,7 +50,7 @@ Line 2, characters 14-22:
 2 |   module M := Funct(M)
                   ^^^^^^^^
 Error: Unbound module "Funct"
-Hint: Did you mean "Fun"?
+Hint:    Did you mean "Fun"?
 |}]
 
 module type Reject2 = sig

testsuite/tests/typing-warnings/records.ml

@@ -523,7 +523,7 @@ Line 3, characters 19-22:
                        ^^^
 Error: This record expression is expected to have type "t"
        There is no field "yyz" within type "t"
-Hint: Did you mean "yyy"?
+Hint:       Did you mean "yyy"?
 |}]
 
 (* PR#6004 *)

toplevel/topcommon.ml

@@ -358,11 +358,14 @@ let inline_code = Format_doc.compat Style.inline_code
 let try_run_directive ppf dir_name pdir_arg =
   begin match get_directive dir_name with
   | None ->
-      fprintf ppf "Unknown directive %a." inline_code dir_name;
-      let directives = all_directive_names () in
-      Format_doc.compat Misc.did_you_mean ppf
-        (fun () -> Misc.spellcheck directives dir_name);
-      fprintf ppf "@.";
+      let print ppf () =
+        let directives = all_directive_names () in
+        Misc.aligned_hint ~prefix:"" ppf
+          "@{<ralign>Unknown directive @}%a."
+          Style.inline_code dir_name
+          (Misc.did_you_mean (Misc.spellcheck directives dir_name))
+      in
+      fprintf ppf "%a@." (Format_doc.compat print) ();
       false
   | Some d ->
       match d, pdir_arg with