analysis refactor: remove global state Shared_types.state (#8465)

* analysis refactor: remove global state `Shared_types.state`

* remove state from package type

* remove unused `state` param

* rename `re_script` to `rescript`

* Update CHANGELOG.md

Author: aspeddro

CHANGELOG.md

@@ -60,6 +60,7 @@
 - Catalog every named compiler error variant in `tests/ERROR_VARIANTS.md` and add fixtures for the remaining reachable ones. https://github.com/rescript-lang/rescript/pull/8446
 - Remove dead and unreachable compiler error and warning variants; add fixtures for the ones found to be reachable. https://github.com/rescript-lang/rescript/pull/8459
 - Convert OCaml codebase to snake case format. https://github.com/rescript-lang/rescript/pull/8456
+- Analysis refactor: remove global state `Shared_types.state`. https://github.com/rescript-lang/rescript/pull/8465
 
 
 # 13.0.0-alpha.4

analysis/bin/main.ml

@@ -92,6 +92,7 @@ Options:
 |}
 
 let main () =
+  let state = Shared_types.create_state () in
   let args = Array.to_list Sys.argv in
   let debug_level, args =
     match args with
@@ -118,7 +119,7 @@ let main () =
   | [_; "cache-project"; root_path] -> (
     Cfg.read_project_config_cache := false;
     let uri = Uri.from_path root_path in
-    match Packages.get_package ~uri with
+    match Packages.get_package ~state ~uri with
     | Some package -> Cache.cache_project package
     | None -> print_endline "\"ERR\"")
   | [_; "cache-delete"; root_path] -> (
@@ -136,18 +137,20 @@ let main () =
     print_header_info path line col;
     Cli.completion ~debug ~path
       ~pos:(int_of_string line, int_of_string col)
-      ~current_file
+      ~current_file ~state
   | [_; "completionResolve"; path; module_path] ->
-    Cli.completion_resolve ~path ~module_path
+    Cli.completion_resolve ~state ~path ~module_path
   | [_; "definition"; path; line; col] ->
-    Cli.definition ~path ~pos:(int_of_string line, int_of_string col) ~debug
+    Cli.definition ~state ~path
+      ~pos:(int_of_string line, int_of_string col)
+      ~debug
   | [_; "typeDefinition"; path; line; col] ->
-    Cli.type_definition ~path
+    Cli.type_definition ~state ~path
       ~pos:(int_of_string line, int_of_string col)
       ~debug
   | [_; "documentSymbol"; path] -> Document_symbol.command ~path
   | [_; "hover"; path; line; col; current_file; supports_markdown_links] ->
-    Cli.hover ~path
+    Cli.hover ~state ~path
       ~pos:(int_of_string line, int_of_string col)
       ~current_file ~debug
       ~supports_markdown_links:
@@ -163,22 +166,22 @@ let main () =
    current_file;
    allow_for_constructor_payloads;
   ] ->
-    Cli.signature_help ~path
+    Cli.signature_help ~state ~path
       ~pos:(int_of_string line, int_of_string col)
       ~current_file ~debug
       ~allow_for_constructor_payloads:
         (match allow_for_constructor_payloads with
         | "true" -> true
         | _ -> false)
   | [_; "inlayHint"; path; line_start; line_end; max_length] ->
-    Cli.inlayhint ~path
+    Cli.inlayhint ~state ~path
       ~pos:(int_of_string line_start, int_of_string line_end)
       ~max_length ~debug
-  | [_; "codeLens"; path] -> Cli.code_lens ~path ~debug
+  | [_; "codeLens"; path] -> Cli.code_lens ~state ~path ~debug
   | [
    _; "codeAction"; path; start_line; start_col; end_line; end_col; current_file;
   ] ->
-    Cli.code_action ~path
+    Cli.code_action ~state ~path
       ~start_pos:(int_of_string start_line, int_of_string start_col)
       ~end_pos:(int_of_string end_line, int_of_string end_col)
       ~current_file ~debug
@@ -197,23 +200,27 @@ let main () =
     |> print_endline
   | [_; "diagnosticSyntax"; path] -> Cli.diagnostic_syntax ~path
   | [_; "references"; path; line; col] ->
-    Cli.references ~path ~pos:(int_of_string line, int_of_string col) ~debug
+    Cli.references ~state ~path
+      ~pos:(int_of_string line, int_of_string col)
+      ~debug
   | [_; "prepareRename"; path; line; col] ->
-    Cli.prepare_rename ~path ~pos:(int_of_string line, int_of_string col) ~debug
+    Cli.prepare_rename ~state ~path
+      ~pos:(int_of_string line, int_of_string col)
+      ~debug
   | [_; "rename"; path; line; col; new_name] ->
