Skip to content

fix(static-msg): support binary expressions #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 4, 2025
Merged

fix(static-msg): support binary expressions #80

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af6a347
fix(static-msg): support binary expressions
tmzane Apr 4, 2025
4d63563
assert operator
tmzane Apr 4, 2025
3aea780
another recursion test
tmzane Apr 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion sloglint.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ func visit(pass *analysis.Pass, opts *Options, node ast.Node, stack []ast.Node)
}

msgPos := funcInfo.argsPos - 1

// NOTE: "With" functions have no message argument and must be skipped.
if opts.StaticMsg && msgPos >= 0 && !isStaticMsg(call.Args[msgPos]) {
pass.Reportf(call.Pos(), "message should be a string literal or a constant")
Expand Down Expand Up @@ -267,7 +268,6 @@ func visit(pass *analysis.Pass, opts *Options, node ast.Node, stack []ast.Node)
if typ == nil {
continue
}

switch typ.String() {
case "string":
keys = append(keys, args[i])
Expand Down Expand Up @@ -376,6 +376,8 @@ func isStaticMsg(msg ast.Expr) bool {
return msg.Kind == token.STRING
case *ast.Ident: // e.g. const msg = "msg"; slog.Info(msg)
return msg.Obj != nil && msg.Obj.Kind == ast.Con
case *ast.BinaryExpr: // e.g. slog.Info("x" + "y")
return isStaticMsg(msg.X) && isStaticMsg(msg.Y)
default:
return false
}
Expand Down
15 changes: 11 additions & 4 deletions testdata/src/static_msg/static_msg.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,20 @@ func tests() {
slog.Log(ctx, slog.LevelInfo, constMsg)
slog.With("key", "value").Info(constMsg)

slog.Info(varMsg) // want `message should be a string literal or a constant`
slog.InfoContext(ctx, varMsg) // want `message should be a string literal or a constant`
slog.Log(ctx, slog.LevelInfo, varMsg) // want `message should be a string literal or a constant`
slog.With("key", "value").Info(varMsg) // want `message should be a string literal or a constant`

slog.Info(fmt.Sprintf("msg")) // want `message should be a string literal or a constant`
slog.InfoContext(ctx, fmt.Sprintf("msg")) // want `message should be a string literal or a constant`
slog.Log(ctx, slog.LevelInfo, fmt.Sprintf("msg")) // want `message should be a string literal or a constant`
slog.With("key", "value").Info(fmt.Sprintf("msg")) // want `message should be a string literal or a constant`

slog.Info(varMsg) // want `message should be a string literal or a constant`
slog.InfoContext(ctx, varMsg) // want `message should be a string literal or a constant`
slog.Log(ctx, slog.LevelInfo, varMsg) // want `message should be a string literal or a constant`
slog.With("key", "value").Info(varMsg) // want `message should be a string literal or a constant`
// binary expressions:
slog.Info("msg" + "msg")
slog.Info("msg" + constMsg)
slog.Info("msg" + varMsg) // want `message should be a string literal or a constant`
slog.Info("msg" + fmt.Sprintf("msg")) // want `message should be a string literal or a constant`
slog.Info("msg" + constMsg + varMsg + fmt.Sprintf("msg")) // want `message should be a string literal or a constant`
}
Loading