[linter-miner] feat(linters): add logfatallibrary linter to flag log.Fatal calls in library packages#45115
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
Detects log.Fatal, log.Fatalf, and log.Fatalln calls in library (pkg/) packages. These functions call os.Exit(1) internally, which: - Bypasses deferred cleanup (e.g., open files, db connections) - Makes the calling package untestable in isolation - Prevents callers from handling errors gracefully The linter mirrors osexitinlibrary but targets the log package's fatal functions. cmd/ entry-points are excluded, as are test files and calls suppressed with //nolint:logfatallibrary. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
automation
cookie
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
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.
Summary
Adds a new
logfatallibrarylinter underpkg/linters/logfatallibrary/that detectslog.Fatal,log.Fatalf, andlog.Fatallncalls inside library (pkg/) packages.Why
log.Fatal*functions internally callos.Exit(1), which:This is the
log-package complement to the existingosexitinlibrarylinter.Evidence
The pattern of flagging implicit
os.Exitcalls in library code is consistent with the existingosexitinlibraryandpanicinlibrarycodelinters. Thelog.Fatalfamily causes the same problem and is frequently overlooked.Changes
pkg/linters/logfatallibrary/logfatallibrary.go— analyzer implementationpkg/linters/logfatallibrary/logfatallibrary_test.go— unit tests usinganalysistestpkg/linters/logfatallibrary/testdata/src/logfatallibrary/logfatallibrary.go— fixture with flagged and safe casescmd/linters/main.go— registers the new analyzerVerification
go test ./pkg/linters/logfatallibrary/...go build ./cmd/linters