Merge pull request #3 from Julow/metadata-strip-sp

Strip whitespaces from the end of the metadata field

Author: jonludlam

src/lexer.mll

@@ -583,11 +583,17 @@ and bad_markup_recovery start_offset input = parse
         (Parse_error.bad_markup ("{" ^ rest) ~suggestion);
       emit input (`Code_span text) ~start_offset}
 
-(* The second field of the metadata *)
+(* The second field of the metadata.
+   This rule keeps whitespaces and newlines in the 'metadata' field except the
+   ones just before the '['. *)
 and code_block_metadata_tail input = parse
-  | ((newline | horizontal_space)+ as prefix) (([^ '['])+ as meta) '['
+ | (space_char+ as prefix)
+   ((space_char* (_ # space_char # ['['])+)+ as meta)
+   ((space_char* '[') as suffix)
     {
-      let meta = with_location_adjustments ~adjust_start_by:prefix ~adjust_end_by:"[" (fun _ -> Loc.at) input meta in
+      let meta =
+        with_location_adjustments ~adjust_start_by:prefix ~adjust_end_by:suffix (fun _ -> Loc.at) input meta
+      in
       `Ok (Some meta)
     }
   | (newline | horizontal_space)* '['

test/test.ml

@@ -2597,7 +2597,7 @@ let%expect_test _ =
           (((f.ml (1 0) (1 46))
             (code_block
              (((f.ml (1 2) (1 7)) ocaml)
-              (((f.ml (1 8) (1 29)) "env=f1 version>=4.06 ")))
+              (((f.ml (1 8) (1 28)) "env=f1 version>=4.06")))
              ((f.ml (1 30) (1 44)) "code goes here")))))
          (warnings ())) |}]
 
@@ -2654,10 +2654,32 @@ let%expect_test _ =
         ((output
           (((f.ml (1 0) (2 9))
             (code_block
-             (((f.ml (1 2) (1 7)) ocaml) (((f.ml (1 8) (2 0)) "kind=toplevel\n")))
+             (((f.ml (1 2) (1 7)) ocaml) (((f.ml (1 8) (1 21)) kind=toplevel)))
              ((f.ml (2 1) (2 7)) "code ")))))
          (warnings ())) |}]
 
+    let spaces_after_meta =
+      test "{@ocaml kind=toplevel [ code ]}";
+      [%expect
+        {|
+        ((output
+          (((f.ml (1 0) (1 31))
+            (code_block
+             (((f.ml (1 2) (1 7)) ocaml) (((f.ml (1 8) (1 21)) kind=toplevel)))
+             ((f.ml (1 23) (1 29)) "code ")))))
+         (warnings ())) |}]
+
+    let spaces_and_newline_after_meta =
+      test "{@ocaml kind=toplevel \n  [ code ]}";
+      [%expect
+        {|
+        ((output
+          (((f.ml (1 0) (2 11))
+            (code_block
+             (((f.ml (1 2) (1 7)) ocaml) (((f.ml (1 8) (1 21)) kind=toplevel)))
+             ((f.ml (2 3) (2 9)) "code ")))))
+         (warnings ())) |}]
+
     let newlines_inside_meta =
       test "{@ocaml kind=toplevel\nenv=e1[ code ]}";
       [%expect