Highlight current switch (ocamllabs#751)

- The currently active OPAM switch in the workspace folder (project root) is shown first in the list of sandboxes when selecting a sandbox. (ocamllabs#751) - Show a different icon for the currently active OPAM switch in the "OPAM Switches" tree view (ocamllabs#751) Signed-off-by: Paul-Elliot <[email protected]> Co-authored-by: Ulugbek Abdullaev <[email protected]>
tatchi · Oct 30, 2021 · 2ea1992 · 2ea1992
1 parent 6862f23
commit 2ea1992
Show file tree

Hide file tree

Showing 9 changed files with 102 additions and 22 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,6 +1,7 @@
 # Change Log
 
 ## Unreleased
+
 - Highlighted the UNREACHABLE element in cram .t files (#754)
 
 - Activate extension on cram files, or when the workspace contains
@@ -41,6 +42,12 @@
   launch a terminal within a certain sandbox set in the extension (#744, fixes
   #655)
 
+- The currently active OPAM switch in the workspace folder (project root) is
+  shown first in the list of sandboxes when selecting a sandbox. (#751)
+
+- Show a different icon for the currently active OPAM switch in the "OPAM
+  Switches" tree view (#751)
+
 ## 1.8.4
 
 - Fix inclusion of files in extension package

diff --git a/assets/dependency-dark-selected.svg b/assets/dependency-dark-selected.svg
diff --git a/assets/dependency-light-selected.svg b/assets/dependency-light-selected.svg
diff --git a/src/extension_commands.ml b/src/extension_commands.ml
@@ -47,7 +47,7 @@ let _select_sandbox =
       | None (* sandbox selection cancelled *) -> Promise.return ()
       | Some new_sandbox ->
         Extension_instance.set_sandbox instance new_sandbox;
-        let (_ : unit Promise.t) = Sandbox.save_to_settings new_sandbox in
+        let* () = Sandbox.save_to_settings new_sandbox in
         Extension_instance.start_language_server instance
     in
     ()

diff --git a/src/extension_instance.ml b/src/extension_instance.ml
@@ -139,6 +139,9 @@ let set_sandbox t new_sandbox =
   let (_ : Ojs.t option Promise.t) =
     Vscode.Commands.executeCommand
       ~command:Extension_consts.Commands.refresh_sandbox ~args:[]
+  and (_ : Ojs.t option Promise.t) =
+    Vscode.Commands.executeCommand
+      ~command:Extension_consts.Commands.refresh_switches ~args:[]
   in
   ()
 

diff --git a/src/sandbox.ml b/src/sandbox.ml
@@ -229,6 +229,8 @@ let of_settings () : t option Promise.t =
   | Some Global -> Promise.return (Some Global)
   | Some (Custom template) -> Promise.return (Some (Custom template))
 
+(** If [Workspace.workspaceFolders()] returns a list with a single element,
+    returns it; otherwise, returns [None]. *)
 let workspace_root () =
   match Workspace.workspaceFolders () with
   | [] -> None
@@ -305,17 +307,27 @@ module Candidate = struct
     ; status : (unit, string) result
     }
 
-  let to_quick_pick { sandbox; status } =
+  let to_quick_pick current_switch { sandbox; status } =
     let create = QuickPickItem.create in
     let description =
       match status with
       | Error s -> Some (Printf.sprintf "Invalid sandbox: %s" s)
       | Ok () -> (
         match sandbox with
-        | Opam (_, Local _) -> Some "Local switch"
-        | Opam (_, Named _) -> Some "Global switch"
-        | Esy _ -> Some "Esy"
-        | _ -> None)
+        | Opam (_, switch) ->
+          let switch_kind_s =
+            match switch with
+            | Local _ -> "Local switch"
+            | Named _ -> "Global switch"
+          in
+          if Option.exists current_switch ~f:(Opam.Switch.equal switch) then
+            Some (switch_kind_s ^ " | Currently active switch in project root")
+          else
+            Some switch_kind_s
+        | Esy (_, _) -> Some "Esy"
+        | Global
+        | Custom _ ->
+          None)
     in
     match sandbox with
     | Opam (_, Named name) -> create ~label:name ?description ()
@@ -342,10 +354,17 @@ let select_sandbox (choices : Candidate.t list) =
   let placeHolder =
     "Which package manager would you like to manage the sandbox?"
   in
+  let open Promise.Syntax in
+  let* current_switch =
+    let open Promise.Option.Syntax in
+    let* opam = Opam.make () in
+    let* cwd = workspace_root () |> Promise.return in
+    Opam.switch_show ~cwd opam
+  in
   let choices =
     List.map
       ~f:(fun (sandbox : Candidate.t) ->
-        let quick_pick = Candidate.to_quick_pick sandbox in
+        let quick_pick = Candidate.to_quick_pick current_switch sandbox in
         (quick_pick, sandbox))
       choices
   in
@@ -376,12 +395,36 @@ let sandbox_candidates ~workspace_folders =
   let opam =
     let* opam = available.opam in
     match opam with
-    | None -> Promise.return []
-    | Some opam ->
+    | None -> Promise.return ([], None)
+    | Some opam -> (
+      let* current_switch =
+        match workspace_root () with
+        | None -> Promise.return None
+        | Some cwd -> Opam.switch_show ~cwd opam
+      in
       let+ switches = Opam.switch_list opam in
-      List.map switches ~f:(fun sw ->
+      match current_switch with
+      | None ->
+        let switches =
+          List.map switches ~f:(fun sw ->
+              let sandbox = Opam (opam, sw) in
+              { Candidate.sandbox; status = Ok () })
+        in
+        (switches, None)
+      | Some current_switch ->
+        let f sw =
           let sandbox = Opam (opam, sw) in
-          { Candidate.sandbox; status = Ok () })
+          if Opam.Switch.equal current_switch sw then
+            None
+          else
+            Some { Candidate.sandbox; status = Ok () }
+        in
+        let sandboxes = List.filter_map switches ~f
+        and current_switch_sandbox =
+          let sandbox = Opam (opam, current_switch) in
+          Some { Candidate.sandbox; status = Ok () }
+        in
+        (sandboxes, current_switch_sandbox))
   in
   let global = Candidate.ok Global in
   let custom =
@@ -390,8 +433,10 @@ let sandbox_candidates ~workspace_folders =
        custom commands in [select] *)
   in
 
-  let+ esy, opam = Promise.all2 (esy, opam) in
-  (global :: custom :: esy) @ opam
+  let+ esy, (opam, current_switch) = Promise.all2 (esy, opam) in
+  let cs = (global :: custom :: esy) @ opam in
+  Option.value_map current_switch ~default:cs ~f:(fun current_switch ->
+      current_switch :: cs)
 
 let select_sandbox () =
   let open Promise.Syntax in

diff --git a/src/treeview_switches.ml b/src/treeview_switches.ml
@@ -5,6 +5,12 @@ module Dependency = struct
     | Package : Opam.Package.t -> t
     | Switch : Opam.t * Opam.Switch.t -> t
 
+  let equals_opam_sandbox t sandbox =
+    match (t, sandbox) with
+    | Switch (opam, switch), Sandbox.Opam (opam_, switch_) ->
+      Opam.equal opam opam_ && Opam.Switch.equal switch switch_
+    | _ -> false
+
   let t_of_js : Ojs.t -> t = Stdlib.Obj.magic
 
   let t_to_js : t -> Ojs.t = Stdlib.Obj.magic
@@ -32,11 +38,24 @@ module Dependency = struct
       | Some _ -> "package-with-doc"
       | None -> "package")
 
-  let icon = function
+  let icon dependency is_current_sandbox =
+    match dependency with
     | Switch _ ->
+      let selected =
+        if is_current_sandbox then
+          "-selected"
+        else
+          ""
+      in
       TreeItem.LightDarkIcon.
-        { light = `String (Path.asset "dependency-light.svg" |> Path.to_string)
-        ; dark = `String (Path.asset "dependency-dark.svg" |> Path.to_string)
+        { light =
+            `String
+              (Path.asset @@ "dependency-light" ^ selected ^ ".svg"
+              |> Path.to_string)
+        ; dark =
+            `String
+              (Path.asset @@ "dependency-dark" ^ selected ^ ".svg"
+              |> Path.to_string)
         }
     | Package _ ->
       TreeItem.LightDarkIcon.
@@ -52,9 +71,11 @@ module Dependency = struct
       else
         TreeItemCollapsibleState.None
 
-  let to_treeitem dependency =
+  let to_treeitem instance dependency =
     let open Promise.Syntax in
-    let icon = `LightDark (icon dependency) in
+    let current_sandbox = Extension_instance.sandbox instance in
+    let is_current_sandbox = equals_opam_sandbox dependency current_sandbox in
+    let icon = `LightDark (icon dependency is_current_sandbox) in
     let collapsibleState = collapsible_state dependency in
     let label =
       `TreeItemLabel (Vscode.TreeItemLabel.create ~label:(label dependency) ())
@@ -155,7 +176,8 @@ module Command = struct
       ~id:Extension_consts.Commands.open_switches_documentation handler
 end
 
-let getTreeItem ~element = `Promise (Dependency.to_treeitem element)
+let getTreeItem instance ~element =
+  `Promise (Dependency.to_treeitem instance element)
 
 let getChildren ?opam ?element () =
   match (opam, element) with
@@ -172,11 +194,12 @@ let getChildren ?opam ?element () =
     in
     `Promise items
 
-let register extension =
+let register extension instance =
   let (_ : unit Promise.t) =
     let open Promise.Syntax in
     let+ opam = Opam.make () in
     let getChildren = getChildren ?opam in
+    let getTreeItem = getTreeItem instance in
     let module EventEmitter =
       Vscode.EventEmitter.Make (Interop.Js.Or_undefined (Dependency)) in
     let event_emitter = EventEmitter.make () in

diff --git a/src/treeview_switches.mli b/src/treeview_switches.mli
@@ -1,2 +1,2 @@
 (** Register the ocaml-switches tree view *)
-val register : Vscode.ExtensionContext.t -> unit
+val register : Vscode.ExtensionContext.t -> Extension_instance.t -> unit
diff --git a/src/vscode_ocaml_platform.ml b/src/vscode_ocaml_platform.ml
@@ -30,7 +30,7 @@ let activate (extension : ExtensionContext.t) =
   Dune_formatter.register extension instance;
   Dune_task_provider.register extension instance;
   Extension_commands.register_all_commands extension instance;
-  Treeview_switches.register extension;
+  Treeview_switches.register extension instance;
   Treeview_sandbox.register extension instance;
   Treeview_commands.register extension;
   Treeview_help.register extension;