deps(opam): Upgrade cmdliner dependency to 1.1.0 version

The new version of cmdliner has added support for UTF-8 encoded characters within man pages.
At the same time, a new module has been added, whose functionalities will replace deprecated
`Term.eval*` evaluation functions and `Term.info`.
To see more : https://github.com/dbuenzli/cmdliner/blob/master/CHANGES.md.

Author: hernoufM

learn-ocaml-client.opam

@@ -20,7 +20,7 @@ depends: [
   "asak"
   "base64"
   "base" {>= "v0.9.4"}
-  "cmdliner"
+  "cmdliner" {>= "1.1.0"}
   "cohttp" {>= "2.0.0"}
   "cohttp-lwt-unix" {>= "2.0.0"}
   "cstruct" {>= "3.3.0"}

learn-ocaml-client.opam.locked

@@ -32,7 +32,7 @@ depends: [
   "bigarray-compat" {= "1.0.0"}
   "bigstringaf" {= "0.8.0"}
   "biniou" {= "1.2.1"}
-  "cmdliner" {= "1.0.4"}
+  "cmdliner" {= "1.1.0"}
   "cohttp" {= "4.0.0"}
   "cohttp-lwt" {= "4.0.0"}
   "cohttp-lwt-unix" {= "4.0.0"}

learn-ocaml.opam

@@ -20,7 +20,7 @@ depends: [
   "asak"
   "base64"
   "base" {>= "v0.9.4"}
-  "cmdliner"
+  "cmdliner" {>= "1.1.0"}
   "cohttp" {>= "2.0.0"}
   "cohttp-lwt" {>= "2.0.0"}
   "cohttp-lwt-unix" {>= "2.0.0"}

learn-ocaml.opam.locked

@@ -30,7 +30,7 @@ depends: [
   "bigstringaf" {= "0.8.0"}
   "biniou" {= "1.2.1"}
   "checkseum" {= "0.3.1"}
-  "cmdliner" {= "1.0.4"}
+  "cmdliner" {= "1.1.0"}
   "cohttp" {= "4.0.0"}
   "cohttp-lwt" {= "4.0.0"}
   "cohttp-lwt-unix" {= "4.0.0"}

src/main/learnocaml_client.ml

@@ -43,7 +43,7 @@ module Args_server = struct
     value & opt (some url_conv) None &
     info ["s";"server"] ~docv:"URL" ~doc:
       "The URL of the learn-ocaml server."
-      ~env:(Term.env_info "LEARNOCAML_SERVER" ~doc:
+      ~env:(Cmd.Env.info "LEARNOCAML_SERVER" ~doc:
               "Sets the learn-ocaml server URL. Overridden by $(b,--server).")
   let local =
     value & flag & info ["local"] ~doc:
@@ -71,14 +71,14 @@ module Args_global = struct
     value & opt (some url_conv) None &
     info ["s";"server"] ~docv:"URL" ~doc:
       "The URL of the learn-ocaml server."
-      ~env:(Term.env_info "LEARNOCAML_SERVER" ~doc:
+      ~env:(Cmd.Env.info "LEARNOCAML_SERVER" ~doc:
               "Sets the learn-ocaml server URL. Overridden by $(b,--server).")
 
   let token =
     value & opt (some token_conv) None & info ["token";"t"] ~docv:"TOKEN" ~doc:
       "Your token on the learn-ocaml server. This is required when submitting \
        solutions or interacting with the server."
-      ~env:(Term.env_info "LEARNOCAML_TOKEN" ~doc:
+      ~env:(Cmd.Env.info "LEARNOCAML_TOKEN" ~doc:
               "Sets the learn-ocaml user token on the sever. Overridden by \
                $(b,--token).")
 
@@ -163,7 +163,7 @@ module Args_exercises = struct
     let when_enum = ["always", Some true; "never", Some false; "auto", None] in
     value & opt (enum when_enum) None & info ["color"] ~docv:"WHEN" ~doc:
       ("Colorise the output, and also allows use of UTF-8 characters. $(docv) \
-        must be "^doc_alts_enum when_enum ^".")
+        must be "^doc_alts_enum ~quoted:true when_enum ^".")
 
   let verbose =
     value & flag_all & info ["v";"verbose"] ~doc:
@@ -727,13 +727,16 @@ module Init = struct
   let man = man "Initialize the configuration file with the server, and \
                  a token or a nickname+secret pair"
 
-  let cmd =
-    Term.(
-      const (fun go co -> Stdlib.exit (Lwt_main.run (init go co)))
-      $ Args_global.term $ Args_create_token.term),
-    Term.info ~man
+  let info =
+    Cmd.info 
+      ~man
       ~doc:"Initialize the configuration file."
       "init"
+  
+  let term =
+    Term.(
+      const (fun go co -> Stdlib.exit (Lwt_main.run (init go co)))
+      $ Args_global.term $ Args_create_token.term) 
 end
 
 module Grade = struct
@@ -813,13 +816,16 @@ module Grade = struct
       "Grades an OCaml exercise using a learn-ocaml server, and submits \
         solutions."
 
-  let cmd =
+  let info =
+    Cmd.info 
+      ~man
+      ~doc:"Learn-ocaml grading client."
+      "grade"        
+  
+  let term = 
     Term.(
       const (fun go eo -> Stdlib.exit (Lwt_main.run (grade go eo)))
-      $ Args_global.term $ Args_exercises.term),
-    Term.info ~man
-      ~doc:"Learn-ocaml grading client."
-      "grade"
+      $ Args_global.term $ Args_exercises.term)
 end
 
 let use_global f =
@@ -840,9 +846,9 @@ module Print_token = struct
 
   let man = man explanation
 
-  let cmd =
-    use_global print_tok,
-    Term.info ~man ~doc:explanation "print-token"
+  let info = Cmd.info ~man ~doc:explanation "print-token"
+
+  let term = use_global print_tok
 end
 
 module Print_server = struct
@@ -856,9 +862,9 @@ module Print_server = struct
 
   let man = man explanation
 
-  let cmd =
-    use_global print_server,
-    Term.info ~man ~doc:explanation "print-server"
+  let info = Cmd.info ~man ~doc:explanation "print-server"
+
+  let term = use_global print_server        
 
 end
 
@@ -935,19 +941,20 @@ module Server_version = struct
   let man = man explanation
 
   let exits =
-    let open Term in
-    [ exit_info ~doc:"Default exit." exit_status_success
-    ; exit_info ~doc:"Unable to reach the server." 1
-    ; exit_info ~doc:"Input error: unable to find a server URL." 2
-    ; exit_info ~doc:"The client's version is incompatible (too old?) w.r.t. the server." 70
+    let open Cmd.Exit in
+    [ info ~doc:"Default exit." ok
+    ; info ~doc:"Unable to reach the server." 1
+    ; info ~doc:"Input error: unable to find a server URL." 2
+    ; info ~doc:"The client's version is incompatible (too old?) w.r.t. the server." 70
     ]
 
+  let info = Cmd.info ~man ~exits ~doc:explanation "server-version"
+  
   (* TODO: Generalize & Use [use_global] *)
-  let cmd =
+  let term =
     Term.(
       const (fun o l -> Stdlib.exit (Lwt_main.run (server_version o l)))
-      $ Args_server.term $ Args_server_version.term),
-    Term.info ~man ~exits ~doc:explanation "server-version"
+      $ Args_server.term $ Args_server_version.term)
 end
 
 module Set_options = struct
@@ -960,11 +967,13 @@ module Set_options = struct
       "Overwrite the configuration file with the command-line options \
        ($(b,--server), $(b,--token))."
 
-  let cmd =
-    use_global set_opts,
-    Term.info ~man
+  let info =
+    Cmd.info 
+      ~man
       ~doc:"Set configuration."
       "set-options"
+
+  let term = use_global set_opts
 end
 
 let write_exercise_file id str =
@@ -1034,19 +1043,23 @@ module Fetch = struct
       "Fetch the user's solutions on the server to the current directory."
 
   let exits =
-    let open Term in
-    [ exit_info ~doc:"Default exit." exit_status_success
-    ; exit_info ~doc:"There was a file already present on the local side." 1
-    ; exit_info ~doc:"A specified exercise was not found on the server." 2
-    ; exit_info ~doc:"Both of 1 and 2." 3 ]
+    let open Cmd.Exit in
+    [ info ~doc:"Default exit." ok
+    ; info ~doc:"There was a file already present on the local side." 1
+    ; info ~doc:"A specified exercise was not found on the server." 2
+    ; info ~doc:"Both of 1 and 2." 3 ]
+
+  let info =
+    Cmd.info 
+      ~man 
+      ~exits
+      ~doc:"Fetch the user's solutions."
+      "fetch"
 
-  let cmd =
+  let term =
     Term.(
       const (fun o l -> Stdlib.exit (Lwt_main.run (fetch o l)))
-      $ Args_global.term $ Args_fetch.term),
-    Term.info ~man ~exits
-      ~doc:"Fetch the user's solutions."
-      "fetch"
+      $ Args_global.term $ Args_fetch.term)
 end
 
 module Create_token = struct
@@ -1072,13 +1085,16 @@ module Create_token = struct
   let man = man "Create a token on the server with the desired nickname.\
                  Prodiving a token will test if it exists on the server."
 
-  let cmd =
-    Term.(
-      const (fun go co -> Stdlib.exit (Lwt_main.run (create_tok go co)))
-      $ Args_global.term_server $ Args_create_token.term),
-    Term.info ~man
+  let info =
+    Cmd.info 
+      ~man
       ~doc:"Create a token."
       "create-token"
+  
+  let term =
+    Term.(
+      const (fun go co -> Stdlib.exit (Lwt_main.run (create_tok go co)))
+      $ Args_global.term_server $ Args_create_token.term)
 end
 
 module Template = struct
@@ -1102,13 +1118,16 @@ module Template = struct
 
   let man = man "Get the template of a given exercise"
 
-  let cmd =
-    Term.(
-      const (fun o id -> Stdlib.exit (Lwt_main.run (template o id)))
-      $ Args_global.term $ Args_exercise_id.term),
-    Term.info ~man
+  let info =
+    Cmd.info 
+      ~man
       ~doc:"Get the template of a given exercise."
       "template"
+
+  let term =
+    Term.(
+      const (fun o id -> Stdlib.exit (Lwt_main.run (template o id)))
+      $ Args_global.term $ Args_exercise_id.term)
 end
 
 module Exercise_list = struct
@@ -1133,38 +1152,44 @@ module Exercise_list = struct
     Lwt.return 0;)
 
   let man = man doc
-          
-  let cmd =
-    use_global exercise_list,
-    Term.info ~man ~doc:doc "exercise-list"
+
+  let info = Cmd.info ~man ~doc:doc "exercise-list"
+
+  let term = use_global exercise_list
 end
 
 module Main = struct
   let man =
     man
       "Learn-ocaml-client, default command is grade."
 
-  let cmd = fst Grade.cmd,
-    Term.info ~version ~man
+  let info = 
+    Cmd.info 
+      ~version 
+      ~man
       ~doc:"Learn-ocaml grading client."
       "learn-ocaml-client"
+  
+  let term = Grade.term
+        
 end
 
 let () =
-  match Term.eval_choice ~catch:false Main.cmd
-          [ Init.cmd
-          ; Grade.cmd
-          ; Print_token.cmd
-          ; Set_options.cmd
-          ; Fetch.cmd
-          ; Print_server.cmd
-          ; Server_version.cmd
-          ; Template.cmd
-          ; Create_token.cmd
-          ; Exercise_list.cmd]
-  with
+  let open Cmd in 
+  let cmd = group ~default:Main.term Main.info
+    [ v Init.info Init.term
+    ; v Grade.info Grade.term
+    ; v Print_token.info Print_token.term
+    ; v Set_options.info Set_options.term
+    ; v Fetch.info Fetch.term
+    ; v Print_server.info Print_server.term
+    ; v Server_version.info Server_version.term
+    ; v Template.info Template.term
+    ; v Create_token.info Create_token.term
+    ; v Exercise_list.info Exercise_list.term ] in
+  match Cmd.eval_value ~catch:false cmd with
   | exception Failure msg ->
       Printf.eprintf "[ERROR] %s\n" msg;
       exit 1
-  | `Error _ -> exit 2
+  | Error _ -> exit 2
   | _ -> exit 0

src/main/learnocaml_main.ml

@@ -453,20 +453,22 @@ let man = [
       $(i,https://github.com/ocaml-sf/learn-ocaml/issues)";
 ]
 
-let main_cmd =
-  Cmdliner.Term.(const main $ Args.term),
-  Cmdliner.Term.info
-    ~man
+let main_info =
+  Cmdliner.Cmd.info 
+    ~man 
     ~doc:"Learn-ocaml web-app manager"
-    ~version:Learnocaml_api.version
+    ~version:Learnocaml_api.version 
     "learn-ocaml"
 
+let main_term = Cmdliner.Term.(const main $ Args.term)
+
 let () =
+  let open Cmdliner in
   match
-    Cmdliner.Term.eval ~catch:false main_cmd
+    Cmd.eval_value ~catch:false (Cmd.v main_info main_term)
   with
   | exception Failure msg ->
       Printf.eprintf "[ERROR] %s\n" msg;
       exit 1
-  | `Error _ -> exit 2
+  | Error _ -> exit 2
   | _ -> exit 0

src/main/learnocaml_server_main.ml

@@ -80,20 +80,23 @@ let base_url =
        Mandatory for '$(b,learn-ocaml build)' if the site is not hosted in path '/', \
        which typically occurs for static deployment."
 
-let main_cmd =
-  Cmdliner.Term.(const main $ Learnocaml_server_args.term app_dir base_url),
-  Cmdliner.Term.info
+let main_info =
+  Cmdliner.Cmd.info
     ~man
     ~doc:"Learn-ocaml web-app manager"
     ~version:Learnocaml_api.version
     "learn-ocaml"
 
+
+let main_term = Cmdliner.Term.(const main $ Learnocaml_server_args.term app_dir base_url)
+      
 let () =
+  let open Cmdliner in
   match
-    Cmdliner.Term.eval ~catch:false main_cmd
+    Cmd.eval_value ~catch:false (Cmd.v main_info main_term)
   with
   | exception Failure msg ->
       Printf.eprintf "[ERROR] %s\n" msg;
       exit 1
-  | `Error _ -> exit 2
+  | Error _ -> exit 2
   | _ -> exit 0

src/repo/learnocaml_exercise.ml

@@ -238,7 +238,7 @@ module File = struct
         | Some id, None | None, Some id -> return id
         | Some id, Some id' ->
             if id = id' then return id else
-              fail (Failure "Exercise.read: conficting ids")
+              fail (Failure "Exercise.read: conflicting ids")
       end >>= fun ex_id ->
       ex := set id ex_id !ex ;
       (* read_field meta.key >>=