Merge pull request #167 from nberth/using-vscode-provided-storage

Optionally pass a `--storage-directory` argument to the LSP server

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [0.1.4] Next release
 
 ### Added
+- Configuration flag for caching in storage provided by Visual Studio Code [#167](https://github.com/OCamlPro/superbol-studio-oss/pull/167)
 - Configuration setting for copybook filename extensions [#332](https://github.com/OCamlPro/superbol-studio-oss/pull/332), with updated JSON schema [#333](https://github.com/OCamlPro/superbol-studio-oss/pull/333)
 - COBOL language configuration for highlighting matching brackets and auto-insertion of line numbers in fixed-format code [#330](https://github.com/OCamlPro/superbol-studio-oss/pull/330)
 

src/lsp/superbol_free_lib/vscode_extension.ml

@@ -343,7 +343,7 @@ let contributes =
                (with_superbol_toml_note
                   "File extensions for copybook resolution")
              ~default:Cobol_common.Copybook.copybook_extensions
-             ~order:1;
+             ~order:4;
 
            (* Paths *)
 
@@ -373,6 +373,16 @@ let contributes =
                 ``COBOL85``."
              ~order:21;
 
+           Manifest.PROPERTY.bool "superbol.cacheInGlobalStorage"
+             ~default:false
+             ~markdownDescription:
+               "Use storage provided by Visual Studio Code for caching.  When \
+                this setting is set to *false*, the cache related to the \
+                contents of a given workspace folder *f* is stored in a file \
+                named *f*`/_superbol/lsp-cache`.\n\nNote: cache files are not \
+                removed automatically, whatever their location."
+             ~order:22;
+
            (* Debugger-specific: *)
 
            Manifest.PROPERTY.bool

src/vscode/superbol-vscode-platform/superbol_languageclient.ml

@@ -49,7 +49,15 @@ let find_superbol root =
 
 
 let server_options ~context =
-  let root_uri = Vscode.ExtensionContext.extensionUri context in
+  let root_uri = Vscode.ExtensionContext.extensionUri context
+  and storage_uri =
+    (* Use the global state URI as the server stores caches on a per-project
+       basis (ie. for each workspace directory), not on a per-workspace
+       basis. *)
+    if Superbol_workspace.bool "cacheInGlobalStorage"
+    then Some (Vscode.ExtensionContext.globalStorageUri context)
+    else None
+  in
   let command =
     match Superbol_workspace.superbol_exe () with
     | Some cmd ->
@@ -72,7 +80,10 @@ let server_options ~context =
   let args =
     let force_diagnostics = Superbol_workspace.bool "forceSyntaxDiagnostics" in
     "lsp" ::
-    if force_diagnostics then ["--force-syntax-diagnostics"] else []
+    (if force_diagnostics then ["--force-syntax-diagnostics"] else []) @
+    (match storage_uri with
+     | None -> []
+     | Some uri -> ["--storage-directory"; Vscode.Uri.fsPath uri])
   in
   LSP.ServerOptions.create ()
     ~options ~command ~args
@@ -93,3 +104,4 @@ let server_needs_restart_after ~config_change =
   in
   affects "superbol.lsp-path"         (* machine setting: no need for a scope *)
   || affects "superbol.forceSyntaxDiagnostics"                       (* scope? *)
+  || affects "superbol.cacheInGlobalStorage"