|
| 1 | +opam-version: "2.0" |
| 2 | +synopsis: "Utility libraries to use with [pp]" |
| 3 | +maintainer: ["Mathieu Barbin < [email protected]>"] |
| 4 | +authors: ["Mathieu Barbin"] |
| 5 | +license: "MIT" |
| 6 | +homepage: "https://github.com/mbarbin/pplumbing" |
| 7 | +doc: "https://mbarbin.github.io/pplumbing/" |
| 8 | +bug-reports: "https://github.com/mbarbin/pplumbing/issues" |
| 9 | +depends: [ |
| 10 | + "dune" {>= "3.17"} |
| 11 | + "ocaml" {>= "4.14"} |
| 12 | + "cmdlang-cmdliner-err-runner" {= version} |
| 13 | + "cmdlang-to-cmdliner" {>= "0.0.9"} |
| 14 | + "pplumbing-err" {= version} |
| 15 | + "pplumbing-log" {= version} |
| 16 | + "pplumbing-log-cli" {= version} |
| 17 | + "pplumbing-pp-tty" {= version} |
| 18 | + "odoc" {with-doc} |
| 19 | +] |
| 20 | +build: [ |
| 21 | + ["dune" "subst"] {dev} |
| 22 | + [ |
| 23 | + "dune" |
| 24 | + "build" |
| 25 | + "-p" |
| 26 | + name |
| 27 | + "-j" |
| 28 | + jobs |
| 29 | + "@install" |
| 30 | + "@runtest" {with-test} |
| 31 | + "@doc" {with-doc} |
| 32 | + ] |
| 33 | +] |
| 34 | +dev-repo: "git+https://github.com/mbarbin/pplumbing.git" |
| 35 | +description: """\ |
| 36 | + |
| 37 | +[pplumbing] defines a set of utility libraries to use with [pp]. |
| 38 | +It is compatible with [logs] and inspired by design choices used |
| 39 | +by [dune] for user messages. |
| 40 | + |
| 41 | +These libraries are meant to combine nicely into a small ecosystem |
| 42 | +of useful helpers to build CLIs in OCaml. |
| 43 | + |
| 44 | +- [Pp_tty] extends [pp] to build colored documents in the user's |
| 45 | + terminal using ansi escape codes. |
| 46 | + |
| 47 | +- [Err] is an abstraction to report located errors and warnings to |
| 48 | + the user. |
| 49 | + |
| 50 | +- [Log] is an interface to [logs] using [Pp_tty] rather than [Format]. |
| 51 | + |
| 52 | +- [Log_cli] contains functions to work with [Err] on the side of end |
| 53 | + programs (such as a command line tool). It defines command line |
| 54 | + helpers to configure the [Err] library, while taking care of setting |
| 55 | + the [logs] and [fmt] style rendering. |
| 56 | + |
| 57 | +- [Cmdlang_cmdliner_runner] is a library for running command line |
| 58 | + programs specified with [cmdlang] with [cmdliner] as a backend and |
| 59 | + making opinionated choices, assuming your dependencies are using |
| 60 | + [Err]. |
| 61 | + |
| 62 | +[cmdlang]: https://github.com/mbarbin/cmdlang |
| 63 | +[cmdliner]: https://github.com/dbuenzli/cmdliner |
| 64 | +[dune]: https://github.com/ocaml/dune |
| 65 | +[fmt]: https://github.com/dbuenzli/fmt |
| 66 | +[logs]: https://github.com/dbuenzli/logs |
| 67 | +[pp]: https://github.com/ocaml-dune/pp |
| 68 | + |
| 69 | +""" |
| 70 | +tags: [ "cli" "cmdlang" "logs" "pp" ] |
| 71 | +x-maintenance-intent: [ "(latest)" ] |
| 72 | +url { |
| 73 | + src: |
| 74 | + "https://github.com/mbarbin/pplumbing/releases/download/0.0.16/pplumbing-0.0.16.tbz" |
| 75 | + checksum: [ |
| 76 | + "sha256=8ae0c09fec9088bc7af60582717a9e9d8bb7703e2fbf0a1b90b82e5962ed7039" |
| 77 | + "sha512=ddd1d5a3d47e7c5ebfb2898f0810156dfca4e10df500ce8f39238cfe02b51fd12ea6d7796914bd02e9ad8e615da1ed7067c9f712bdbbfb884cab08d57bba3564" |
| 78 | + ] |
| 79 | +} |
| 80 | +x-commit-hash: "e12fafd3db63ab91e6b0a710f0adb0ede271e6fc" |
0 commit comments