-    Cli.rename ~path
+    Cli.rename ~state ~path
       ~pos:(int_of_string line, int_of_string col)
       ~new_name ~debug
   | [_; "semanticTokens"; current_file] ->
     Cli.semantic_tokens ~path:current_file
   | [_; "createInterface"; path; cmi_file] ->
-    `String (Create_interface.command ~path ~cmi_file)
+    `String (Create_interface.command ~state ~path ~cmi_file)
     |> Yojson.Safe.pretty_to_string ~std:true
     |> print_endline
   | [_; "format"; path] -> Cli.format ~path
-  | [_; "test"; path] -> Cli.test ~path
+  | [_; "test"; path] -> Cli.test ~state ~path
   | [_; "cmt"; rescript_json; cmt_path] ->
-    Cmt_viewer.dump rescript_json cmt_path
+    Cmt_viewer.dump ~state rescript_json cmt_path
   | args when List.mem "-h" args || List.mem "--help" args -> prerr_endline help
   | _ ->
     prerr_endline help;

analysis/reanalyze/src/paths.ml

@@ -35,7 +35,7 @@ let set_project_root_from_cwd () =
     | None -> run_config.project_root
     | Some s -> s)
 
-let set_re_script_project_root = lazy (set_project_root_from_cwd ())
+let set_rescript_project_root = lazy (set_project_root_from_cwd ())
 
 module Config = struct
   let read_suppress conf =

analysis/reanalyze/src/reanalyze.ml

@@ -102,7 +102,7 @@ let collect_cmt_file_paths ~cmt_root : string list =
     in
     walk_sub_dirs ""
   | None ->
-    Lazy.force Paths.set_re_script_project_root;
+    Lazy.force Paths.set_rescript_project_root;
     (* Prefer explicit scan plan emitted by rewatch (v2 `.sourcedirs.json`).
        This supports monorepos without reanalyze-side package resolution. *)
     let scan_plan = Paths.read_cmt_scan () in

analysis/src/cli.ml

@@ -3,37 +3,39 @@ let print_string json =
 let print_null () = `Null |> print_string
 let print_list l = `List l |> print_string
 
-let completion ~debug ~path ~pos ~current_file =
-  let full = Cmt.load_full_cmt_from_path ~path in
+let completion ~state ~debug ~path ~pos ~current_file =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
   let kind_file = Files.classify_source_file current_file in
   match Files.read_file current_file with
   | None | Some "" -> print_null ()
   | Some source ->
-    Commands.completion ~debug ~source ~kind_file ~pos ~full
+    Commands.completion ~state ~debug ~source ~kind_file ~pos ~full
     |> List.map (fun c -> Lsp.Types.CompletionItem.yojson_of_t c)
     |> print_list
 
-let completion_resolve ~path ~module_path =
-  let full = Cmt.load_full_cmt_from_path ~path in
-  match Commands.completion_resolve ~full ~module_path with
+let completion_resolve ~state ~path ~module_path =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
+  match Commands.completion_resolve ~state ~full ~module_path with
   | None -> print_null ()
   | Some (`MarkupContent {value}) -> `String value |> print_string
 
-let inlayhint ~path ~pos ~max_length ~debug =
-  let full = Cmt.load_full_cmt_from_path ~path in
+let inlayhint ~state ~path ~pos ~max_length ~debug =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
   let kind_file = Files.classify_source_file path in
   match Files.read_file path with
   | None -> print_null ()
   | Some source -> (
-    match Hint.inlay ~source ~kind_file ~pos ~max_length ~full ~debug with
+    match
+      Hint.inlay ~source ~kind_file ~pos ~max_length ~full ~state ~debug
+    with
     | Some hints ->
       hints
       |> List.map (fun h -> Lsp.Types.InlayHint.yojson_of_t h)
       |> print_list
     | None -> print_null ())
 
-let code_lens ~path ~debug =
-  let full = Cmt.load_full_cmt_from_path ~path in
+let code_lens ~state ~path ~debug =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
   let kind_file = Files.classify_source_file path in
   match Files.read_file path with
   | None -> print_null ()
@@ -43,68 +45,68 @@ let code_lens ~path ~debug =
       lens |> List.map (fun l -> Lsp.Types.CodeLens.yojson_of_t l) |> print_list
     | None -> print_null ())
 
