Global per-project configuration of autocomplete (#7330)

* sketch out global completion config setup * Update json schema * Read autocompleteConfig from rescript.json * update emitted output * test output * Remove hardcoded 'array' from config schema and document autocomplete * autocompleteConfig --> autocomplete --------- Co-authored-by: Florian Hammerschmidt <fh@cca.io>

Author: zth

analysis/src/CompletionBackEnd.ml

@@ -1135,6 +1135,25 @@ and getCompletionsForContextPath ~debug ~full ~opens ~rawOpens ~pos ~env ~exact
  | _ -> false
  else true)
  in
+
+ let globallyConfiguredCompletionsForType =
+ match package.autocomplete |> Misc.StringMap.find_opt mainTypeId with
+ | None -> []
+ | Some completionPaths ->
+ completionPaths |> List.map (fun p -> String.split_on_char '.' p)
+ in
+
+ let globallyConfiguredCompletions =
+ globallyConfiguredCompletionsForType
+ |> List.map (fun completionPath ->
+ completionsForPipeFromCompletionPath ~envCompletionIsMadeFrom
+ ~opens ~pos ~scope ~debug ~prefix ~env ~rawOpens ~full
+ completionPath)
+ |> List.flatten
+ |> TypeUtils.filterPipeableFunctions ~synthetic:true ~env ~full
+ ~targetTypeId:mainTypeId
+ in
+
  (* Extra completions can be drawn from the @editor.completeFrom attribute. Here we
  find and add those completions as well. *)
  let extraCompletions =
@@ -1154,7 +1173,8 @@ and getCompletionsForContextPath ~debug ~full ~opens ~rawOpens ~pos ~env ~exact
  ~full ~rawOpens typ
  else []
  in
- jsxCompletions @ pipeCompletions @ extraCompletions))
+ jsxCompletions @ pipeCompletions @ extraCompletions
+ @ globallyConfiguredCompletions))
  | CTuple ctxPaths ->
  if Debug.verbose () then print_endline "[ctx_path]--> CTuple";
  (* Turn a list of context paths into a list of type expressions. *)

analysis/src/Packages.ml

@@ -66,6 +66,28 @@ let newBsPackage ~rootPath =
  | _ -> None)
  | None -> None
  in
+ let autocomplete =
+ match config |> Json.get "editor" with
+ | Some editorConfig -> (
+ match editorConfig |> Json.get "autocomplete" with
+ | Some (Object map) ->
+ map
+ |> List.fold_left
+ (fun acc (key, value) ->
+ match value with
+ | Json.Array items ->
+ let values =
+ items
+ |> List.filter_map (function
+ | Json.String s -> Some s
+ | _ -> None)
+ in
+ Misc.StringMap.add key values acc
+ | _ -> acc)
+ Misc.StringMap.empty
+ | _ -> Misc.StringMap.empty)
+ | None -> Misc.StringMap.empty
+ in
  let uncurried = uncurried = Some true in
  match libBs with
  | None -> None
@@ -158,6 +180,7 @@ let newBsPackage ~rootPath =
  opens;
  namespace;
  uncurried;
+ autocomplete;
  }))
  | None -> None
  in

analysis/src/SharedTypes.ml

@@ -494,6 +494,7 @@ type package = {
  opens: path list;
  uncurried: bool;
  rescriptVersion: int * int;
+ autocomplete: file list Misc.StringMap.t;
 }
 
 let allFilesInPackage package =

docs/docson/build-schema.json

@@ -349,6 +349,24 @@
  "description": "(Not implemented yet)"
  }
  ]
+ },
+ "editor": {
+ "type": "object",
+ "properties": {
+ "autocomplete": {
+ "type": "object",
+ "description": "A mapping to extend the autocompletion for a given type with an array of modules. E.g. `{ \"int\": [\"IntUtils\", \"IntExt\"] }` will extend the autocompletion of the `int` type with the values from `IntUtils` and `IntExt` modules.",
+ "patternProperties": {
+ "^[a-zA-Z0-9_.]+$": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "additionalProperties": false
  }
  },
  "title": "ReScript build configuration",
@@ -472,6 +490,10 @@
  "reanalyze": {
  "$ref": "#/definitions/reanalyze",
  "description": "Configure reanalyze, a static code analysis tool for ReScript."
+ },
+ "editor": {
+ "$ref": "#/definitions/editor",
+ "description": "Configure editor functionality, like modules that should be included in autocompletions for given (built-in) types."
  }
  },
  "additionalProperties": false,

tests/analysis_tests/tests/rescript.json

@@ -12,5 +12,11 @@
  "bsc-flags": ["-w -33-44-8"],
  "bs-dependencies": ["@rescript/react"],
  "jsx": { "version": 4 },
- "suffix": ".res.js"
+ "suffix": ".res.js",
+ "editor": {
+ "autocomplete": {
+ "array": ["ArrayUtils"],
+ "Fastify.t": ["FastifyExt"]
+ }
+ }
 }

tests/analysis_tests/tests/src/ArrayUtils.res

@@ -0,0 +1 @@
+let empty = arr => Array.length(arr) === 0

tests/analysis_tests/tests/src/CompletionConfiguredBuiltins.res

@@ -0,0 +1,9 @@
+let x = [1, 2, 3]
+
+// x->em
+// ^com
+
+external fastify: Fastify.t = "fastify"
+
+// fastify->doSt
+// ^com

tests/analysis_tests/tests/src/Fastify.res

@@ -0,0 +1 @@
+type t

tests/analysis_tests/tests/src/FastifyExt.res

@@ -0,0 +1 @@
+let doStuff = (t: Fastify.t) => Console.log(t)