Prefill Required Fields on Completion #89
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jpogran
force-pushed
the
f-prefill-required
branch
2 times, most recently
from
0cb8396 to
7ce71de
Compare
jpogran
force-pushed
the
f-prefill-required
branch
from
7ce71de to
05d4c93
Compare
radeksimko
reviewed
Sep 30, 2021
jpogran
force-pushed
the
f-prefill-required
branch
3 times, most recently
from
4606715 to
f75873e
Compare
radeksimko
reviewed
Oct 4, 2021
jpogran
force-pushed
the
f-prefill-required
branch
2 times, most recently
from
4abe8f8 to
86c2c23
Compare
jpogran
changed the title
jpogran
changed the title
radeksimko
approved these changes
Oct 7, 2021
jpogran
force-pushed
the
f-prefill-required
branch
2 times, most recently
from
193e439 to
0286430
Compare
On block completion, provide a snippet that completes the label and also the required fields for that block.
Currently users can introduce a new block into their configuration using our auto-complete snippet. This snippet only provides the lable name and completes the stanza. However the block is not considered complete/valid until it has all required attributes and blocks. This means that users have to either scroll over a potentially long list of attributes and blocks to add all required ones and/or consult documentation in a separate window.
This commit modifies the label completion logic to provide an auto-complete snippet that lists all required fields (attributes and blocks) and expands the TextEdit range to the entire line instead of just to the tabstop. This will replace the entire line with the chosen snippet. The attributes and blocks are sorted alphabetically to ensure consistent ordering for each invocation.
For example, when completing the `aws_appmesh_route` resource type, the `mesh_name`, `name`, `virtual_router_name` attributes and the `spec` block will fill in on accepting the completion. Then, the user can tab through to enter in the appropriate value for each field.
```
resource "aws_appmesh_route" "{2:name}" {
mesh_name = "${3:value}"
name = "${4:value}"
virtual_router_name = "${:value}"
spec {
}
${0}
}
```
jpogran
force-pushed
the
f-prefill-required
branch
from
0286430 to
f22d3c2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On block completion, provide a snippet that completes the label and also the required fields for that block.
Currently users can introduce a new block into their configuration using our auto-complete snippet. This snippet only provides the label name and completes the stanza. However the block is not considered complete/valid until it has all required attributes and blocks. This means that users have to either scroll over a potentially long list of attributes and blocks to add all required ones and/or consult documentation in a separate window.
This commit modifies the label completion logic to provide an auto-complete snippet that lists all required fields (attributes and blocks) and expands the TextEdit range to the entire line instead of just to the tabstop. This will replace the entire line with the chosen snippet. The attributes and blocks are sorted alphabetically to ensure consistent ordering for each invocation.
For example, when completing the
aws_appmesh_routeresource type, themesh_name,name,virtual_router_nameattributes and thespecblock will fill in on accepting the completion. Then, the user can tab through to enter in the appropriate value for each field.Enabled in LS in hashicorp/terraform-ls#657
Surfaced in VS Code in hashicorp/vscode-terraform#799 as an experimental feature
Completes hashicorp/vscode-terraform#719