cleanup

Author: zth

compiler/syntax/src/res_core.ml

@@ -150,6 +150,26 @@ module ErrorMessages = struct
   let multiple_inline_record_definitions_at_same_path =
     "Only one inline record definition is allowed per record field. This \
      defines more than one inline record."
+
+  let keyword_field_in_expr keyword_txt =
+    "Cannot use keyword `"
+    ^ keyword_txt
+    ^ "` as a record field name. Suggestion: rename it (e.g. `"
+    ^ keyword_txt ^ "_`)"
+
+  let keyword_field_in_pattern keyword_txt =
+    "Cannot use keyword `"
+    ^ keyword_txt
+    ^ "` here. Keywords are not allowed as record field names."
+
+  let keyword_field_in_type keyword_txt =
+    "Cannot use keyword `"
+    ^ keyword_txt
+    ^ "` as a record field name. Suggestion: rename it (e.g. `"
+    ^ keyword_txt
+    ^ "_`)\n  If you need the field to be \""
+    ^ keyword_txt ^ "\" at runtime, annotate the field: `@as(\""
+    ^ keyword_txt ^ "\") " ^ keyword_txt ^ "_ : ...`"
 end
 
 module InExternal = struct
@@ -398,8 +418,17 @@ let build_longident words =
   | [] -> assert false
   | hd :: tl -> List.fold_left (fun p s -> Longident.Ldot (p, s)) (Lident hd) tl
 
