Remove Lwt and Base (#111)

Author: tmattio

Makefile

@@ -53,7 +53,7 @@ fmt: ## Format the codebase with ocamlformat
 
 .PHONY: watch
 watch: ## Watch for the filesystem and rebuild on every change
-	opam exec -- dune build ---root . -watch
+	opam exec -- dune build --root . --watch
 
 .PHONY: utop
 utop: ## Run a REPL and link with the project's libraries

README.md

@@ -135,6 +135,16 @@ If a value is present in the configuration file, it will not be prompted when ge
 
 See our [development board](https://github.com/tmattio/spin/projects/1) for a list of selected features and issues.
 
+Here are some of the improvements we'll be working on as well in for next releases:
+
+- [ ] Add cram tests to CI
+- [ ] Support Opam 2.0.X (add to CI)
+- [ ] Support windows
+- [ ] Support CLI options/args for configurations
+- [ ] Extract current templates in community templates, and drop support for Reason/Esy
+- [ ] Minimal `hello` template
+- [ ] Generators for `lib/bin/test` for all templates
+
 ## Contributing
 
 We'd love your help improving Spin!

bin/commands/cmd_config.ml

@@ -1,13 +1,12 @@
 open Spin
 
 let run () =
-  let open Result.Let_syntax in
+  let open Result.Syntax in
   let* user_config = User_config.read () in
   let* new_config =
-    let result = User_config.prompt ?default:user_config () in
-    try Ok (Lwt_main.run result) with
-    | Caml.Sys.Break | Failure _ ->
-      Caml.exit 1
+    try Ok (User_config.prompt ?default:user_config ()) with
+    | Sys.Break | Failure _ ->
+      exit 1
     | e ->
       raise e
   in
@@ -43,7 +42,7 @@ let man =
 let info = Term.info "config" ~doc ~sdocs ~exits ~envs ~man ~man_xrefs
 
 let term =
-  let open Common.Let_syntax in
+  let open Common.Syntax in
   let+ _term = Common.term in
   run () |> Common.handle_errors
 

bin/commands/cmd_gen.ml

@@ -1,7 +1,7 @@
 open Spin
 
 let run ~ignore_config ~use_defaults:_ ~generator =
-  let open Result.Let_syntax in
+  let open Result.Syntax in
   let* context =
     if ignore_config then
       Ok None
@@ -24,17 +24,16 @@ let run ~ignore_config ~use_defaults:_ ~generator =
   | Some project_config ->
     (match generator with
     | None ->
-      let+ generators =
-        Project.project_generators project_config.dec |> Lwt_main.run
-      in
+      let+ generators = Project.project_generators project_config.dec in
       Logs.app (fun m -> m "");
-      List.iter generators ~f:(fun (name, description) ->
+      List.iter
+        (fun (name, description) ->
           Logs.app (fun m -> m "  %a" Pp.pp_blue name);
           Logs.app (fun m -> m "    %s" description);
           Logs.app (fun m -> m ""))
+        generators
     | Some generator ->
-      Project.run_generator ?context ~project:project_config generator
-      |> Lwt_main.run)
+      Project.run_generator ?context ~project:project_config generator)
 
 (* Command line interface *)
 
@@ -71,7 +70,7 @@ let man =
 let info = Term.info "gen" ~doc ~sdocs ~exits ~envs ~man ~man_xrefs
 
 let term =
-  let open Common.Let_syntax in
+  let open Common.Syntax in
   let+ _term = Common.term
   and+ ignore_config = Common.ignore_config_arg
   and+ use_defaults = Common.use_defaults_arg

bin/commands/cmd_ls.ml

@@ -1,10 +1,11 @@
 open Spin
 
 let run () =
-  let open Result.Let_syntax in
+  let open Result.Syntax in
   let+ templates = Official_template.all_doc () in
   let sorted_templates =
-    List.sort templates ~compare:(fun { name = t1; _ } { name = t2; _ } ->
+    List.sort
+      (fun Official_template.{ name = t1; _ } Official_template.{ name = t2; _ } ->
         if String.equal (String.prefix t1 3) "bs-" then
           if String.equal (String.prefix t2 3) "bs-" then
             String.compare t1 t2
@@ -14,12 +15,15 @@ let run () =
           1
         else
           String.compare t1 t2)
+      templates
   in
   Logs.app (fun m -> m "");
-  List.iter sorted_templates ~f:(fun { name; description } ->
+  List.iter
+    (fun Official_template.{ name; description } ->
       Logs.app (fun m -> m "  %a" Pp.pp_blue name);
       Logs.app (fun m -> m "    %s" description);
       Logs.app (fun m -> m ""))
+    sorted_templates
 
 (* Command line interface *)
 
@@ -45,7 +49,7 @@ let man =
 let info = Term.info "ls" ~doc ~sdocs ~exits ~envs ~man ~man_xrefs
 
 let term =
-  let open Common.Let_syntax in
+  let open Common.Syntax in
   let+ _term = Common.term in
   run () |> Common.handle_errors
 

bin/commands/cmd_new.ml

@@ -1,19 +1,19 @@
 open Spin
 
 let run ~ignore_config ~use_defaults ~template ~path =
-  let open Result.Let_syntax in
+  let open Result.Syntax in
   let path = Option.value path ~default:Filename.current_dir_name in
   let* () =
     try
-      match Caml.Sys.readdir path with
+      match Sys.readdir path with
       | [||] ->
         Ok ()
       | _ ->
         Error
           (Spin_error.failed_to_generate "The output directory is not empty.")
     with
     | Sys_error _ ->
-      Spin_unix.mkdir_p path;
+      Sys.mkdir_p path;
       Ok ()
   in
   let* context =
@@ -37,19 +37,15 @@ let run ~ignore_config ~use_defaults ~template ~path =
   in
   match Template.source_of_string template with
   | Some source ->
-    let result =
-      let open Lwt_result.Syntax in
-      let* template = Template.read ?context ~use_defaults source in
-      Template.generate ~path template
-    in
-    let+ _ =
-      try Lwt_main.run result with
-      | Caml.Sys.Break | Failure _ ->
-        Caml.exit 1
-      | e ->
-        raise e
-    in
-    ()
+    let open Result.Syntax in
+    (try
+       let* template = Template.read ?context ~use_defaults source in
+       Template.generate ~path template
+     with
+    | Sys.Break | Failure _ ->
+      exit 1
+    | e ->
+      raise e)
   | None ->
     Logs.err (fun m -> m "This template does not exist");
     Ok ()
@@ -79,7 +75,7 @@ let man =
 let info = Term.info "new" ~doc ~sdocs ~exits ~envs ~man ~man_xrefs
 
 let term =
-  let open Common.Let_syntax in
+  let open Common.Syntax in
   let+ _term = Common.term
   and+ ignore_config = Common.ignore_config_arg
   and+ use_defaults = Common.use_defaults_arg

bin/common.ml

@@ -1,12 +1,12 @@
 open Cmdliner
 
-module Let_syntax = struct
+module Syntax = struct
   let ( let+ ) t f = Term.(const f $ t)
 
   let ( and+ ) a b = Term.(const (fun x y -> x, y) $ a $ b)
 end
 
-open Let_syntax
+open Syntax
 
 let ignore_config_arg =
   let doc =

bin/common.mli

@@ -10,7 +10,7 @@ val envs : Cmdliner.Term.env_info list
 
 val exits : Cmdliner.Term.exit_info list
 
-module Let_syntax : sig
+module Syntax : sig
   val ( let+ ) : 'a Cmdliner.Term.t -> ('a -> 'b) -> 'b Cmdliner.Term.t
 
   val ( and+ )

bin/main.ml

@@ -1,5 +1,7 @@
 open Cmdliner
 
+let () = Printexc.record_backtrace true
+
 let cmds = [ Cmd_config.cmd; Cmd_gen.cmd; Cmd_ls.cmd; Cmd_new.cmd ]
 
 let run () =
@@ -25,7 +27,7 @@ For a complete documentation, refer to the manual with `spin --help`.
 
 Use `spin COMMAND --help` for help on a single command.|}
   in
-  Caml.print_endline message;
+  print_endline message;
   0
 
 (* Command line interface *)
@@ -74,7 +76,7 @@ let man =
 
 let default_cmd =
   let term =
-    let open Common.Let_syntax in
+    let open Common.Syntax in
     let+ _term = Common.term in
     run ()
   in

dune-project

@@ -29,14 +29,14 @@
   (reason :with-test)
   (odoc :with-doc)
   (crunch :build)
-  base
+  (sexplib0
+   (>= v0.13))
+  (inquire
+   (>= 0.3.0))
+  (spawn
+   (>= v0.13))
   fmt
   fpath
   cmdliner
   logs
-  sexplib
-  (lwt
-   (>= 5.3.0))
-  jingoo
-  (inquire
-   (>= 0.2.1))))
+  jingoo))

