Refactor: transparent and extensible cuegen decl #6006
Merged
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.
Description of your changes
🤖 Generated by Copilot at b3c4005
Summary
🧪🏗️♻️
This pull request refactors the CUE generator code to use a new
Decl
interface for different kinds of CUE declarations, such as structs, and adds aStruct
type that implements the interface. This simplifies the code structure, makes it more extensible, and enables common fields and methods for CUE declarations. The pull request also updates the test cases and modifies theprovider.go
file to use the new interface.Walkthrough
Decl
and a new typeStruct
that implement it indecl.go
(link, link)Generate
andconvertDecls
methods from[]cueast.Decl
to[]Decl
inconvert.go
andgenerator.go
(link, link)Format
andmodifyDecls
functions from[]cueast.Decl
to[]Decl
ingenerator.go
andprovider.go
(link, link)convertDecls
to use a switch statement instead of an if statement for handling different kinds of underlying types inconvert.go
(link)Format
to call theBuild
method of eachDecl
and append the result to thef.Decls
slice ingenerator.go
(link)modifyDecls
to use a type assertion to check if eachDecl
is aStruct
and use its fields to populate themapping
map inprovider.go
(link)modifyDecls
to create and append aStruct
instance instead of acueast.Field
instance to thedecls
slice inprovider.go
(link)cueast
ingenerator_test.go
(link)Format
method calls inTestGeneratorFormat
function from[]cueast.Decl
to[]Decl
ingenerator_test.go
(link)Struct
type and itsBuild
method indecl_test.go
(link)Part of #5364
We may support more CUE types in the future, so we need transparent and extensible cuegen decl.
I have:
make reviewable
to ensure this PR is ready for review.backport release-x.y
labels to auto-backport this PR if necessary.How has this code been tested
No break changes and no modified unit tests.
Special notes for your reviewer