Add function signature types #207
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
3 tasks
radeksimko
reviewed
Feb 15, 2023
schema/signature.go
Outdated
Comment on lines
18
to
23
| // Parameters describes the function's fixed positional parameters. | ||
| Params []function.Parameter | ||
|
|
||
| // VariadicParameter describes the function's variadic | ||
| // parameter if it is supported. | ||
| VarParam *function.Parameter |
There was a problem hiding this comment.
Suggested change
| // Parameters describes the function's fixed positional parameters. | |
| Params []function.Parameter | |
| // VariadicParameter describes the function's variadic | |
| // parameter if it is supported. | |
| VarParam *function.Parameter | |
| // Params describes the function's fixed positional parameters. | |
| Params []function.Parameter | |
| // VarParam describes the function's variadic | |
| // parameter if it is supported. | |
| VarParam *function.Parameter |
I'm not sure if the short names are better here, but I guess they align with the relevant function names in go-cty, so at least we're consistent 🤷🏻
schema/signature.go
Outdated
| "github.com/zclconf/go-cty/cty/function" | ||
| ) | ||
|
|
||
| type FuncSignature struct { |
There was a problem hiding this comment.
Suggested change
| type FuncSignature struct { | |
| type FunctionSignature struct { |
This would IMO better align with function.Function in go-cty: https://pkg.go.dev/github.com/zclconf/[email protected]/cty/function#Function
decoder/path_context.go
Outdated
| @@ -16,8 +16,7 @@ type PathContext struct { | |||
| ReferenceOrigins reference.Origins | |||
| ReferenceTargets reference.Targets | |||
| Files map[string]*hcl.File | |||
|
|
|||
| // TODO: Functions | |||
| Functions map[string]schema.FuncSignature | |||
There was a problem hiding this comment.
Suggested change
| Functions map[string]schema.FuncSignature | |
| Functions map[string]schema.FunctionSignature |
lang/signature.go
Outdated
Comment on lines
3
to
24
| type FuncSignature struct { | ||
| Name string | ||
|
|
||
| // Description is an optional human-readable description | ||
| // of the function. | ||
| Description MarkupContent | ||
|
|
||
| // Parameters is an ordered list of the function's parameters. | ||
| Parameters []FuncParameter | ||
|
|
||
| // ActiveParameter is an index marking the parameter a user is currently | ||
| // editing. It should lie inside the range of Parameters. | ||
| ActiveParameter uint | ||
| } | ||
|
|
||
| type FuncParameter struct { | ||
| Name string | ||
|
|
||
| // Description is an optional human-readable description | ||
| // of the parameter. | ||
| Description MarkupContent | ||
| } |
There was a problem hiding this comment.
None of the lang.* types seem currently required for hashicorp/terraform-schema#145 AFAICT, so shall we leave it for a separate PR which introduces the code that needs it? e.g. signatureHelp method?
dbanck
force-pushed
the
f-function-signature-types
branch
from
e30b6ba to
7f34f2a
Compare
radeksimko
approved these changes
Feb 15, 2023
This was referenced Apr 24, 2023
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.
This PR extracts the function signature types from #135 to enable us to implement upstream changes in terraform-schema before completing the function signatures features as a whole.
We can use the new signature types to embed function signatures in terraform-schema.