Merge pull request #62 from gasche/minor-changes

Minor changes

Author: gasche

README.md

@@ -9,11 +9,16 @@ Example usage
 
 ```ocaml
 let tmpl =
-  Mustache.of_string "Hello {{name}}\n\
-                      Mustache is:\n\
-                      {{#qualities}}\
-                      * {{name}}\n\
-                      {{/qualities}}"
+  try
+    Mustache.of_string "Hello {{name}}\n\
+                        Mustache is:\n\
+                        {{#qualities}}\
+                        * {{name}}\n\
+                        {{/qualities}}"
+  with Mustache.Parse_error err ->
+    Format.eprintf "%a@."
+      Mustache.pp_template_parse_error err;
+    exit 3
 
 let json =
   `O [ "name", `String "OCaml"
@@ -24,7 +29,11 @@ let json =
      ]
 
 let rendered =
-  Mustache.render tmpl json
+  try Mustache.render tmpl json
+  with Mustache.Render_error err ->
+    Format.eprintf "%a@."
+      Mustache.pp_render_error err;
+    exit 2
 ```
 
 Spec compliance

bin/mustache_cli.ml

@@ -28,8 +28,8 @@ let load_template template_filename =
     lexbuf.lex_curr_p <- { lexbuf.lex_curr_p with pos_fname = template_filename };
   in
   try Mustache.parse_lx lexbuf
-  with Mustache.Template_parse_error err ->
-    Format.eprintf "Template parse error:@\n%a@."
+  with Mustache.Parse_error err ->
+    Format.eprintf "%a@."
       Mustache.pp_template_parse_error err;
     exit 3
 
@@ -49,48 +49,47 @@ let run search_path json_filename template_filename =
     print_string output;
     flush stdout
   with Mustache.Render_error err ->
-    Format.eprintf "Template render error:@\n%a@."
+    Format.eprintf "%a@."
       Mustache.pp_render_error err;
     exit 2
 
-let run_command =
-  let open Cmdliner in
-  let doc = "renders Mustache template from JSON data files" in
-  let man = [
-    `S Manpage.s_description;
-    `P "$(tname) is a command-line tool coming with the $(i,ocaml-mustache) library,
-        an OCaml implementation of the Mustache template format.
-        $(tname) takes a data file and a template file as command-line parameters;
-        it renders the populated template on standard output.";
-
-    `P "Mustache is a simple and popular template format,
-        with library implementations in many programming languages.
-        It is named from its {{..}} delimiters.";
-
-    `I ("Mustache website",
-        "https://mustache.github.io/");
-    `I ("Mustache templates documentation",
-        "https://mustache.github.io/mustache.5.html");
-    `I ("ocaml-mustache website:",
-        "https://github.com/rgrinberg/ocaml-mustache");
-
-    `P "The $(i,ocaml-mustache) implementation is tested against
-        the Mustache specification testsuite.
-        All features are supported, except for lambdas and setting delimiter tags.";
-    `S Manpage.s_options;
-    `S "PARTIALS";
-    `P "The $(i,ocaml-mustache) library gives programmatic control over the meaning of partials {{>foo}}.
-        For the $(tname) tool, partials are interpreted as template file inclusion: '{{>foo}}' includes
-        the template file 'foo.mustache'.";
-    `P "Included files are resolved in a search path, which contains the current working directory
-        (unless the $(b,--no-working-dir) option is used)
-        and include directories passed through $(b,-I DIR) options.";
-    `P "If a file exists in several directories of the search path, the directory included first
-        (leftmost $(b,-I) option) has precedence, and the current working directory has precedence
-        over include directories.";
-    `S Manpage.s_examples;
-    `Pre
-      {|
+let manpage = Cmdliner.[
+  `S Manpage.s_description;
+  `P "$(tname) is a command-line tool coming with the $(i,ocaml-mustache) library,
+      an OCaml implementation of the Mustache template format.
+      $(tname) takes a data file and a template file as command-line parameters;
+      it renders the populated template on standard output.";
+
+  `P "Mustache is a simple and popular template format,
+      with library implementations in many programming languages.
+      It is named from its {{..}} delimiters.";
+
+  `I ("Mustache website",
+      "https://mustache.github.io/");
+  `I ("Mustache templates documentation",
+      "https://mustache.github.io/mustache.5.html");
+  `I ("$(i,ocaml-mustache) website:",
+      "https://github.com/rgrinberg/ocaml-mustache");
+
+  `S Manpage.s_options;
+  (* The content of this section is filled by Cmdliner; it is used here
+     to enforce the placement of the non-standard sections below. *)
+
+  `S "PARTIALS";
+  `P "The $(i,ocaml-mustache) library gives programmatic control over the meaning of partials {{>foo}}.
+      For the $(tname) tool, partials are interpreted as template file inclusion: '{{>foo}}' includes
+      the template file 'foo.mustache'.";
+  `P "Included files are resolved in a search path, which contains the current working directory
+      (unless the $(b,--no-working-dir) option is used)
+      and include directories passed through $(b,-I DIR) options.";
+  `P "If a file exists in several directories of the search path, the directory included first
+      (leftmost $(b,-I) option) has precedence, and the current working directory has precedence
+      over include directories.";
+
+  `S Manpage.s_examples;
+  `Pre {|
+## Simple usage.
+
 \$ cat data.json
 { "name": "OCaml",
   "qualities": [{"name": "simple"}, {"name": "fun"}] }
@@ -109,6 +108,8 @@ Mustache is:
 - fun
 
 
+## Using a partial to include a subpage; see $(b,PARTIALS).
+
 \$ cat page.mustache
 <html>
   <body>
@@ -124,13 +125,24 @@ Mustache is:
     - simple
     - fun
   </body>
-</html>
+</html>|};
 
-|};
-    `S Manpage.s_bugs;
-    `P "Report bugs on https://github.com/rgrinberg/ocaml-mustache/issues";
-  ]
-  in
+  `S "CONFORMING TO";
+
+  `P "The $(i,ocaml-mustache) implementation is tested against
+      the Mustache specification testsuite.
+      All features are supported, except for lambdas and setting delimiter tags.";
+
+  `I ("Mustache specification testsuite",
+      "https://github.com/mustache/spec");
+
+  `S "REPORTING BUGS";
+  `P "Report bugs on https://github.com/rgrinberg/ocaml-mustache/issues";
+]
+
+let run_command =
+  let open Cmdliner in
+  let doc = "renders Mustache template from JSON data files" in
   let json_file =
     let doc = "data file in JSON format" in
     Arg.(required & pos 0 (some file) None & info [] ~docv:"DATA.json" ~doc)
@@ -156,7 +168,7 @@ Mustache is:
     Term.(const search_path $ includes $ no_working_dir)
   in
   Term.(const run $ search_path $ json_file $ template_file),
-  Term.info "mustache" ~doc ~man
+  Term.info "mustache" ~doc ~man:manpage
 
 let () =
   let open Cmdliner in

bin/test/errors/parsing-errors.t

@@ -4,71 +4,61 @@ Delimiter problems:
   $ PROBLEM=no-closing-mustache.mustache
   $ echo "{{foo" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "no-closing-mustache.mustache", line 2, character 0: '}}' expected.
   [3]
 
   $ PROBLEM=one-closing-mustache.mustache
   $ echo "{{foo}" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "one-closing-mustache.mustache", line 1, character 5: '}}' expected.
   [3]
 
   $ PROBLEM=eof-before-variable.mustache
   $ echo "{{" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "eof-before-variable.mustache", line 2, character 0: ident expected.
   [3]
 
   $ PROBLEM=eof-before-section.mustache
   $ echo "{{#" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "eof-before-section.mustache", line 2, character 0: ident expected.
   [3]
 
   $ PROBLEM=eof-before-section-end.mustache
   $ echo "{{#foo}} {{.}} {{/" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "eof-before-section-end.mustache", line 2, character 0: ident expected.
   [3]
 
   $ PROBLEM=eof-before-inverted-section.mustache
   $ echo "{{^" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "eof-before-inverted-section.mustache", line 2, character 0:
   ident expected.
   [3]
 
   $ PROBLEM=eof-before-unescape.mustache
   $ echo "{{{" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "eof-before-unescape.mustache", line 2, character 0: ident expected.
   [3]
 
   $ PROBLEM=eof-before-unescape.mustache
   $ echo "{{&" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "eof-before-unescape.mustache", line 2, character 0: ident expected.
   [3]
 
   $ PROBLEM=eof-before-partial.mustache
   $ echo "{{>" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "eof-before-partial.mustache", line 2, character 0: '}}' expected.
   [3]
 
   $ PROBLEM=eof-in-comment.mustache
   $ echo "{{! non-terminated comment" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "eof-in-comment.mustache", line 2, character 0: non-terminated comment.
   [3]
 
@@ -78,14 +68,12 @@ Mismatches between opening and closing mustaches:
   $ PROBLEM=two-three.mustache
   $ echo "{{ foo }}}" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "two-three.mustache", line 1, characters 7-10: '}}' expected.
   [3]
 
   $ PROBLEM=three-two.mustache
   $ echo "{{{ foo }}" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "three-two.mustache", line 1, characters 8-10: '}}}' expected.
   [3]
 
@@ -95,23 +83,20 @@ Mismatch between section-start and section-end:
   $ PROBLEM=foo-bar.mustache
   $ echo "{{#foo}} {{.}} {{/bar}}" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
-  File "foo-bar.mustache", lines 1-2, characters 23-0:
+  File "foo-bar.mustache", line 1, characters 0-23:
   Section mismatch: {{#foo}} is closed by {{/bar}}.
   [3]
 
   $ PROBLEM=foo-not-closed.mustache
   $ echo "{{#foo}} {{.}} {{foo}}" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "foo-not-closed.mustache", line 2, character 0: syntax error.
   [3]
 
   $ PROBLEM=wrong-nesting.mustache
   $ echo "{{#bar}} {{#foo}} {{.}} {{/bar}} {{/foo}}" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
-  File "wrong-nesting.mustache", lines 1-2, characters 41-0:
+  File "wrong-nesting.mustache", line 1, characters 9-32:
   Section mismatch: {{#foo}} is closed by {{/bar}}.
   [3]
 
@@ -121,6 +106,5 @@ Weird cases that may confuse our lexer or parser:
   $ PROBLEM=weird-tag-name.mustache
   $ echo "{{.weird}} foo bar" > $PROBLEM
   $ mustache foo.json $PROBLEM
-  Template parse error:
   File "weird-tag-name.mustache", line 1, character 3: '}}' expected.
   [3]

bin/test/errors/render-errors.t/run.t

@@ -27,67 +27,57 @@ one possible source of error, or both, or none.
 Invalid variable name:
 
   $ mustache reference.json missing-variable.mustache
-  Template render error:
   File "missing-variable.mustache", line 14, characters 40-46:
   the variable 'na' is missing.
   [2]
 
   $ mustache missing-variable.json reference.mustache
-  Template render error:
   File "reference.mustache", line 5, characters 4-12:
   the variable 'data' is missing.
   [2]
 
 Invalid section name:
 
   $ mustache reference.json missing-section.mustache
-  Template render error:
   File "missing-section.mustache", line 14, characters 0-55:
   the section 'na' is missing.
   [2]
 
   $ mustache missing-section.json reference.mustache
-  Template render error:
   File "reference.mustache", lines 9-12, characters 0-10:
   the section 'group' is missing.
   [2]
 
 Error in a dotted path foo.bar (one case for the first component, the other in the second).
 
   $ mustache reference.json invalid-dotted-name-1.mustache
-  Template render error:
   File "invalid-dotted-name-1.mustache", line 10, characters 2-15:
   the variable 'gro' is missing.
   [2]
 
   $ mustache invalid-dotted-name-1.json reference.mustache
-  Template render error:
   File "reference.mustache", lines 9-12, characters 0-10:
   the section 'group' is missing.
   [2]
 
   $ mustache reference.json invalid-dotted-name-2.mustache
-  Template render error:
   File "invalid-dotted-name-2.mustache", line 10, characters 2-15:
   the variable 'group.fir' is missing.
   [2]
 
   $ mustache invalid-dotted-name-2.json reference.mustache
-  Template render error:
   File "reference.mustache", line 10, characters 2-17:
   the variable 'group.first' is missing.
   [2]
 
 Non-scalar used as a scalar:
 
   $ mustache reference.json non-scalar.mustache
-  Template render error:
   File "non-scalar.mustache", line 4, characters 0-8:
   the value of 'list' is not a valid scalar.
   [2]
 
   $ mustache non-scalar.json reference.mustache
-  Template render error:
   File "reference.mustache", line 1, characters 7-16:
   the value of 'title' is not a valid scalar.
   [2]
@@ -98,7 +88,6 @@ Missing partial (currently the CLI does not support any partial anyway):
 in better `ls` output).
 
   $ mustache reference.json z-missing-partial.mustache
-  Template render error:
   File "z-missing-partial.mustache", line 11, characters 2-13:
   the partial 'second' is missing.
   [2]

bin/test/partials.t/run.t

@@ -21,7 +21,6 @@ we need to set the search path to locate their included partials.
 
 This fails:
   $ (cd subdir; mustache ../data.json ../foo.mustache)
-  Template render error:
   File "../foo.mustache", line 2, characters 23-31:
   the partial 'bar' is missing.
   [2]