plumbing: use errors package for comparison #1469
Open
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
There was a problem hiding this comment.
Pull Request Overview
This PR refactors error handling across the codebase to follow Go 1.13 best practices by replacing direct error equality checks with errors.Is and errors.As.
- Replace error equality comparisons with errors.Is and errors.As.
- Update multiple files to import the "errors" package and adjust error handling accordingly.
- Ensure consistency in error handling across both core and example packages.
Reviewed Changes
Copilot reviewed 44 out of 44 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| cli/go-git/main.go | Refactored error handling using errors.As and errors.Is for flag errors. |
| plumbing/object/commit_walker_limit.go | Updated error comparisons for storer.ErrStop using errors.Is. |
| plumbing/object/commit_walker.go | Refactored error comparisons for storer.ErrStop and plumbing.ErrReferenceNotFound. |
| plumbing/object/commit_walker_bfs.go | Updated error comparisons for storer.ErrStop in ForEach. |
| plumbing/object/commitgraph/commitnode_walker_ctime.go | Updated error comparisons for storer.ErrStop in ForEach. |
| plumbing/object/commit_walker_ctime.go | Updated error comparisons for storer.ErrStop using errors.Is. |
| plumbing/object/commit_walker_path.go | Updated error comparisons for storer.ErrStop using errors.Is. |
| plumbing/object/commitgraph/commitnode_walker_topo_order.go | Updated error comparisons for storer.ErrStop using errors.Is. |
| plumbing/object/file.go | Updated error comparisons for storer.ErrStop in FileIter using errors.Is. |
| options.go | Updated error comparisons for plumbing.ErrReferenceNotFound using errors.Is. |
| config/config.go | Updated error comparisons for ErrModuleBadPath using errors.Is. |
| plumbing/object/commitgraph/commitnode.go | Updated error comparisons for ParentNode errors using errors.Is. |
| _examples/checkout-branch/main.go | Updated error comparisons for git.NoErrAlreadyUpToDate using errors.Is. |
| _examples/tag-create-push/main.go | Updated error comparisons for git.NoErrAlreadyUpToDate using errors.Is. |
| _examples/ls/main.go | Updated error comparisons for object.ErrDirectoryNotFound using errors.Is. |
| plumbing/object/difftree.go | Updated error comparisons for merkletrie.ErrCanceled using errors.Is. |
| plumbing/format/pktline/pktline.go | Updated error comparisons for io.ErrUnexpectedEOF using errors.Is. |
Comments suppressed due to low confidence (1)
cli/go-git/main.go:34
- e.Type is likely a simple value (e.g. an enum or integer) rather than an error, so using errors.Is on e.Type is inappropriate. Consider reverting to a direct equality check (e.g. e.Type == flags.ErrCommandRequired) for accurate comparison.
if errors.As(err, &e) && errors.Is(e.Type, flags.ErrCommandRequired) {
5836153 to
64f79b6
Compare
64f79b6 to
d05a319
Compare
Comparison with errors using equality operators fails on wrapped errors use the golang 1.13 best practices: https://tip.golang.org/doc/go1.13#error_wrapping
d05a319 to
d6652b6
Compare
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.
Comparison with errors using equality operators fails on wrapped errors
use the golang 1.13 best practices: https://tip.golang.org/doc/go1.13#error_wrapping