cmd/cue: add --outfile flag to get go
#4118
Open
+108
−20
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
fionera
force-pushed
the
feature/get-go-one-shot
branch
from
56697cf to
3a72ca5
Compare
mvdan
reviewed
Oct 6, 2025
fionera
force-pushed
the
feature/get-go-one-shot
branch
from
3a72ca5 to
2ffd695
Compare
|
Ah forgot the test, ignore the request for review. Sorry ^^' |
This introduces a way to write generated cue schemas to a given file or stdout. It joins all declarations into one giant file and preserves all package comments. Signed-off-by: Tim Windelschmidt <[email protected]>
fionera
force-pushed
the
feature/get-go-one-shot
branch
from
2ffd695 to
a7ac603
Compare
|
Now with added test 😄 |
mvdan
approved these changes
Oct 8, 2025
| ) | ||
| for i, f := range p.Syntax { | ||
| // If we are in the first iteration we need to set cuePkg. | ||
| // Af we want to join everything into the same file, |
There was a problem hiding this comment.
(ignore given my suggested rewrite below)
| // If we are in the first iteration we need to set cuePkg. | ||
| // Af we want to join everything into the same file, | ||
| // we have to keep the same cuePkg and declarations around | ||
| // for all iterations, else reset. |
There was a problem hiding this comment.
I'd move this comment above the for loop, and also explain what's happening with writing only the last (joined) file. Something like...
// By default, we output one CUE file for each Go file as long as there's anything to generate.
// When --outfile is used, we want to generate exactly one CUE file for an entire Go package,
// so we instead keep joining declarations until we reach the last Go file, where we then write.
| -- cue.mod/module.cue -- | ||
| module: "mod.test" | ||
| language: version: "v0.9.0" | ||
| -- x/x.go -- |
There was a problem hiding this comment.
best to include multiple files in package x, to make sure that the joining of declarations is tested.
|
|
||
| if flagOutFile.IsSet(cmd) && len(pkgs) != 1 { | ||
| return errors.New("--outfile only allows for one package to be specified") | ||
| } |
There was a problem hiding this comment.
I'd test these edge cases in the testscript too, like...
! exec cue get go --outfile out.cue --local ./x
stderr 'mutually exclusive'
! exec cue get go --outfile out.cue ./x ./y
stderr 'only allows for one package'
Comment on lines
+594
to
+600
| if !flagOutFile.IsSet(e.cmd) { | ||
| for pkgPath := range e.usedPkgs { | ||
| if !e.done[pkgPath] { | ||
| e.done[pkgPath] = true | ||
| if err := e.extractPkg(root, e.allPkgs[pkgPath]); err != nil { | ||
| return err | ||
| } |
There was a problem hiding this comment.
Suggested change
| if !flagOutFile.IsSet(e.cmd) { | |
| for pkgPath := range e.usedPkgs { | |
| if !e.done[pkgPath] { | |
| e.done[pkgPath] = true | |
| if err := e.extractPkg(root, e.allPkgs[pkgPath]); err != nil { | |
| return err | |
| } | |
| for pkgPath := range e.usedPkgs { | |
| if !flagOutFile.IsSet(e.cmd) && !e.done[pkgPath] { | |
| e.done[pkgPath] = true | |
| if err := e.extractPkg(root, e.allPkgs[pkgPath]); err != nil { | |
| return err |
There was a problem hiding this comment.
there's a negligible performance difference either way, so there's no need to add a level of nesting here
| # We can only compare the generated file to the expected golden file, | ||
| # as all imports are skipped and only the given package is generated. | ||
| cmp outfile.cue x_go_gen.cue.golden | ||
|
|
There was a problem hiding this comment.
perhaps test that we didn't generate any of the usual files too, like...
! exists cue.mod/gen/ x/x_go_gen.cue y/y_go_gen.cue
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 introduces a way to write generated cue schemas to a given file or stdout. It joins all declarations into one giant file and preserves all package comments.
Closes #4108