lib/spin/config.ml

@@ -1,31 +1,31 @@
 let default_cache_dir =
   match Sys.os_type with
   | "Unix" ->
-    Sys.getenv "HOME"
-    |> Result.of_option ~error:(`Missing_env_var "HOME")
-    |> Result.map ~f:(fun home -> Filename.of_parts [ home; ".cache"; "spin" ])
+    Sys.getenv_opt "HOME"
+    |> Option.to_result ~none:(`Missing_env_var "HOME")
+    |> Result.map (fun home -> Filename.of_parts [ home; ".cache"; "spin" ])
   | _ ->
-    Sys.getenv "APPDATA"
-    |> Result.of_option ~error:(`Missing_env_var "APPDATA")
-    |> Result.map ~f:(fun home -> Filename.of_parts [ home; "spin"; "cache" ])
+    Sys.getenv_opt "APPDATA"
+    |> Option.to_result ~none:(`Missing_env_var "APPDATA")
+    |> Result.map (fun home -> Filename.of_parts [ home; "spin"; "cache" ])
 
 let default_config_dir =
   match Sys.os_type with
   | "Unix" ->
-    Sys.getenv "HOME"
-    |> Result.of_option ~error:(`Missing_env_var "HOME")
-    |> Result.map ~f:(fun home -> Filename.of_parts [ home; ".config"; "spin" ])
+    Sys.getenv_opt "HOME"
+    |> Option.to_result ~none:(`Missing_env_var "HOME")
+    |> Result.map (fun home -> Filename.of_parts [ home; ".config"; "spin" ])
   | _ ->
-    Sys.getenv "APPDATA"
-    |> Result.of_option ~error:(`Missing_env_var "APPDATA")
-    |> Result.map ~f:(fun home -> Filename.of_parts [ home; "spin"; "config" ])
+    Sys.getenv_opt "APPDATA"
+    |> Option.to_result ~none:(`Missing_env_var "APPDATA")
+    |> Result.map (fun home -> Filename.of_parts [ home; "spin"; "config" ])
 
 let spin_cache_dir =
-  Sys.getenv "SPIN_CACHE_DIR"
-  |> Option.map ~f:Result.return
+  Sys.getenv_opt "SPIN_CACHE_DIR"
+  |> Option.map Result.ok
   |> Option.value ~default:default_cache_dir
 
 let spin_config_dir =
-  Sys.getenv "SPIN_CONFIG_DIR"
-  |> Option.map ~f:Result.return
+  Sys.getenv_opt "SPIN_CONFIG_DIR"
+  |> Option.map Result.ok
   |> Option.value ~default:default_config_dir