-let hover ~path ~pos ~current_file ~debug ~supports_markdown_links =
-  let full = Cmt.load_full_cmt_from_path ~path in
+let hover ~state ~path ~pos ~current_file ~debug ~supports_markdown_links =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
   let kind_file = Files.classify_source_file current_file in
   match Files.read_file current_file with
   | None -> print_null ()
   | Some source -> (
     match
       Commands.hover ~source ~kind_file ~pos ~debug ~supports_markdown_links
-        ~full
+        ~state ~full
     with
     | Some value -> Lsp.Types.Hover.yojson_of_t value |> print_string
     | None -> print_null ())
 
-let signature_help ~path ~pos ~current_file ~debug
+let signature_help ~state ~path ~pos ~current_file ~debug
     ~allow_for_constructor_payloads =
-  let full = Cmt.load_full_cmt_from_path ~path in
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
   let kind_file = Files.classify_source_file current_file in
   match Files.read_file current_file with
   | None -> print_null ()
   | Some source -> (
     match
-      Signature_help.signature_help ~source ~kind_file ~pos
-        ~allow_for_constructor_payloads ~full ~debug
+      Commands.signature_help ~source ~kind_file ~pos
+        ~allow_for_constructor_payloads ~full ~state ~debug
     with
     | None -> print_null ()
     | Some s -> Lsp.Types.SignatureHelp.yojson_of_t s |> print_string)
 
-let code_action ~path ~start_pos ~end_pos ~current_file ~debug =
+let code_action ~state ~path ~start_pos ~end_pos ~current_file ~debug =
   let kind_file = Files.classify_source_file current_file in
   match Files.read_file current_file with
   | None -> print_null ()
   | Some source ->
-    Xform.extract_code_actions ~path ~start_pos ~end_pos ~source ~kind_file
-      ~debug
+    Xform.extract_code_actions ~state ~path ~start_pos ~end_pos ~source
+      ~kind_file ~debug
     |> List.map (fun c -> Lsp.Types.CodeAction.yojson_of_t c)
     |> print_list
 
-let definition ~path ~pos ~debug =
-  let full = Cmt.load_full_cmt_from_path ~path in
+let definition ~state ~path ~pos ~debug =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
 
-  match Commands.definition ~full ~pos ~debug with
+  match Commands.definition ~state ~full ~pos ~debug with
   | None -> print_null ()
   | Some location -> location |> Lsp.Types.Location.yojson_of_t |> print_string
 
-let type_definition ~path ~pos ~debug =
-  let full = Cmt.load_full_cmt_from_path ~path in
-  match Commands.type_definition ~full ~pos ~debug with
+let type_definition ~state ~path ~pos ~debug =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
+  match Commands.type_definition ~state ~full ~pos ~debug with
   | None -> print_null ()
   | Some location -> location |> Lsp.Types.Location.yojson_of_t |> print_string
 
-let references ~path ~pos ~debug =
-  let full = Cmt.load_full_cmt_from_path ~path in
-  let all_locs = Commands.references ~full ~pos ~debug in
+let references ~state ~path ~pos ~debug =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
+  let all_locs = Commands.references ~state ~full ~pos ~debug in
   if all_locs = [] then print_null ()
   else
     all_locs
     |> List.map (fun l -> Lsp.Types.Location.yojson_of_t l)
     |> print_list
 
