[Super errors] Add the last line of a file to the code frame

chenglou · chenglou · commit 01a596f209bb · 2021-03-19T03:47:14.000-07:00
This is technically a small bug from way back. The recent refactor #5013 allowed us to fix this.
diff --git a/jscomp/build_tests/super_errors/expected/collections.re.expected b/jscomp/build_tests/super_errors/expected/collections.re.expected
@@ -4,6 +4,7 @@
   
   1 [2m│[0m /* wrong type in a list */
   [1;31m2[0m [2m│[0m [1, 2, [1;31m"Hello"[0m] -> ignore;
+  3 [2m│[0m 
   
   This has type: [1;31mstring[0m
   Somewhere wanted: [1;33mint[0m
diff --git a/jscomp/build_tests/super_errors/expected/highlighting2.re.expected b/jscomp/build_tests/super_errors/expected/highlighting2.re.expected
@@ -6,6 +6,7 @@
   [1;31m2[0m [2m┆[0m let a: int = [1;31m"hel[0m
   [1;31m3[0m [2m┆[0m 
   [1;31m4[0m [2m┆[0m [1;31mlo"[0m;
+  5 [2m┆[0m 
   
   This has type: [1;31mstring[0m
   Somewhere wanted: [1;33mint[0m
diff --git a/jscomp/build_tests/super_errors/expected/highlighting3.re.expected b/jscomp/build_tests/super_errors/expected/highlighting3.re.expected
@@ -6,6 +6,7 @@
   [1;31m2[0m [2m│[0m let a: int = [1;31m"helllllll[0m
   [1;31m3[0m [2m│[0m 
   [1;31m4[0m [2m│[0m [1;31mloooooooooooooo"[0m;
+  5 [2m│[0m 
   
   This has type: [1;31mstring[0m
   Somewhere wanted: [1;33mint[0m
diff --git a/jscomp/build_tests/super_errors/expected/highlighting5.re.expected b/jscomp/build_tests/super_errors/expected/highlighting5.re.expected
@@ -5,6 +5,7 @@
   1 [2m│[0m /* overflows in the terminal */
   [1;31m2[0m [2m│[0m let a: int = [1;31m"hellllllllllllllllllllllllllllllllllllllllllllllllllllllll[0m
       [1;31mlllllllllllllllllllllllllll";[0m
+  3 [2m│[0m 
   
   This has type: [1;31mstring[0m
   Somewhere wanted: [1;33mint[0m
diff --git a/jscomp/build_tests/super_errors/expected/highlighting6.re.expected b/jscomp/build_tests/super_errors/expected/highlighting6.re.expected
@@ -4,6 +4,7 @@
   
   1 [2m│[0m let aaaaa = 10;
   [1;31m2[0m [2m│[0m let b = [1;31maaaab[0m;
+  3 [2m│[0m 
   
   The value aaaab can't be found
   
diff --git a/jscomp/build_tests/super_errors/expected/modules1.re.expected b/jscomp/build_tests/super_errors/expected/modules1.re.expected
@@ -3,6 +3,7 @@
   [36m/.../fixtures/modules1.re[0m:[2m1:9-13[0m
   
   [1;31m1[0m [2m│[0m let b = [1;31mFoo.b[0m;
+  2 [2m│[0m 
   
   [1;33mThe module or file Foo can't be found.[0m
   - If it's a third-party dependency:
diff --git a/jscomp/build_tests/super_errors/expected/modules3.re.expected b/jscomp/build_tests/super_errors/expected/modules3.re.expected
@@ -6,6 +6,7 @@
   10 [2m│[0m 
   [1;31m11[0m [2m│[0m let asd = [1;31mA.B.C.D.aaa[0m;
   12 [2m│[0m 
+  13 [2m│[0m 
   
   The value aaa can't be found in A.B.C.D
   
diff --git a/jscomp/build_tests/super_errors/expected/moreArguments1.re.expected b/jscomp/build_tests/super_errors/expected/moreArguments1.re.expected
@@ -4,5 +4,6 @@
   
   1 [2m│[0m let x = (~a, ~b) => a + b;
   [1;31m2[0m [2m│[0m let y = [1;31mx(~a=2)[0m + 2;
+  3 [2m│[0m 
   
   [1;33mThis call is missing an argument[0m of type (~b: int)
diff --git a/jscomp/build_tests/super_errors/expected/moreArguments2.re.expected b/jscomp/build_tests/super_errors/expected/moreArguments2.re.expected
@@ -4,5 +4,6 @@
   
   1 [2m│[0m let x = (a, b) => a + b;
   [1;31m2[0m [2m│[0m let y = [1;31mx(2)[0m + 2;
+  3 [2m│[0m 
   
   [1;33mThis call is missing an argument[0m of type int
diff --git a/jscomp/build_tests/super_errors/expected/moreArguments3.re.expected b/jscomp/build_tests/super_errors/expected/moreArguments3.re.expected
@@ -4,5 +4,6 @@
   
   1 [2m│[0m let x = (a, b, c, d) => a + b;
   [1;31m2[0m [2m│[0m let y = [1;31mx(2)[0m + 2;
+  3 [2m│[0m 
   
   [1;33mThis call is missing arguments[0m of type: int, 'a, 'b
diff --git a/jscomp/build_tests/super_errors/expected/moreArguments4.re.expected b/jscomp/build_tests/super_errors/expected/moreArguments4.re.expected
@@ -4,5 +4,6 @@
   
   1 [2m│[0m let x = (a, ~b, ~c, ~d) => a + b;
   [1;31m2[0m [2m│[0m let y = [1;31mx(2)[0m + 2;
+  3 [2m│[0m 
   
   [1;33mThis call is missing arguments[0m of type: (~b: int), (~c: 'a), (~d: 'b)
diff --git a/jscomp/build_tests/super_errors/expected/primitives1.re.expected b/jscomp/build_tests/super_errors/expected/primitives1.re.expected
@@ -4,6 +4,7 @@
   
   1 [2m│[0m /* got float, wanted int */
   [1;31m2[0m [2m│[0m [1;31m2.[0m + 2;
+  3 [2m│[0m 
   
   This has type: [1;31mfloat[0m
   Somewhere wanted: [1;33mint[0m
diff --git a/jscomp/build_tests/super_errors/expected/primitives10.re.expected b/jscomp/build_tests/super_errors/expected/primitives10.re.expected
@@ -4,6 +4,7 @@
   
   1 [2m│[0m let aaaaa = 10;
   [1;31m2[0m [2m│[0m let b = [1;31maaaab[0m;
+  3 [2m│[0m 
   
   The value aaaab can't be found
   
diff --git a/jscomp/build_tests/super_errors/expected/primitives2.re.expected b/jscomp/build_tests/super_errors/expected/primitives2.re.expected
@@ -4,6 +4,7 @@
   
   1 [2m│[0m /* got int, wanted string */
   [1;31m2[0m [2m│[0m [1;31m2[0m ++ " things";
+  3 [2m│[0m 
   
   This has type: [1;31mint[0m
   Somewhere wanted: [1;33mstring[0m
diff --git a/jscomp/build_tests/super_errors/expected/primitives3.re.expected b/jscomp/build_tests/super_errors/expected/primitives3.re.expected
@@ -5,6 +5,7 @@
   1 [2m│[0m /* Too many arguments */
   2 [2m│[0m let x = (a) => a + 2;
   [1;31m3[0m [2m│[0m [1;31mx[0m(2, 4);
+  4 [2m│[0m 
   
   This function has type [1;33mint => int[0m
   It only accepts 1 argument; here, it's called with more.
diff --git a/jscomp/build_tests/super_errors/expected/primitives4.re.expected b/jscomp/build_tests/super_errors/expected/primitives4.re.expected
@@ -5,6 +5,7 @@
   1 [2m│[0m /* Not a function */
   2 [2m│[0m let x = 10;
   [1;31m3[0m [2m│[0m [1;31mx[0m(10);
+  4 [2m│[0m 
   
   This expression has type int
   It is not a function.
diff --git a/jscomp/build_tests/super_errors/expected/primitives5.re.expected b/jscomp/build_tests/super_errors/expected/primitives5.re.expected
@@ -5,5 +5,6 @@
   1 [2m│[0m /* Not enough arguments */
   2 [2m│[0m type x = X(int, float);
   [1;31m3[0m [2m│[0m [1;31mX(10)[0m -> ignore;
+  4 [2m│[0m 
   
   This variant constructor, X, expects 2 arguments; here, we've only found 1.
diff --git a/jscomp/build_tests/super_errors/expected/primitives6.re.expected b/jscomp/build_tests/super_errors/expected/primitives6.re.expected
@@ -5,6 +5,7 @@
   1 [2m│[0m /* Wrong constructor argument */
   2 [2m│[0m type x = X(int, float);
   [1;31m3[0m [2m│[0m X(10, [1;31m10[0m) -> ignore;
+  4 [2m│[0m 
   
   This has type: [1;31mint[0m
   Somewhere wanted: [1;33mfloat[0m
diff --git a/jscomp/build_tests/super_errors/expected/primitives7.re.expected b/jscomp/build_tests/super_errors/expected/primitives7.re.expected
@@ -5,6 +5,7 @@
   1 [2m│[0m /* Wanted list(float), found list(int) */
   2 [2m│[0m let a = [1,2,3];
   [1;31m3[0m [2m│[0m List.map(((n) => n +. 2.), [1;31ma[0m);
+  4 [2m│[0m 
   
   This has type: [1;31mlist(int)[0m
   Somewhere wanted: [1;33mlist(float)[0m
diff --git a/jscomp/build_tests/super_errors/expected/primitives8.re.expected b/jscomp/build_tests/super_errors/expected/primitives8.re.expected
@@ -3,5 +3,6 @@
   [36m/.../fixtures/primitives8.re[0m:[2m1:11-13[0m
   
   [1;31m1[0m [2m│[0m let asd = [1;31maaa[0m;
+  2 [2m│[0m 
   
   The value aaa can't be found
diff --git a/jscomp/build_tests/super_errors/expected/primitives9.re.expected b/jscomp/build_tests/super_errors/expected/primitives9.re.expected
@@ -3,6 +3,7 @@
   [36m/.../fixtures/primitives9.re[0m:[2m1:14-20[0m
   
   [1;31m1[0m [2m│[0m let a: int = [1;31m"hello"[0m
+  2 [2m│[0m 
   
   This has type: [1;31mstring[0m
   Somewhere wanted: [1;33mint[0m
diff --git a/jscomp/build_tests/super_errors/expected/type1.re.expected b/jscomp/build_tests/super_errors/expected/type1.re.expected
@@ -3,6 +3,7 @@
   [36m/.../fixtures/type1.re[0m:[2m1:9-10[0m
   
   [1;31m1[0m [2m│[0m let x = [1;31m2.[0m + 2;
+  2 [2m│[0m 
   
   This has type: [1;31mfloat[0m
   Somewhere wanted: [1;33mint[0m
diff --git a/jscomp/build_tests/super_errors/expected/warnings3.re.expected b/jscomp/build_tests/super_errors/expected/warnings3.re.expected
@@ -16,6 +16,7 @@ Please use Js.Float.toString instead, string_of_float generates unparseable floa
   1 [2m│[0m let _ = string_of_float(34.)
   [1;33m2[0m [2m│[0m let _ = [1;33mstring_of_float[0m(34.)
   3 [2m│[0m let _ = string_of_float(34.)
+  4 [2m│[0m 
   
   deprecated: Pervasives.string_of_float
 Please use Js.Float.toString instead, string_of_float generates unparseable floats
@@ -27,6 +28,7 @@ Please use Js.Float.toString instead, string_of_float generates unparseable floa
   1 [2m│[0m let _ = string_of_float(34.)
   2 [2m│[0m let _ = string_of_float(34.)
   [1;33m3[0m [2m│[0m let _ = [1;33mstring_of_float[0m(34.)
+  4 [2m│[0m 
   
   deprecated: Pervasives.string_of_float
 Please use Js.Float.toString instead, string_of_float generates unparseable floats
diff --git a/jscomp/super_errors/super_code_frame.ml b/jscomp/super_errors/super_code_frame.ml
@@ -162,16 +162,6 @@ let print ~is_warning ~src ~startPos ~endPos =
   let lines =
     (* TODO: off-by-one danger *)
     String.sub src start_line_line_offset (end_line_line_end_offset - start_line_line_offset)
-  in
-  (* TODO: remove this after the next PR *)
-  let len = String.length lines in
-  let lines =
-    if len > 1 && (String.get src (len - 1)) = '\n' then
-      String.sub lines 0 (len - 1)
-    else
-      lines
-  in
-  let lines = lines
     |> String.split_on_char '\n'
     |> filter_mapi (fun i line ->
       let line_number = i + first_shown_line in
diff --git a/lib/4.06.1/unstable/js_compiler.ml b/lib/4.06.1/unstable/js_compiler.ml
@@ -407577,16 +407577,6 @@ let print ~is_warning ~src ~startPos ~endPos =
   let lines =
     (* TODO: off-by-one danger *)
     String.sub src start_line_line_offset (end_line_line_end_offset - start_line_line_offset)
-  in
-  (* TODO: remove this after the next PR *)
-  let len = String.length lines in
-  let lines =
-    if len > 1 && (String.get src (len - 1)) = '\n' then
-      String.sub lines 0 (len - 1)
-    else
-      lines
-  in
-  let lines = lines
     |> String.split_on_char '\n'
     |> filter_mapi (fun i line ->
       let line_number = i + first_shown_line in
diff --git a/lib/4.06.1/whole_compiler.ml b/lib/4.06.1/whole_compiler.ml
@@ -433628,16 +433628,6 @@ let print ~is_warning ~src ~startPos ~endPos =
   let lines =
     (* TODO: off-by-one danger *)
     String.sub src start_line_line_offset (end_line_line_end_offset - start_line_line_offset)
-  in
-  (* TODO: remove this after the next PR *)
-  let len = String.length lines in
-  let lines =
-    if len > 1 && (String.get src (len - 1)) = '\n' then
-      String.sub lines 0 (len - 1)
-    else
-      lines
-  in
-  let lines = lines
     |> String.split_on_char '\n'
     |> filter_mapi (fun i line ->
       let line_number = i + first_shown_line in

-Original file line number
+Diff line change
 [2m│[0m /* wrong type in a list */
   [1;31m2[0m [2m│[0m [1, 2, [1;31m"Hello"[0m] -> ignore;
 +  3 [2m│[0m
   This has type: [1;31mstring[0m
   Somewhere wanted: [1;33mint[0m
-Original file line number
+Diff line change
   [36m/.../fixtures/modules1.re[0m:[2m1:9-13[0m
   [1;31m1[0m [2m│[0m let b = [1;31mFoo.b[0m;
 +  2 [2m│[0m
   [1;33mThe module or file Foo can't be found.[0m
   - If it's a third-party dependency: