[flow][paste-provider] Make Autofix_imports infra support more kinds …

…of imports Summary: This diff addresses some TODO in document_paste due to limitation of autofix_improts infra. This diff adds support for all kinds of imports, so that all the necessary imports can be inserted by document paste. Changelog: [internal] Reviewed By: gkz Differential Revision: D68133202 fbshipit-source-id: b7c914d69f9a671255bc7306721febacfc428f5d
facebook · Jan 15, 2025 · 34516b8 · 34516b8
1 parent eb74e13
commit 34516b8
Show file tree

Hide file tree

Showing 6 changed files with 161 additions and 19 deletions.
diff --git a/newtests/lsp/document_paste/__snapshots__/provide_for_full_data_transfer.json b/newtests/lsp/document_paste/__snapshots__/provide_for_full_data_transfer.json
@@ -3,6 +3,45 @@
   "result": {
     "changes": {
       "<PLACEHOLDER_PROJECT_URL>/__fixtures__/test.js": [
+        {
+          "range": {
+            "start": {
+              "line": 1,
+              "character": 0
+            },
+            "end": {
+              "line": 1,
+              "character": 0
+            }
+          },
+          "newText": "import typeof fooType from \"./import_source\";\n"
+        },
+        {
+          "range": {
+            "start": {
+              "line": 1,
+              "character": 0
+            },
+            "end": {
+              "line": 1,
+              "character": 0
+            }
+          },
+          "newText": "import typeof * as NST from \"./import_source\";\n"
+        },
+        {
+          "range": {
+            "start": {
+              "line": 1,
+              "character": 0
+            },
+            "end": {
+              "line": 1,
+              "character": 0
+            }
+          },
+          "newText": "import typeof { bar as barType } from \"./import_source\";\n"
+        },
         {
           "range": {
             "start": {

diff --git a/...sts/lsp/document_paste/__snapshots__/provide_for_full_data_transfer_with_deeper_path.json b/...sts/lsp/document_paste/__snapshots__/provide_for_full_data_transfer_with_deeper_path.json
@@ -3,6 +3,45 @@
   "result": {
     "changes": {
       "<PLACEHOLDER_PROJECT_URL>/__fixtures__/bar/test.js": [
+        {
+          "range": {
+            "start": {
+              "line": 1,
+              "character": 0
+            },
+            "end": {
+              "line": 1,
+              "character": 0
+            }
+          },
+          "newText": "import typeof fooType from \"../import_source\";\n"
+        },
+        {
+          "range": {
+            "start": {
+              "line": 1,
+              "character": 0
+            },
+            "end": {
+              "line": 1,
+              "character": 0
+            }
+          },
+          "newText": "import typeof * as NST from \"../import_source\";\n"
+        },
+        {
+          "range": {
+            "start": {
+              "line": 1,
+              "character": 0
+            },
+            "end": {
+              "line": 1,
+              "character": 0
+            }
+          },
+          "newText": "import typeof { bar as barType } from \"../import_source\";\n"
+        },
         {
           "range": {
             "start": {

diff --git a/...sp/document_paste/__snapshots__/provide_for_full_data_transfer_with_existing_binding.json b/...sp/document_paste/__snapshots__/provide_for_full_data_transfer_with_existing_binding.json
@@ -3,6 +3,45 @@
   "result": {
     "changes": {
       "<PLACEHOLDER_PROJECT_URL>/__fixtures__/test.js": [
+        {
+          "range": {
+            "start": {
+              "line": 1,
+              "character": 0
+            },
+            "end": {
+              "line": 1,
+              "character": 0
+            }
+          },
+          "newText": "import typeof fooType from \"./import_source\";\n"
+        },
+        {
+          "range": {
+            "start": {
+              "line": 1,
+              "character": 0
+            },
+            "end": {
+              "line": 1,
+              "character": 0
+            }
+          },
+          "newText": "import typeof * as NST from \"./import_source\";\n"
+        },
+        {
+          "range": {
+            "start": {
+              "line": 1,
+              "character": 0
+            },
+            "end": {
+              "line": 1,
+              "character": 0
+            }
+          },
+          "newText": "import typeof { bar as barType } from \"./import_source\";\n"
+        },
         {
           "range": {
             "start": {

diff --git a/src/services/code_action/autofix_imports.ml b/src/services/code_action/autofix_imports.ml
@@ -14,10 +14,13 @@ type named_binding = {
 
 type bindings =
   | DefaultType of string
+  | DefaultTypeof of string
   | Default of string
   | Named of named_binding list
   | NamedType of named_binding list
+  | NamedTypeof of named_binding list
   | Namespace of string
+  | TypeofNamespace of string
 
 type placement =
   | Above of { skip_line: bool }
@@ -122,33 +125,34 @@ let mk_named_import ?loc ?comments ~import_kind ~from names =
   in
   Statements.import_declaration ?loc ?comments import_kind source default specifiers
 
-let mk_namespace_import ?loc ?comments ~from name =
+let mk_namespace_import ?loc ?comments ~import_kind ~from name =
   let open Ast_builder in
   let source = (Loc.none, string_literal from) in
   let default = None in
   let specifiers =
     let id = Identifiers.identifier name in
     Some (Statement.ImportDeclaration.ImportNamespaceSpecifier (Loc.none, id))
   in
-  Statements.import_declaration
-    ?loc
-    ?comments
-    Statement.ImportDeclaration.ImportValue
-    source
-    default
-    specifiers
+  Statements.import_declaration ?loc ?comments import_kind source default specifiers
 
 let mk_import ~bindings ~from =
   match bindings with
   | DefaultType id_name ->
     mk_default_import ~import_kind:Statement.ImportDeclaration.ImportType ~from id_name
+  | DefaultTypeof id_name ->
+    mk_default_import ~import_kind:Statement.ImportDeclaration.ImportTypeof ~from id_name
   | Default id_name ->
     mk_default_import ~import_kind:Statement.ImportDeclaration.ImportValue ~from id_name
   | Named id_names ->
     mk_named_import ~import_kind:Statement.ImportDeclaration.ImportValue ~from id_names
   | NamedType id_names ->
     mk_named_import ~import_kind:Statement.ImportDeclaration.ImportType ~from id_names
-  | Namespace id_name -> mk_namespace_import ~from id_name
+  | NamedTypeof id_names ->
+    mk_named_import ~import_kind:Statement.ImportDeclaration.ImportTypeof ~from id_names
+  | Namespace id_name ->
+    mk_namespace_import ~import_kind:Statement.ImportDeclaration.ImportValue ~from id_name
+  | TypeofNamespace id_name ->
+    mk_namespace_import ~import_kind:Statement.ImportDeclaration.ImportTypeof ~from id_name
 
 (* TODO: support inserting requires
     let require_call =
@@ -214,8 +218,9 @@ let update_import ~bindings stmt =
     let edit =
       match (bindings, default, specifiers) with
       | (DefaultType bound_name, Some { identifier = (_, { Identifier.name; _ }); _ }, _)
+      | (DefaultTypeof bound_name, Some { identifier = (_, { Identifier.name; _ }); _ }, _)
       | (Default bound_name, Some { identifier = (_, { Identifier.name; _ }); _ }, _)
-      | ( Namespace bound_name,
+      | ( (Namespace bound_name | TypeofNamespace bound_name),
           None,
           Some (ImportNamespaceSpecifier (_, (_, { Identifier.name; _ })))
         ) ->
@@ -233,17 +238,20 @@ let update_import ~bindings stmt =
           in
           (placement, mk_import ~bindings ~from)
       | (DefaultType _, None, Some _)
+      | (DefaultTypeof _, None, Some _)
       | (Default _, None, Some _) ->
         (* a `import {bar} from 'foo'` or `import * as Foo from 'foo'` already exists.
            rather than change it to `import Foo, {bar} from 'foo'`, we choose to insert
            a separate import. TODO: maybe make this a config option? *)
         (Above { skip_line = false }, mk_import ~bindings ~from)
       | (Named bound_names, _, Some (ImportNamedSpecifiers specifiers))
-      | (NamedType bound_names, _, Some (ImportNamedSpecifiers specifiers)) ->
+      | (NamedType bound_names, _, Some (ImportNamedSpecifiers specifiers))
+      | (NamedTypeof bound_names, _, Some (ImportNamedSpecifiers specifiers)) ->
         let open ImportDeclaration in
         let kind =
           match (import_kind, bindings) with
           | (ImportValue, NamedType _) -> Some ImportType
+          | (ImportValue, NamedTypeof _) -> Some ImportTypeof
           | _ -> None
         in
         let new_specifiers =
@@ -275,19 +283,21 @@ let update_import ~bindings stmt =
       | (Named _, Some _, _)
       | (Named _, None, Some (ImportNamespaceSpecifier _))
       | (NamedType _, Some _, _)
-      | (NamedType _, None, Some (ImportNamespaceSpecifier _)) ->
+      | (NamedType _, None, Some (ImportNamespaceSpecifier _))
+      | (NamedTypeof _, Some _, _)
+      | (NamedTypeof _, None, Some (ImportNamespaceSpecifier _)) ->
         (* trying to insert a named specifier, but a default or namespace import already
            exists. rather than change it to `import Foo, {bar} from 'foo'`, we choose to
            insert a separate import `import {bar} from 'foo'` below the namespace/default
            import. TODO: maybe make this a config option? *)
         (Below { skip_line = false }, mk_import ~bindings ~from)
-      | (Namespace _, Some _, _) ->
+      | ((Namespace _ | TypeofNamespace _), Some _, _) ->
         (* trying to insert a namespace specifier, but a default import already exists.
            rather than change it to `import * as Foo, Bar from 'foo'`, we choose to
            insert a separate import `import * as Foo from 'foo'` below the default.
            TODO: maybe make this a config option? *)
         (Below { skip_line = false }, mk_import ~bindings ~from)
-      | (Namespace _, None, Some (ImportNamedSpecifiers _)) ->
+      | ((Namespace _ | TypeofNamespace _), None, Some (ImportNamedSpecifiers _)) ->
         (* trying to insert a namespace specifier, but a named import already exists.
            rather than change it to `import * as Foo, {bar} from 'foo'`, we choose to
            insert a separate import `import * as Foo from 'foo'` above the named import.
@@ -425,11 +435,20 @@ let section_matches_bindings bindings section =
   let open Section in
   (* TODO: confirm CJS/ESM interop, depends on flowconfig *)
   match (section, bindings) with
-  | (ImportType, (DefaultType _ | NamedType _)) -> true
+  | (ImportType, (DefaultType _ | DefaultTypeof _ | NamedType _ | NamedTypeof _ | TypeofNamespace _))
+    ->
+    true
   | (ImportType, (Default _ | Named _ | Namespace _)) -> false
   | (Require, Default _) -> true
-  | (Require, (DefaultType _ | Named _ | NamedType _ | Namespace _)) -> false
-  | ((ImportValueFromRelative | ImportValueFromModule), (DefaultType _ | NamedType _)) -> false
+  | ( Require,
+      ( DefaultType _ | DefaultTypeof _ | Named _ | NamedType _ | NamedTypeof _ | Namespace _
+      | TypeofNamespace _ )
+    ) ->
+    false
+  | ( (ImportValueFromRelative | ImportValueFromModule),
+      (DefaultType _ | DefaultTypeof _ | NamedType _ | NamedTypeof _ | TypeofNamespace _)
+    ) ->
+    false
   | ((ImportValueFromRelative | ImportValueFromModule), (Default _ | Named _ | Namespace _)) -> true
 
 let existing_import ~bindings ~from imports =

diff --git a/src/services/code_action/autofix_imports.mli b/src/services/code_action/autofix_imports.mli
@@ -12,10 +12,13 @@ type named_binding = {
 
 type bindings =
   | DefaultType of string
+  | DefaultTypeof of string
   | Default of string
   | Named of named_binding list
   | NamedType of named_binding list
+  | NamedTypeof of named_binding list
   | Namespace of string
+  | TypeofNamespace of string
 
 val mk_import : bindings:bindings -> from:string -> (Loc.t, Loc.t) Flow_ast.Statement.t
 

diff --git a/src/services/code_action/document_paste.ml b/src/services/code_action/document_paste.ml
@@ -185,14 +185,17 @@ let provide_document_paste_edits ~layout_options ~module_system_info ~src_dir as
               else
                 Some (from, Autofix_imports.(NamedType [{ remote_name; local_name }]))
             | Lsp.DocumentPaste.ImportNamedTypeOf ->
-              None (* TODO: make Autofix_imports support this kind *)
+              if remote_name = "default" then
+                Some (from, Autofix_imports.DefaultTypeof (Base.Option.value_exn local_name))
+              else
+                Some (from, Autofix_imports.(NamedTypeof [{ remote_name; local_name }]))
             | Lsp.DocumentPaste.ImportNamedValue ->
               if remote_name = "default" then
                 Some (from, Autofix_imports.Default (Base.Option.value_exn local_name))
               else
                 Some (from, Autofix_imports.(Named [{ remote_name; local_name }]))
             | Lsp.DocumentPaste.ImportTypeOfAsNamespace ->
-              None (* TODO: make Autofix_imports support this kind *)
+              Some (from, Autofix_imports.TypeofNamespace remote_name)
             | Lsp.DocumentPaste.ImportValueAsNamespace ->
               Some (from, Autofix_imports.Namespace remote_name))
     )