-let rename ~path ~pos ~new_name ~debug =
-  let full = Cmt.load_full_cmt_from_path ~path in
-  match Commands.rename ~full ~pos ~new_name ~debug with
+let rename ~state ~path ~pos ~new_name ~debug =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
+  match Commands.rename ~state ~full ~pos ~new_name ~debug with
   | Some {documentChanges = Some document_changes} ->
     document_changes
     |> List.map (fun c ->
@@ -116,8 +118,8 @@ let rename ~path ~pos ~new_name ~debug =
     |> print_list
   | _ -> print_null ()
 
-let prepare_rename ~path ~pos ~debug =
-  let full = Cmt.load_full_cmt_from_path ~path in
+let prepare_rename ~state ~path ~pos ~debug =
+  let full = Cmt.load_full_cmt_from_path ~state ~path in
   match Commands.prepare_rename ~full ~pos ~debug with
   | None -> print_null ()
   | Some {range; placeholder = None} ->
@@ -159,7 +161,7 @@ let semantic_tokens ~path =
     let tokens = Semantic_tokens.semantic_tokens ~source ~kind_file in
     Lsp.Types.SemanticTokens.yojson_of_t tokens |> print_string
 
-let test ~path =
+let test ~state ~path =
   Uri.strip_path := true;
   match Files.read_file path with
   | None -> assert false
@@ -224,19 +226,19 @@ let test ~path =
             print_endline
               ("Definition " ^ path ^ " " ^ string_of_int line ^ ":"
              ^ string_of_int col);
-            definition ~path ~pos:(line, col) ~debug:true
+            definition ~state ~path ~pos:(line, col) ~debug:true
           | "com" ->
             print_endline
               ("Complete " ^ path ^ " " ^ string_of_int line ^ ":"
              ^ string_of_int col);
             let current_file = create_current_file () in
-            completion ~debug:true ~path ~pos:(line, col) ~current_file;
+            completion ~state ~debug:true ~path ~pos:(line, col) ~current_file;
             Sys.remove current_file
           | "cre" ->
             let module_path = String.sub rest 3 (String.length rest - 3) in
             let module_path = String.trim module_path in
             print_endline ("Completion resolve: " ^ module_path);
-            completion_resolve ~path ~module_path
+            completion_resolve ~state ~path ~module_path
           | "dce" ->
             print_endline ("DCE " ^ path);
             Reanalyze.Run_config.run_config.suppress <- ["src"];
@@ -259,16 +261,16 @@ let test ~path =
               ("Hover " ^ path ^ " " ^ string_of_int line ^ ":"
              ^ string_of_int col);
             let current_file = create_current_file () in
-            hover ~supports_markdown_links:true ~path ~pos:(line, col)
+            hover ~state ~supports_markdown_links:true ~path ~pos:(line, col)
               ~current_file ~debug:true;
             Sys.remove current_file
           | "she" ->
             print_endline
               ("Signature help " ^ path ^ " " ^ string_of_int line ^ ":"
              ^ string_of_int col);
             let current_file = create_current_file () in
-            signature_help ~path ~pos:(line, col) ~current_file ~debug:true
-              ~allow_for_constructor_payloads:true;
+            signature_help ~state ~path ~pos:(line, col) ~current_file
+              ~debug:true ~allow_for_constructor_payloads:true;
             Sys.remove current_file
           | "int" ->
             print_endline ("Create Interface " ^ path);
@@ -279,30 +281,30 @@ let test ~path =
               let dir = dirname path in
               dir ++ parent_dir_name ++ "lib" ++ "bs" ++ "src" ++ name
             in
-            Printf.printf "%s" (Create_interface.command ~path ~cmi_file)
+            Printf.printf "%s" (Create_interface.command ~state ~path ~cmi_file)
           | "ref" ->
             print_endline
               ("References " ^ path ^ " " ^ string_of_int line ^ ":"
              ^ string_of_int col);
-            references ~path ~pos:(line, col) ~debug:true
+            references ~state ~path ~pos:(line, col) ~debug:true
           | "pre" ->
             print_endline
               ("PrepareRename " ^ path ^ " " ^ string_of_int line ^ ":"
              ^ string_of_int col);
-            prepare_rename ~path ~pos:(line, col) ~debug:true
+            prepare_rename ~state ~path ~pos:(line, col) ~debug:true
           | "ren" ->
             let new_name = String.sub rest 4 (len - mlen - 4) in
             let () =
               print_endline
                 ("Rename " ^ path ^ " " ^ string_of_int line ^ ":"
                ^ string_of_int col ^ " " ^ new_name)
             in
-            rename ~path ~pos:(line, col) ~new_name ~debug:true
+            rename ~state ~path ~pos:(line, col) ~new_name ~debug:true
           | "typ" ->
             print_endline
               ("TypeDefinition " ^ path ^ " " ^ string_of_int line ^ ":"
              ^ string_of_int col);
-            type_definition ~path ~pos:(line, col) ~debug:true
+            type_definition ~state ~path ~pos:(line, col) ~debug:true
           | "xfm" ->
             let current_file = create_current_file () in
             (* +2 is to ensure that the character ^ points to is what's considered the end of the selection. *)
@@ -323,8 +325,8 @@ let test ~path =
             in
             let kind_file = Files.classify_source_file current_file in
             let code_actions =
-              Xform.extract_code_actions ~path ~start_pos ~end_pos ~source
-                ~kind_file ~debug:true
+              Xform.extract_code_actions ~state ~path ~start_pos ~end_pos
+                ~source ~kind_file ~debug:true
             in
             Sys.remove current_file;
             code_actions
@@ -402,11 +404,11 @@ let test ~path =
             print_endline
               ("Inlay Hint " ^ path ^ " " ^ string_of_int line_start ^ ":"
              ^ string_of_int line_end);
-            inlayhint ~path ~pos:(line_start, line_end) ~max_length:"25"
+            inlayhint ~state ~path ~pos:(line_start, line_end) ~max_length:"25"
               ~debug:false
           | "cle" ->
             print_endline ("Code Lens " ^ path);
-            code_lens ~path ~debug:false
+            code_lens ~state ~path ~debug:false
           | "ast" ->
             print_endline
               ("Dump AST " ^ path ^ " " ^ string_of_int line ^ ":"