Skip to content

Commit bb44aa7

Browse files
zthzth
authored
Completion for import attributes in @module (#913)
* add completion for import attributes in @module * changelog
1 parent 9c083c2 commit bb44aa7

File tree

6 files changed

+168
-1
lines changed

6 files changed

+168
-1
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414

1515
#### :nail_care: Polish
1616

17-
Enhance decorator completion. https://github.com/rescript-lang/rescript-vscode/pull/908
17+
- Enhance decorator completion. https://github.com/rescript-lang/rescript-vscode/pull/908
18+
- Completion for import attributes in `@module`. https://github.com/rescript-lang/rescript-vscode/pull/913
1819

1920
## 1.38.0
2021

‎analysis/src/CompletionBackEnd.ml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1776,6 +1776,49 @@ let rec processCompletable ~debug ~full ~scope ~env ~pos ~forHover completable =
17761776
typ
17771777
|> completeTypedValue ?typeArgContext ~rawOpens ~mode:Expression ~full
17781778
~prefix ~completionContext)
1779+
| CdecoratorPayload (ModuleWithImportAttributes {prefix; nested}) -> (
1780+
let mkField ~name ~primitive =
1781+
{
1782+
stamp = -1;
1783+
fname = {loc = Location.none; txt = name};
1784+
optional = true;
1785+
typ = Ctype.newconstr (Path.Pident (Ident.create primitive)) [];
1786+
docstring = [];
1787+
deprecated = None;
1788+
}
1789+
in
1790+
let importAttributesConfig : completionType =
1791+
Trecord
1792+
{
1793+
env;
1794+
definition = `NameOnly "importAttributesConfig";
1795+
fields = [mkField ~name:"type_" ~primitive:"string"];
1796+
}
1797+
in
1798+
let rootConfig : completionType =
1799+
Trecord
1800+
{
1801+
env;
1802+
definition = `NameOnly "moduleConfig";
1803+
fields =
1804+
[
1805+
mkField ~name:"from" ~primitive:"string";
1806+
mkField ~name:"with" ~primitive:"string";
1807+
];
1808+
}
1809+
in
1810+
let nested, typ =
1811+
match nested with
1812+
| NFollowRecordField {fieldName = "with"} :: rest ->
1813+
(rest, importAttributesConfig)
1814+
| _ -> (nested, rootConfig)
1815+
in
1816+
match typ |> TypeUtils.resolveNested ~env ~full ~nested with
1817+
| None -> []
1818+
| Some (typ, _env, completionContext, typeArgContext) ->
1819+
typ
1820+
|> completeTypedValue ?typeArgContext ~rawOpens ~mode:Expression ~full
1821+
~prefix ~completionContext)
17791822
| CdecoratorPayload (Module prefix) ->
17801823
let packageJsonPath =
17811824
Utils.findPackageJson (full.package.rootPath |> Uri.fromPath)

‎analysis/src/CompletionFrontEnd.ml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -825,6 +825,48 @@ let completionWithParser1 ~currentFile ~debug ~offset ~path ~posCursor
825825
if Debug.verbose () then
826826
print_endline "[decoratorCompletion] Found @module";
827827
setResult (Completable.CdecoratorPayload (Module s))
828+
| PStr
829+
[
830+
{
831+
pstr_desc =
832+
Pstr_eval
833+
( {
834+
pexp_desc =
835+
Pexp_record
836+
( ( {txt = Lident "from"},
837+
{
838+
pexp_loc;
839+
pexp_desc =
840+
Pexp_constant (Pconst_string (s, _));
841+
} )
842+
:: _,
843+
_ );
844+
},
845+
_ );
846+
};
847+
]
848+
when locHasCursor pexp_loc ->
849+
if Debug.verbose () then
850+
print_endline
851+
"[decoratorCompletion] Found @module with import attributes and \
852+
cursor on \"from\"";
853+
setResult (Completable.CdecoratorPayload (Module s))
854+
| PStr [{pstr_desc = Pstr_eval (expr, _)}] -> (
855+
if Debug.verbose () then
856+
print_endline
857+
"[decoratorCompletion] Found @module with non-string payload";
858+
match
859+
CompletionExpressions.traverseExpr expr ~exprPath:[]
860+
~pos:posBeforeCursor ~firstCharBeforeCursorNoWhite
861+
with
862+
| None -> ()
863+
| Some (prefix, nested) ->
864+
if Debug.verbose () then
865+
print_endline "[decoratorCompletion] Found @module record path";
866+
setResult
867+
(Completable.CdecoratorPayload
868+
(ModuleWithImportAttributes {nested = List.rev nested; prefix}))
869+
)
828870
| _ -> ()
829871
else if id.txt = "jsxConfig" then
830872
match payload with

