all: match go conventions for generated code #6731
Merged
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
Go documents the following regex pattern for identifying generated code: ^// Code generated .* DO NOT EDIT\.$ This convention is used go APIs and tooling. References: https://pkg.go.dev/go/ast#IsGenerated https://pkg.go.dev/cmd/go#hdr-Generate_Go_files_by_processing_source
seankhliao
requested review from
MrAlias,
XSAM,
dashpole,
pellared and
dmathieu
as code owners
MrAlias
approved these changes
May 4, 2025
dmathieu
approved these changes
May 5, 2025
|
This comment was crafted this way intentionally so that the linters analyze the code as the code is manually written in go.tmpl files. |
|
I think in that case it's better to configure the linters to not ignore the file, rather than having something that looks like a mistake? e.g. golangci: issues:
exclusions:
generated: disable |
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.
Go documents the following regex pattern
for identifying generated code:
^// Code generated .* DO NOT EDIT.$
This convention is used go APIs and tooling.
References:
https://pkg.go.dev/go/ast#IsGenerated
https://pkg.go.dev/cmd/go#hdr-Generate_Go_files_by_processing_source