feat: suggest template variables when symbol is unknown #48
Conversation
This file contains hidden or 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
ddneilson
force-pushed
the
ddneilson/edit_distance
branch
3 times, most recently
from
3aa8ef6 to
eee23f5
Compare
AWS-Samuel
reviewed
Feb 6, 2024
AWS-Samuel
approved these changes
Feb 6, 2024
Problem:
When the user has a format string in their template that references a
template variable that doesn't exist (either at that scope or otherwise)
we just provide a generic "symbol unknown" style error message. We can
do better.
Solution:
Add a recommender based on the edit distance between the unknown symbol
and the available symbols at that location. This is mostly targetting
typo errors (e.g. "Parm.Foo" instead of "Param.Foo") right now, so we
also have a threshold distance to avoid some misleading suggestions.
Result:
Given a template like:
```yaml
specificationVersion: jobtemplate-2023-09
name: DemoJob
parameterDefinitions:
- name: Foo
type: INT
steps:
- name: DemoStep
script:
actions:
onRun:
command: echo
args:
- "{{Parm.Foo}}"
```
We generate the error:
```
__root__ -> steps[0] -> script -> actions -> onRun -> args[0]:
Variable Parm.Foo does not exist at this location. Did you mean: Param.Foo
```
Signed-off-by: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
ddneilson
force-pushed
the
ddneilson/edit_distance
branch
from
eee23f5 to
dc0183b
Compare
npmacl
approved these changes
Feb 6, 2024
This was referenced Feb 7, 2024
Closed
Merged
Merged
Merged
Merged
Merged
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What was the problem/requirement? (What/Why)
When the user has a format string in their template that references a template variable that doesn't exist (either at that scope or otherwise) we just provide a generic "symbol unknown" style error message. We can do better.
What was the solution? (How)
Add a recommender based on the edit distance between the unknown symbol and the available symbols at that location. This is mostly targetting typo errors (e.g. "Parm.Foo" instead of "Param.Foo") right now, so we also have a threshold distance to avoid some misleading suggestions.
What is the impact of this change?
Given a template like:
We generate the error:
How was this change tested?
I added unit tests to cover the new functionality.
Was this change documented?
No need.
Is this a breaking change?
Nope.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.