feat: internalise command
#90
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
ARR4N
requested review from
a team,
ceyonur and
darioush
and removed request for
a team
qdm12
approved these changes
Dec 17, 2024
| // Since we're not creating, the zero perm/mode is ignored. | ||
| f, err := os.OpenFile(fileName, os.O_TRUNC|os.O_WRONLY, 0) //nolint:gosec // Variable file is under our direct control in go:generate | ||
| if err != nil { | ||
| return fmt.Errorf("os.OpenFile(%q, [write-only, truncate]): %v", fileName, err) |
There was a problem hiding this comment.
nit always wrap errors with %w (aka wrap), not %v; also regarding error wrapping, I would suggest something a bit less code-focused such as:
Suggested change
| return fmt.Errorf("os.OpenFile(%q, [write-only, truncate]): %v", fileName, err) | |
| return fmt.Errorf("opening source file to override %q: %w", fileName, err) |
- The programmer when debugging could then easily find the relevant code
os.OpenFile(fileName, os.O_TRUNC|os.O_WRONLY, 0)so there is no need to wrap this information I think - the programmer does not need to maintain the error message wrap in case the function call
os.OpenFilechanges (just a general rule, it probably won't change much here)
| return fmt.Errorf("os.OpenFile(%q, [write-only, truncate]): %v", fileName, err) | ||
| } | ||
| if err := format.Node(f, fset, parsed); err != nil { | ||
| return fmt.Errorf("format.Node(%T): %v", parsed, err) |
There was a problem hiding this comment.
same here 😉 I don't think having the parsed type (always *ast.File) is really useful, and we don't really want to log it out either 😄
Suggested change
| return fmt.Errorf("format.Node(%T): %v", parsed, err) | |
| return fmt.Errorf("formatting node to file: %w", err) |
| mode := parser.SkipObjectResolution | parser.ParseComments | ||
| parsed, err := parser.ParseFile(fset, fileName, nil, mode) | ||
| if err != nil { | ||
| return fmt.Errorf("parser.ParseFile(%q): %v", fileName, err) |
There was a problem hiding this comment.
nit the wrapping is a bit misleading, especially since the ParseFile signature isn't the same. Why not just dumb old human-like wording as follows? Also wrap errors with %w not %v 😉
Suggested change
| return fmt.Errorf("parser.ParseFile(%q): %v", fileName, err) | |
| return fmt.Errorf("parsing source file %q: %w", fileName, err) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Why this should be merged
Replaces #86. That approach couldn't be replicated for generated JSON marshalling, and this once also reduces the upstream delta.
How this works
AST manipulation of a specified file, which finds specified methods and modifies their names to be unexported.
How this was tested
Inspection of the output (
core/types/gen_header_rlp.goremains unchanged).