Merge pull request #14 from mbarbin/squashed

Prepare 0.3.0

CHANGES.md

@@ -1,3 +1,14 @@
+## 0.3.0 (2024-08-23)
+
+### Changed
+
+- Switch from `Error_log` to `Err` for error handling.
+- Internal refactors, switch from `Core` to `Base` in assorted places.
+- Split main packages into separate smaller ones.
+- Switch to `commandlang` with `cmdliner` as a backend for all commands. Breaking changes:
+  - Flags and named command line arguments now have 2 '--' instead of 1.
+  - Exit code changes, using now cmdliner default conventions (123, 124, 125).
+
 ## 0.2.9 (2024-07-26)
 
 ### Added

bin/dune

@@ -1,5 +1,6 @@
 (executable
  (name main)
+ (package bopkit)
  (public_name bopkit)
- (libraries bopkit_command command-unix-for-opam)
+ (libraries bopkit_command commandlang-to-cmdliner)
  (flags :standard -w +a-4-40-41-42-44-45-48-66 -warn-error +a))

bin/main.ml

@@ -1 +1,3 @@
-let () = Command_unix_for_opam.run Bopkit_command.main
+let () =
+  Commandlang_to_cmdliner.run Bopkit_command.main ~name:"bopkit" ~version:"%%VERSION%%"
+;;

bopkit-tests.opam

@@ -0,0 +1,69 @@
+# This file is generated by dune, edit dune-project instead
+opam-version: "2.0"
+synopsis: "Tests for [bopkit]"
+maintainer: ["Mathieu Barbin"]
+authors: ["Mathieu Barbin"]
+license: "MIT"
+homepage: "https://github.com/mbarbin/bopkit"
+doc: "https://mbarbin.github.io/bopkit/"
+bug-reports: "https://github.com/mbarbin/bopkit/issues"
+depends: [
+  "dune" {>= "3.16"}
+  "ocaml" {>= "5.2"}
+  "ANSITerminal" {>= "0.8.3"}
+  "appendable-list" {>= "v0.17" & < "v0.18"}
+  "auto-format" {>= "0.0.11"}
+  "base" {>= "v0.17" & < "v0.18"}
+  "base_quickcheck" {>= "v0.17" & < "v0.18"}
+  "cmdliner" {= "1.3.0"}
+  "commandlang" {>= "0.0.2"}
+  "commandlang-to-cmdliner" {>= "0.0.2"}
+  "core" {>= "v0.17" & < "v0.18"}
+  "core_unix" {>= "v0.17" & < "v0.18"}
+  "dune-site" {>= "3.16"}
+  "err0" {>= "0.0.2"}
+  "err0-handler" {>= "0.0.2"}
+  "expect_test_helpers_core" {>= "v0.17" & < "v0.18"}
+  "fpath" {>= "0.7.3"}
+  "fpath-base" {>= "0.0.9"}
+  "graphics" {>= "5.1.2"}
+  "loc0" {>= "0.1.0"}
+  "mdx" {>= "2.4"}
+  "menhir" {>= "20220210"}
+  "parsing-utils" {>= "0.0.8"}
+  "pp" {>= "1.2.0"}
+  "pp-extended" {>= "0.0.2"}
+  "ppx_compare" {>= "v0.17" & < "v0.18"}
+  "ppx_enumerate" {>= "v0.17" & < "v0.18"}
+  "ppx_expect" {>= "v0.17" & < "v0.18"}
+  "ppx_fields_conv" {>= "v0.17" & < "v0.18"}
+  "ppx_hash" {>= "v0.17" & < "v0.18"}
+  "ppx_here" {>= "v0.17" & < "v0.18"}
+  "ppx_js_style" {dev & >= "v0.17" & < "v0.18"}
+  "ppx_let" {>= "v0.17" & < "v0.18"}
+  "ppx_sexp_conv" {>= "v0.17" & < "v0.18"}
+  "ppx_sexp_value" {>= "v0.17" & < "v0.18"}
+  "ppxlib" {>= "0.33"}
+  "stdio" {>= "v0.17" & < "v0.18"}
+  "stdune" {>= "3.16"}
+  "tsdl" {>= "0.9.8"}
+  "tsdl-image" {>= "0.6"}
+  "odoc" {with-doc}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "--promote-install-files=false"
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
+  ["dune" "install" "-p" name "--create-install-files" name]
+]
+dev-repo: "git+https://github.com/mbarbin/bopkit.git"

bopkit.opam

@@ -12,27 +12,28 @@ depends: [
   "ocaml" {>= "5.2"}
   "ANSITerminal" {>= "0.8.3"}
   "appendable-list" {>= "v0.17" & < "v0.18"}
-  "auto-format" {>= "0.0.7"}
+  "auto-format" {>= "0.0.11"}
   "base" {>= "v0.17" & < "v0.18"}
   "base_quickcheck" {>= "v0.17" & < "v0.18"}
-  "command-unix-for-opam" {>= "0.0.2"}
+  "cmdliner" {= "1.3.0"}
+  "commandlang" {>= "0.0.2"}
+  "commandlang-to-cmdliner" {>= "0.0.2"}
   "core" {>= "v0.17" & < "v0.18"}
   "core_unix" {>= "v0.17" & < "v0.18"}
   "dune-site" {>= "3.16"}
-  "error-log" {>= "0.0.4"}
-  "expect-test-helpers" {with-test & >= "v0.17" & < "v0.18"}
+  "err0" {>= "0.0.2"}
+  "err0-handler" {>= "0.0.2"}
   "fpath" {>= "0.7.3"}
   "fpath-base" {>= "0.0.9"}
   "graphics" {>= "5.1.2"}
-  "loc" {>= "0.0.2"}
+  "loc0" {>= "0.1.0"}
   "mdx" {>= "2.4"}
   "menhir" {>= "20220210"}
-  "parsing-utils" {>= "0.0.2"}
+  "parsing-utils" {>= "0.0.8"}
   "pp" {>= "1.2.0"}
   "pp-extended" {>= "0.0.2"}
   "ppx_compare" {>= "v0.17" & < "v0.18"}
   "ppx_enumerate" {>= "v0.17" & < "v0.18"}
-  "ppx_expect" {with-test & >= "v0.17" & < "v0.18"}
   "ppx_fields_conv" {>= "v0.17" & < "v0.18"}
   "ppx_hash" {>= "v0.17" & < "v0.18"}
   "ppx_here" {>= "v0.17" & < "v0.18"}

doc/reference/README.md

@@ -88,7 +88,7 @@ end where;
 We can go over a round of simulation with the following invocation:
 
 ```sh
-$ bopkit simu one-of-each.bop -counter-input -num-counter-cycles 1
+$ bopkit simu one-of-each.bop --counter-input --num-counter-cycles 1
    Cycle | a[0] a[1] | b[0] b[1] b[2] b[3]
        0 | 0 0 | 0 0 1 0
        1 | 1 0 | 1 1 0 0

doc/reference/dune

@@ -15,7 +15,7 @@
   (with-stdout-to
    %{target}
    (pipe-stdout
-    (run %{bin:bopkit} fmt gen-dune -- "\%{bin:bopkit}" fmt file)
+    (run %{bin:bopkit} fmt gen-dune "\%{bin:bopkit}" fmt file)
     (run dune format-dune-file)))))
 
 (cram