-(* Recovers a keyword used as field name if it's probable that it's a full 
-  field name (not punning etc), by checking if there's a colon after it. *)
+(* Emit a keyword-as-field diagnostic for the current token using a context-specific
+   message builder. *)
+let emit_keyword_field_error (p : Parser.t) ~mk_message =
+  let keyword_txt = Token.to_string p.token in
+  let keyword_start = p.Parser.start_pos in
+  let keyword_end = p.Parser.end_pos in
+  Parser.err ~start_pos:keyword_start ~end_pos:keyword_end p
+    (Diagnostics.message (mk_message keyword_txt))
+
+(* Recovers a keyword used as field name if it's probable that it's a full
+   field name (not punning etc), by checking if there's a colon after it. *)
 let recover_keyword_field_name_if_probably_field p ~mk_message :
     (string * Location.t) option =
   if
@@ -408,13 +437,9 @@ let recover_keyword_field_name_if_probably_field p ~mk_message :
            Parser.next st;
            st.Parser.token = Colon)
   then (
-    let keyword_txt = Token.to_string p.token in
-    let keyword_start = p.Parser.start_pos in
-    let keyword_end = p.Parser.end_pos in
-    Parser.err ~start_pos:keyword_start ~end_pos:keyword_end p
-      (Diagnostics.message (mk_message keyword_txt));
-    let loc = mk_loc keyword_start keyword_end in
-    let recovered_field_name = keyword_txt ^ "_" in
+    emit_keyword_field_error p ~mk_message;
+    let loc = mk_loc p.Parser.start_pos p.Parser.end_pos in
+    let recovered_field_name = Token.to_string p.token ^ "_" in
     Parser.next p;
     Some (recovered_field_name, loc))
   else None
@@ -1402,28 +1427,16 @@ and parse_record_pattern_row p =
     if Token.is_keyword p.token then (
       match
         recover_keyword_field_name_if_probably_field p
-          ~mk_message:(fun keyword_txt ->
-            "Cannot use keyword `" ^ keyword_txt
-            ^ "` here. Keywords are not allowed as record field names.")
+          ~mk_message:ErrorMessages.keyword_field_in_pattern
       with
       | Some (recovered_field_name, loc) ->
         Parser.expect Colon p;
         let optional = parse_optional_label p in
         let pat = parse_pattern p in
-        let field =
-          Location.mkloc (Longident.Lident recovered_field_name) loc
-        in
+        let field = Location.mkloc (Longident.Lident recovered_field_name) loc in
         Some (false, PatField {lid = field; x = pat; opt = optional})
       | None ->
-        let keyword_txt = Token.to_string p.token in
-        let keyword_start = p.Parser.start_pos in
-        let keyword_end = p.Parser.end_pos in
-        let message =
-          "Cannot use keyword `" ^ keyword_txt
-          ^ "` here. Keywords are not allowed as record field names."
-        in
-        Parser.err ~start_pos:keyword_start ~end_pos:keyword_end p
-          (Diagnostics.message message);
+        emit_keyword_field_error p ~mk_message:ErrorMessages.keyword_field_in_pattern;
         None)
     else None
 
@@ -2974,10 +2987,7 @@ and parse_braced_or_record_expr p =
   | token when Token.is_keyword token -> (
     match
       recover_keyword_field_name_if_probably_field p
-        ~mk_message:(fun keyword_txt ->
-          "Cannot use keyword `" ^ keyword_txt
-          ^ "` as a record field name. Suggestion: rename it (e.g. `"
-          ^ keyword_txt ^ "_`)")
+        ~mk_message:ErrorMessages.keyword_field_in_expr
     with
     | Some (recovered_field_name, loc) ->
       Parser.expect Colon p;
@@ -3314,30 +3324,16 @@ and parse_record_expr_row p :
     if Token.is_keyword p.token then (
       match
         recover_keyword_field_name_if_probably_field p
-          ~mk_message:(fun keyword_txt ->
-            "Cannot use keyword `" ^ keyword_txt
-            ^ "` as a record field name. Suggestion: rename it (e.g. `"
-            ^ keyword_txt ^ "_`)")
+          ~mk_message:ErrorMessages.keyword_field_in_expr
       with
       | Some (recovered_field_name, loc) ->
         Parser.expect Colon p;
         let optional = parse_optional_label p in
         let field_expr = parse_expr p in
-        let field =
-          Location.mkloc (Longident.Lident recovered_field_name) loc
-        in
+        let field = Location.mkloc (Longident.Lident recovered_field_name) loc in
         Some {lid = field; x = field_expr; opt = optional}
       | None ->
-        let keyword_txt = Token.to_string p.token in
-        let keyword_start = p.Parser.start_pos in
-        let keyword_end = p.Parser.end_pos in
-        let message =
-          "Cannot use keyword `" ^ keyword_txt
-          ^ "` as a record field name. Suggestion: rename it (e.g. `"
-          ^ keyword_txt ^ "_`)"
-        in
-        Parser.err ~start_pos:keyword_start ~end_pos:keyword_end p
-          (Diagnostics.message message);
+        emit_keyword_field_error p ~mk_message:ErrorMessages.keyword_field_in_expr;
         None)
     else None
 
@@ -4839,12 +4835,7 @@ and parse_field_declaration_region ?current_type_name_path ?inline_types_context
     if Token.is_keyword p.token then (
       match
         recover_keyword_field_name_if_probably_field p
-          ~mk_message:(fun keyword_txt ->
-            "Cannot use keyword `" ^ keyword_txt
-            ^ "` as a record field name. Suggestion: rename it (e.g. `"
-            ^ keyword_txt ^ "_`)\n" ^ "  If you need the field to be \""
-            ^ keyword_txt ^ "\" at runtime, annotate the field: `@as(\""
-            ^ keyword_txt ^ "\") " ^ keyword_txt ^ "_ : ...`")
+          ~mk_message:ErrorMessages.keyword_field_in_type
       with
       | Some (recovered_field_name, name_loc) ->
         let optional = parse_optional_label p in
@@ -4856,18 +4847,7 @@ and parse_field_declaration_region ?current_type_name_path ?inline_types_context
         let name = Location.mkloc recovered_field_name name_loc in
         Some (Ast_helper.Type.field ~attrs ~loc ~mut ~optional name typ)
       | None ->
-        let keyword_txt = Token.to_string p.token in
-        let keyword_start = p.Parser.start_pos in
-        let keyword_end = p.Parser.end_pos in
-        let message =
-          "Cannot use keyword `" ^ keyword_txt
-          ^ "` as a record field name. Suggestion: rename it (e.g. `"
-          ^ keyword_txt ^ "_`)\n" ^ "  If you need the field to be \""
-          ^ keyword_txt ^ "\" at runtime, annotate the field: `@as(\""
-          ^ keyword_txt ^ "\") " ^ keyword_txt ^ "_ : ...`"
-        in
-        Parser.err ~start_pos:keyword_start ~end_pos:keyword_end p
-          (Diagnostics.message message);
+        emit_keyword_field_error p ~mk_message:ErrorMessages.keyword_field_in_type;
         None)
     else (
       if attrs <> [] then

tests/syntax_tests/data/parsing/errors/structure/expected/recordFieldKeywordInExpr.res.txt

@@ -7,4 +7,4 @@
 
   Cannot use keyword `type` as a record field name. Suggestion: rename it (e.g. `type_`)
 
-let r = { type = 1 }
+let r = { type_ = 1 }

tests/syntax_tests/data/parsing/errors/structure/expected/recordFieldKeywordInExpr2.res.txt

@@ -0,0 +1,10 @@
+
+  Syntax error!
+  syntax_tests/data/parsing/errors/structure/recordFieldKeywordInExpr2.res:1:16-19
+
+  1 │ let r = {a: 1, type: 2}
+  2 │ 
+
+  Cannot use keyword `type` as a record field name. Suggestion: rename it (e.g. `type_`)
+
+let r = { a = 1; type_ = 2 }

tests/syntax_tests/data/parsing/errors/structure/expected/recordFieldKeywordInPattern2.res.txt

@@ -0,0 +1,10 @@
+
+  Syntax error!
+  syntax_tests/data/parsing/errors/structure/recordFieldKeywordInPattern2.res:1:12-15
+
+  1 │ let {a: _, type: x} = r
+  2 │ 
+
+  Cannot use keyword `type` here. Keywords are not allowed as record field names.
+
+let { a = _; type_ = x } = r

tests/syntax_tests/data/parsing/errors/structure/expected/recordFieldKeywordInType.res.txt

@@ -13,4 +13,4 @@
 
 type nonrec r = {
   id: string ;
-  type: int }
+  type_: int }

tests/syntax_tests/data/parsing/errors/structure/expected/recordFieldKeywordInType2.res.txt

@@ -0,0 +1,17 @@
+
+  Syntax error!
+  syntax_tests/data/parsing/errors/structure/recordFieldKeywordInType2.res:3:3-6
+
+  1 │ type r = {
+  2 │   id: string,
+  3 │   type: int,
+  4 │   x: bool,
+  5 │ }
+
+  Cannot use keyword `type` as a record field name. Suggestion: rename it (e.g. `type_`)
+  If you need the field to be "type" at runtime, annotate the field: `@as("type") type_ : ...`
+
+type nonrec r = {
+  id: string ;
+  type_: int ;
+  x: bool }

tests/syntax_tests/data/parsing/errors/structure/recordFieldKeywordInExpr2.res

@@ -0,0 +1 @@
+let r = {a: 1, type: 2}

tests/syntax_tests/data/parsing/errors/structure/recordFieldKeywordInPattern2.res

@@ -0,0 +1 @@
+let {a: _, type: x} = r

tests/syntax_tests/data/parsing/errors/structure/recordFieldKeywordInType2.res

@@ -0,0 +1,5 @@
+type r = {
+  id: string,
+  type: int,
+  x: bool,
+}