‎analysis/src/SharedTypes.ml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -630,6 +630,7 @@ module Completable = struct
630630

631631
type decoratorPayload =
632632
| Module of string
633+
| ModuleWithImportAttributes of {nested: nestedPath list; prefix: string}
633634
| JsxConfig of {nested: nestedPath list; prefix: string}
634635

635636
type t =
@@ -717,6 +718,7 @@ module Completable = struct
717718
| Cpath cp -> "Cpath " ^ contextPathToString cp
718719
| Cdecorator s -> "Cdecorator(" ^ str s ^ ")"
719720
| CdecoratorPayload (Module s) -> "CdecoratorPayload(module=" ^ s ^ ")"
721+
| CdecoratorPayload (ModuleWithImportAttributes _) -> "CdecoratorPayload(moduleWithImportAttributes)"
720722
| CdecoratorPayload (JsxConfig _) -> "JsxConfig"
721723
| CnamedArg (cp, s, sl2) ->
722724
"CnamedArg("

‎analysis/tests/src/CompletionAttributes.res‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,15 @@
1919
// @@jsxConfig({module_: "", })
2020
// ^com
2121

22+
// @module({}) external doStuff: t = "default"
23+
// ^com
24+
25+
// @module({with: }) external doStuff: t = "default"
26+
// ^com
27+
28+
// @module({with: {}}) external doStuff: t = "default"
29+
// ^com
30+
31+
// @module({from: "" }) external doStuff: t = "default"
32+
// ^com
33+

‎analysis/tests/src/expected/CompletionAttributes.res.txt‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,70 @@ Resolved opens 1 pervasives
126126
"documentation": null
127127
}]
128128

129+
Complete src/CompletionAttributes.res 21:12
130+
XXX Not found!
131+
Completable: CdecoratorPayload(moduleWithImportAttributes)
132+
Package opens Pervasives.JsxModules.place holder
133+
Resolved opens 1 pervasives
134+
[{
135+
"label": "from",
136+
"kind": 5,
137+
"tags": [],
138+
"detail": "from?: string\n\ntype moduleConfig = {from: string, with: string}",
139+
"documentation": null
140+
}, {
141+
"label": "with",
142+
"kind": 5,
143+
"tags": [],
144+
"detail": "with?: string\n\ntype moduleConfig = {from: string, with: string}",
145+
"documentation": null
146+
}]
147+
148+
Complete src/CompletionAttributes.res 24:17
149+
XXX Not found!
150+
Completable: CdecoratorPayload(moduleWithImportAttributes)
151+
Package opens Pervasives.JsxModules.place holder
152+
Resolved opens 1 pervasives
153+
[{
154+
"label": "{}",
155+
"kind": 12,
156+
"tags": [],
157+
"detail": "type importAttributesConfig = {type_: string}",
158+
"documentation": null,
159+
"sortText": "A",
160+
"insertText": "{$0}",
161+
"insertTextFormat": 2
162+
}]
163+
164+
Complete src/CompletionAttributes.res 27:19
165+
XXX Not found!
166+
Completable: CdecoratorPayload(moduleWithImportAttributes)
167+
Package opens Pervasives.JsxModules.place holder
168+
Resolved opens 1 pervasives
169+
[{
170+
"label": "type_",
171+
"kind": 5,
172+
"tags": [],
173+
"detail": "type_?: string\n\ntype importAttributesConfig = {type_: string}",
174+
"documentation": null
175+
}]
176+
177+
Complete src/CompletionAttributes.res 30:19
178+
XXX Not found!
179+
Completable: CdecoratorPayload(module=)
180+
Package opens Pervasives.JsxModules.place holder
181+
Resolved opens 1 pervasives
182+
[{
183+
"label": "@rescript/react",
184+
"kind": 4,
185+
"tags": [],
186+
"detail": "Package",
187+
"documentation": null
188+
}, {
189+
"label": "./tst.js",
190+
"kind": 4,
191+
"tags": [],
192+
"detail": "Local file",
193+
"documentation": null
194+
}]
195+

0 commit comments

Comments
 (0)