Merge pull request #71 from psafont/newcmd

Rename CLI tool to mustache-ocaml, separate it into it's own package
rgrinberg · Nov 27, 2023 · 1d12af8 · 1d12af8
2 parents a86cab0 + f87b835
commit 1d12af8
Show file tree

Hide file tree

Showing 79 changed files with 153 additions and 103 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,7 @@
+### 3.3.0
+* Rename the CLI tool to `mustache-ocaml`. It's now part of the new opam
+  package `mustache-cli` (@psafont, #71)
+
 ### 3.2.0
 
 * Remove the AST without locations: now all functions build an AST with locations;

diff --git a/bin/dune b/bin/dune
diff --git a/bin/test/dune b/bin/test/dune
diff --git a/bin/test/errors/dune b/bin/test/errors/dune
diff --git a/bin/test/errors/sys-errors.t b/bin/test/errors/sys-errors.t
diff --git a/dune-project b/dune-project
@@ -22,13 +22,23 @@
  (name mustache)
  (synopsis "Mustache logic-less templates in OCaml")
  (description "
-Read and write mustache templates, and render them by providing a json object.
-Contains the `mustache` command line utility for driving logic-less templates.
+Read and write mustache templates, and render them.
 ")
  (depends
-  (jsonm (>= 1.0.1))
   (ounit2 :with-test)
   (ezjsonm :with-test)
   (menhir (>= 20180703))
-  (cmdliner (>= 1.0.4))
+  (ocaml (>= 4.08))))
+
+(package
+ (name mustache-cli)
+ (synopsis "CLI for Mustache logic-less templates")
+ (description "
+Command line utility `mustache-ocaml` for driving logic-less templates.
+Read and write mustache templates, and render them by providing a json object.
+")
+ (depends
+  (jsonm (>= 1.0.1))
+  (mustache (= :version))
+  (cmdliner (>= 1.1.0))
   (ocaml (>= 4.08))))
diff --git a/mustache-cli.opam b/mustache-cli.opam
@@ -0,0 +1,40 @@
+# This file is generated by dune, edit dune-project instead
+opam-version: "2.0"
+synopsis: "CLI for Mustache logic-less templates"
+description: """
+
+Command line utility `mustache-ocaml` for driving logic-less templates.
+Read and write mustache templates, and render them by providing a json object.
+"""
+maintainer: ["Rudi Grinberg <[email protected]>"]
+authors: [
+  "Rudi Grinberg <[email protected]>"
+  "Armaël Guéneau <[email protected]>"
+  "Gabriel Scherer <[email protected]>"
+]
+license: "MIT"
+homepage: "https://github.com/rgrinberg/ocaml-mustache"
+bug-reports: "https://github.com/rgrinberg/ocaml-mustache/issues"
+depends: [
+  "dune" {>= "2.7"}
+  "jsonm" {>= "1.0.1"}
+  "mustache" {= version}
+  "cmdliner" {>= "1.1.0"}
+  "ocaml" {>= "4.08"}
+  "odoc" {with-doc}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
+]
+dev-repo: "git+https://github.com/rgrinberg/ocaml-mustache.git"
diff --git a/mustache-cli/dune b/mustache-cli/dune
@@ -0,0 +1,16 @@
+(executable
+ (name mustache_cli)
+ (public_name mustache-ocaml)
+ (package mustache-cli)
+ (libraries mustache jsonm cmdliner))
+
+(rule
+ (deps (:bin mustache_cli.exe))
+ (action
+  (with-stdout-to mustache.1
+   (run %{bin} --help=groff))))
+
+(install
+ (section man)
+ (package mustache-cli)
+ (files mustache.1))
diff --git a/bin/mustache_cli.ml → mustache-cli/mustache_cli.ml b/bin/mustache_cli.ml → mustache-cli/mustache_cli.ml
@@ -305,9 +305,8 @@ let run_command =
     in
     Term.(const search_path $ includes $ no_working_dir)
   in
-  ( Term.(const run $ search_path $ json_file $ template_file)
-  , Term.info "mustache" ~doc ~man:manpage )
+  Cmd.v
+    (Cmd.info "mustache" ~doc ~man:manpage)
+    Term.(const run $ search_path $ json_file $ template_file)
 
-let () =
-  let open Cmdliner in
-  Term.exit @@ Term.eval run_command
+let () = exit @@ Cmdliner.Cmd.eval run_command
diff --git a/mustache-cli/test/dune b/mustache-cli/test/dune
@@ -0,0 +1,2 @@
+(cram
+ (deps %{bin:mustache-ocaml}))
diff --git a/mustache-cli/test/errors/dune b/mustache-cli/test/errors/dune
@@ -0,0 +1,2 @@
+(cram
+ (deps %{bin:mustache-ocaml}))
diff --git a/bin/test/errors/json-errors.t → mustache-cli/test/errors/json-errors.t b/bin/test/errors/json-errors.t → mustache-cli/test/errors/json-errors.t
@@ -3,12 +3,12 @@
   $ echo '{{foo}}' > foo.mustache
 
 Empty json file:
-  $ mustache empty.json foo.mustache
+  $ mustache-ocaml empty.json foo.mustache
   File "empty.json", line 1, character 0: expected JSON text (JSON value)
   [4]
 
 Invalid json file:
-  $ mustache invalid.json foo.mustache
+  $ mustache-ocaml invalid.json foo.mustache
   File "invalid.json", line 1, characters 15-29:
   expected value separator or object end (',' or '}')
   [4]
diff --git a/bin/test/errors/parsing-errors.t → mustache-cli/test/errors/parsing-errors.t b/bin/test/errors/parsing-errors.t → mustache-cli/test/errors/parsing-errors.t
@@ -3,62 +3,62 @@
 Delimiter problems:
   $ PROBLEM=no-closing-mustache.mustache
   $ echo "{{foo" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "no-closing-mustache.mustache", line 2, character 0: '}}' expected.
   [3]
 
   $ PROBLEM=one-closing-mustache.mustache
   $ echo "{{foo}" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "one-closing-mustache.mustache", line 1, character 5: '}}' expected.
   [3]
 
   $ PROBLEM=eof-before-variable.mustache
   $ echo "{{" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "eof-before-variable.mustache", line 2, character 0: ident expected.
   [3]
 
   $ PROBLEM=eof-before-section.mustache
   $ echo "{{#" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   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
+  $ mustache-ocaml foo.json $PROBLEM
   File "eof-before-section-end.mustache", line 2, character 0: '}}' expected.
   [3]
 
   $ PROBLEM=eof-before-inverted-section.mustache
   $ echo "{{^" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "eof-before-inverted-section.mustache", line 2, character 0:
   ident expected.
   [3]
 
   $ PROBLEM=eof-before-unescape.mustache
   $ echo "{{{" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "eof-before-unescape.mustache", line 2, character 0: ident expected.
   [3]
 
   $ PROBLEM=eof-before-unescape.mustache
   $ echo "{{&" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "eof-before-unescape.mustache", line 2, character 0: ident expected.
   [3]
 
   $ PROBLEM=eof-before-partial.mustache
   $ echo "{{>" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   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
+  $ mustache-ocaml foo.json $PROBLEM
   File "eof-in-comment.mustache", line 2, character 0: non-terminated comment.
   [3]
 
@@ -67,13 +67,13 @@ Mismatches between opening and closing mustaches:
 
   $ PROBLEM=two-three.mustache
   $ echo "{{ foo }}}" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "two-three.mustache", line 1, characters 7-10: '}}' expected.
   [3]
 
   $ PROBLEM=three-two.mustache
   $ echo "{{{ foo }}" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "three-two.mustache", line 1, characters 8-10: '}}}' expected.
   [3]
 
@@ -82,34 +82,34 @@ Mismatch between section-start and section-end:
 
   $ PROBLEM=foo-bar.mustache
   $ echo "{{#foo}} {{.}} {{/bar}}" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "foo-bar.mustache", line 1, characters 0-23:
   Open/close tag mismatch: {{# foo }} is closed by {{/ bar }}.
   [3]
 
   $ PROBLEM=foo-not-closed.mustache
   $ echo "{{#foo}} {{.}} {{foo}}" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   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
+  $ mustache-ocaml foo.json $PROBLEM
   File "wrong-nesting.mustache", line 1, characters 9-32:
   Open/close tag mismatch: {{# foo }} is closed by {{/ bar }}.
   [3]
 
   $ PROBLEM=wrong-nesting-variable.mustache
   $ echo '{{#bar}} {{$foo}} {{.}} {{/bar}} {{/foo}}' > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "wrong-nesting-variable.mustache", line 1, characters 9-32:
   Open/close tag mismatch: {{$ foo }} is closed by {{/ bar }}.
   [3]
 
   $ PROBLEM=wrong-nesting-partial.mustache
   $ echo "{{#foo}} {{<foo-bar}} {{/foo}} {{/foo-bar}}" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "wrong-nesting-partial.mustache", line 1, characters 9-30:
   Open/close tag mismatch: {{< foo-bar }} is closed by {{/ foo }}.
   [3]
@@ -120,6 +120,6 @@ Weird cases that may confuse our lexer or parser:
 
   $ PROBLEM=weird-tag-name.mustache
   $ echo "{{.weird}} foo bar" > $PROBLEM
-  $ mustache foo.json $PROBLEM
+  $ mustache-ocaml foo.json $PROBLEM
   File "weird-tag-name.mustache", line 1, character 3: '}}' expected.
   [3]
diff --git a/...ender-errors.t/invalid-dotted-name-1.json → ...ender-errors.t/invalid-dotted-name-1.json b/...ender-errors.t/invalid-dotted-name-1.json → ...ender-errors.t/invalid-dotted-name-1.json
diff --git a/...r-errors.t/invalid-dotted-name-1.mustache → ...r-errors.t/invalid-dotted-name-1.mustache b/...r-errors.t/invalid-dotted-name-1.mustache → ...r-errors.t/invalid-dotted-name-1.mustache
diff --git a/...ender-errors.t/invalid-dotted-name-2.json → ...ender-errors.t/invalid-dotted-name-2.json b/...ender-errors.t/invalid-dotted-name-2.json → ...ender-errors.t/invalid-dotted-name-2.json
diff --git a/...r-errors.t/invalid-dotted-name-2.mustache → ...r-errors.t/invalid-dotted-name-2.mustache b/...r-errors.t/invalid-dotted-name-2.mustache → ...r-errors.t/invalid-dotted-name-2.mustache
diff --git a/...rors/render-errors.t/missing-section.json → ...rors/render-errors.t/missing-section.json b/...rors/render-errors.t/missing-section.json → ...rors/render-errors.t/missing-section.json
diff --git a/.../render-errors.t/missing-section.mustache → .../render-errors.t/missing-section.mustache b/.../render-errors.t/missing-section.mustache → .../render-errors.t/missing-section.mustache
diff --git a/...ors/render-errors.t/missing-variable.json → ...ors/render-errors.t/missing-variable.json b/...ors/render-errors.t/missing-variable.json → ...ors/render-errors.t/missing-variable.json
diff --git a/...render-errors.t/missing-variable.mustache → ...render-errors.t/missing-variable.mustache b/...render-errors.t/missing-variable.mustache → ...render-errors.t/missing-variable.mustache
diff --git a/...st/errors/render-errors.t/non-scalar.json → ...st/errors/render-errors.t/non-scalar.json b/...st/errors/render-errors.t/non-scalar.json → ...st/errors/render-errors.t/non-scalar.json
diff --git a/...rrors/render-errors.t/non-scalar.mustache → ...rrors/render-errors.t/non-scalar.mustache b/...rrors/render-errors.t/non-scalar.mustache → ...rrors/render-errors.t/non-scalar.mustache
diff --git a/...est/errors/render-errors.t/reference.json → ...est/errors/render-errors.t/reference.json b/...est/errors/render-errors.t/reference.json → ...est/errors/render-errors.t/reference.json
diff --git a/...errors/render-errors.t/reference.mustache → ...errors/render-errors.t/reference.mustache b/...errors/render-errors.t/reference.mustache → ...errors/render-errors.t/reference.mustache
diff --git a/bin/test/errors/render-errors.t/run.t → ...che-cli/test/errors/render-errors.t/run.t b/bin/test/errors/render-errors.t/run.t → ...che-cli/test/errors/render-errors.t/run.t
@@ -1,5 +1,5 @@
 reference.json and reference.mustache work well together, there is no error.
-  $ mustache reference.json reference.mustache
+  $ mustache-ocaml reference.json reference.mustache
   Title: Some Title
 
   List:
@@ -26,58 +26,58 @@ one possible source of error, or both, or none.
 
 Invalid variable name:
 
-  $ mustache reference.json missing-variable.mustache
+  $ mustache-ocaml reference.json missing-variable.mustache
   File "missing-variable.mustache", line 14, characters 40-46:
   the variable 'na' is missing.
   [2]
 
-  $ mustache missing-variable.json reference.mustache
+  $ mustache-ocaml missing-variable.json reference.mustache
   File "reference.mustache", line 5, characters 4-12:
   the variable 'data' is missing.
   [2]
 
 Invalid section name:
 
-  $ mustache reference.json missing-section.mustache
+  $ mustache-ocaml reference.json missing-section.mustache
   File "missing-section.mustache", line 14, characters 0-55:
   the section 'na' is missing.
   [2]
 
-  $ mustache missing-section.json reference.mustache
+  $ mustache-ocaml missing-section.json reference.mustache
   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
+  $ mustache-ocaml reference.json invalid-dotted-name-1.mustache
   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
+  $ mustache-ocaml invalid-dotted-name-1.json reference.mustache
   File "reference.mustache", lines 9-12, characters 0-10:
   the section 'group' is missing.
   [2]
 
-  $ mustache reference.json invalid-dotted-name-2.mustache
+  $ mustache-ocaml reference.json invalid-dotted-name-2.mustache
   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
+  $ mustache-ocaml invalid-dotted-name-2.json reference.mustache
   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
+  $ mustache-ocaml reference.json non-scalar.mustache
   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
+  $ mustache-ocaml non-scalar.json reference.mustache
   File "reference.mustache", line 1, characters 7-16:
   the value of 'title' is not a valid scalar.
   [2]
@@ -87,7 +87,7 @@ Missing partial (currently the CLI does not support any partial anyway):
 (this one does not) are all before in the alphabetic order, resulting
 in better `ls` output).
 
-  $ mustache reference.json z-missing-partial.mustache
+  $ mustache-ocaml reference.json z-missing-partial.mustache
   File "z-missing-partial.mustache", line 11, characters 2-13:
   the partial 'second' is missing.
   [2]
diff --git a/...ender-errors.t/z-missing-partial.mustache → ...ender-errors.t/z-missing-partial.mustache b/...ender-errors.t/z-missing-partial.mustache → ...ender-errors.t/z-missing-partial.mustache