fix(cli codegen): fixed missing imports #3046
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
fredbi
force-pushed
the
fix/2969-cli
branch
2 times, most recently
from
c1df1a9
to
76cace6
Compare
|
Built on top of #3045 |
casualjim
approved these changes
Jan 6, 2024
youyuanwu
reviewed
Jan 6, 2024
youyuanwu
reviewed
Jan 6, 2024
|
|
||
| // look for default config (OS-specific, e.g. ".config" on linux) | ||
| configDir, err = os.UserConfigDir() | ||
| if err != nil { |
youyuanwu
approved these changes
Jan 6, 2024
* fixes go-swagger#2969 This PR addresses an issue with goimports not being able to find another generated package. When generating files in 2 packages simultaneously (i.e. cli imports models and files are being generated model per model in both packages), there are situations when goimports fails to properly resolve the imported package (i.e. the imported package is not completed and may have errors while generating). This fix proceeds in 2 steps: first generate all models, then proceed with a final generation step ("PostModels") that iterates again over all models. It is a bit slower, but imports are now safe. Other additions with this PR: * updated dependency to golang.org/x/tools * added go-openapi/strfmt to default imports (was missing and added by goimports, but it is best to make it explicit and avoid unnecessary import fixes) * in templates, added standard library imports * relinted code generated by the CLI templates (check for errors, unused args, shadowed variables, prefer // over block comments, blank lines...) * updated cli.gotmpl to use os.UserConfigDir() and os.HomeDir() rather than importing a third party package * added guard for multiline .Description in calls to PersistentFlags() Tests: * added CLI codegen tests for go-swagger#2969, go-swagger#2650 and the latest docker spec (used to generate go-swagger/dockerctl) Signed-off-by: Frederic BIDON <fredbi@yahoo.com> reindented cli.gotmpl Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #3046 +/- ##
==========================================
- Coverage 82.67% 82.64% -0.03%
==========================================
Files 62 62
Lines 12818 12856 +38
==========================================
+ Hits 10597 10625 +28
- Misses 1685 1692 +7
- Partials 536 539 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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 addresses an issue with goimports not being able
to find another generated package.
When generating files in 2 packages simultaneously (i.e. cli imports models
and files are being generated model per model in both packages),
there are situations when goimports fails to properly resolve the imported
package (i.e. the imported package is not completed and may have errors
while generating).
This fix proceeds in 2 steps: first generate all models, then proceed with
a final generation step ("PostModels") that iterates again over all
models. It is a bit slower, but imports are now safe.
Other additions with this PR:
goimports, but it is best to make it explicit and avoid unnecessary
import fixes)
args, shadowed variables, prefer // over block comments, blank lines...)
than importing a third party package
Tests:
(used to generate go-swagger/dockerctl)
Signed-off-by: Frederic BIDON fredbi@yahoo.com