Use standard function to check if a file is generated #1114
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
As of Go1.21, we can use https://pkg.go.dev/go/ast#IsGenerated to check if a file is generated. Probably we want to use this instead of own implementation.
https://pkg.go.dev/cmd/go#hdr-Generate_Go_files_by_processing_source says: > This line must appear before the first non-comment, non-blank text in the file. Original test cases fail with the previous commit because test source does not comply with this spec. So, probably we should update test case to comply with the spec. (This is a breaking change, though)
|
I noticed that Ci is failing, I will look into it later. |
ccojocar
approved these changes
Mar 7, 2024
|
@ccojocar I've tried to fix it, but I don't understand the cause of the lint error: I would appreciate any advice. |
|
I think you need to run the gci tool to format the two files. Something like this: You can check if the warnings are fixed by running locally the golangci-lint tool. |
Signed-off-by: Cosmin Cojocar <gcojocar@adobe.com>
|
@nobishino I did the formatting. Let's see if now passes the lint. |
|
@ccojocar Thanks! |
nobishino
deleted the
refactor-use-standard-function-to-check-generated-file
branch
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.
As of Go1.21, we can utilize standard package function
ast.IsGeneratedto check if a file is generated or not. This PR replaceisGeneratedFilewith that new standard function.Second commit updates test source.
Standard
ast.IsGeneratedreturnsfalsefor original test sources, because it does not comply withhttps://pkg.go.dev/cmd/go#hdr-Generate_Go_files_by_processing_source
Original test source does not satisfy this condition, so original
isGeneratedFilefunction returnstruewhen it should returnfalse.I would assume we should update the test cases, but this change can be breaking for some users. I wonder if we should do that.