aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/go-simpler.org
diff options
context:
space:
mode:
authorTaras Madan <tarasmadan@google.com>2023-12-05 15:10:03 +0100
committerTaras Madan <tarasmadan@google.com>2023-12-06 11:31:44 +0000
commit2ab72b4feef2c97f22f90cfbf9e45a6cfcd08bda (patch)
treea6d19b94b6399fcc00a6cfa430885cd349dd1533 /vendor/go-simpler.org
parente08e8f492d31d672cc245944c185f8aadf2ee695 (diff)
vendor: updates
Diffstat (limited to 'vendor/go-simpler.org')
-rw-r--r--vendor/go-simpler.org/sloglint/.golangci.yml22
-rw-r--r--vendor/go-simpler.org/sloglint/.goreleaser.yml18
-rw-r--r--vendor/go-simpler.org/sloglint/LICENSE373
-rw-r--r--vendor/go-simpler.org/sloglint/README.md102
-rw-r--r--vendor/go-simpler.org/sloglint/sloglint.go226
5 files changed, 741 insertions, 0 deletions
diff --git a/vendor/go-simpler.org/sloglint/.golangci.yml b/vendor/go-simpler.org/sloglint/.golangci.yml
new file mode 100644
index 000000000..ef926a056
--- /dev/null
+++ b/vendor/go-simpler.org/sloglint/.golangci.yml
@@ -0,0 +1,22 @@
+linters:
+ disable-all: true
+ enable:
+ # enabled by default:
+ - errcheck
+ - gosimple
+ - govet
+ - ineffassign
+ - staticcheck
+ - unused
+ # disabled by default:
+ - gocritic
+ - gofumpt
+
+linters-settings:
+ gocritic:
+ enabled-tags:
+ - diagnostic
+ - style
+ - performance
+ - experimental
+ - opinionated
diff --git a/vendor/go-simpler.org/sloglint/.goreleaser.yml b/vendor/go-simpler.org/sloglint/.goreleaser.yml
new file mode 100644
index 000000000..d31ea11d3
--- /dev/null
+++ b/vendor/go-simpler.org/sloglint/.goreleaser.yml
@@ -0,0 +1,18 @@
+builds:
+ - main: ./cmd/sloglint
+ env:
+ - CGO_ENABLED=0
+ flags:
+ - -trimpath
+ ldflags:
+ - -s -w -X main.version={{.Version}}
+ targets:
+ - darwin_amd64
+ - darwin_arm64
+ - linux_amd64
+ - windows_amd64
+
+archives:
+ - format_overrides:
+ - goos: windows
+ format: zip
diff --git a/vendor/go-simpler.org/sloglint/LICENSE b/vendor/go-simpler.org/sloglint/LICENSE
new file mode 100644
index 000000000..a612ad981
--- /dev/null
+++ b/vendor/go-simpler.org/sloglint/LICENSE
@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+ means each individual or legal entity that creates, contributes to
+ the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+ means the combination of the Contributions of others (if any) used
+ by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+ means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+ means Source Code Form to which the initial Contributor has attached
+ the notice in Exhibit A, the Executable Form of such Source Code
+ Form, and Modifications of such Source Code Form, in each case
+ including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+ means
+
+ (a) that the initial Contributor has attached the notice described
+ in Exhibit B to the Covered Software; or
+
+ (b) that the Covered Software was made available under the terms of
+ version 1.1 or earlier of the License, but not also under the
+ terms of a Secondary License.
+
+1.6. "Executable Form"
+ means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+ means a work that combines Covered Software with other material, in
+ a separate file or files, that is not Covered Software.
+
+1.8. "License"
+ means this document.
+
+1.9. "Licensable"
+ means having the right to grant, to the maximum extent possible,
+ whether at the time of the initial grant or subsequently, any and
+ all of the rights conveyed by this License.
+
+1.10. "Modifications"
+ means any of the following:
+
+ (a) any file in Source Code Form that results from an addition to,
+ deletion from, or modification of the contents of Covered
+ Software; or
+
+ (b) any new file in Source Code Form that contains any Covered
+ Software.
+
+1.11. "Patent Claims" of a Contributor
+ means any patent claim(s), including without limitation, method,
+ process, and apparatus claims, in any patent Licensable by such
+ Contributor that would be infringed, but for the grant of the
+ License, by the making, using, selling, offering for sale, having
+ made, import, or transfer of either its Contributions or its
+ Contributor Version.
+
+1.12. "Secondary License"
+ means either the GNU General Public License, Version 2.0, the GNU
+ Lesser General Public License, Version 2.1, the GNU Affero General
+ Public License, Version 3.0, or any later versions of those
+ licenses.
+
+1.13. "Source Code Form"
+ means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+ means an individual or a legal entity exercising rights under this
+ License. For legal entities, "You" includes any entity that
+ controls, is controlled by, or is under common control with You. For
+ purposes of this definition, "control" means (a) the power, direct
+ or indirect, to cause the direction or management of such entity,
+ whether by contract or otherwise, or (b) ownership of more than
+ fifty percent (50%) of the outstanding shares or beneficial
+ ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+ Licensable by such Contributor to use, reproduce, make available,
+ modify, display, perform, distribute, and otherwise exploit its
+ Contributions, either on an unmodified basis, with Modifications, or
+ as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+ for sale, have made, import, and otherwise transfer either its
+ Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+ or
+
+(b) for infringements caused by: (i) Your and any other third party's
+ modifications of Covered Software, or (ii) the combination of its
+ Contributions with other software (except as part of its Contributor
+ Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+ its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+ Form, as described in Section 3.1, and You must inform recipients of
+ the Executable Form how they can obtain a copy of such Source Code
+ Form by reasonable means in a timely manner, at a charge no more
+ than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+ License, or sublicense it under different terms, provided that the
+ license for the Executable Form does not attempt to limit or alter
+ the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+* *
+* 6. Disclaimer of Warranty *
+* ------------------------- *
+* *
+* Covered Software is provided under this License on an "as is" *
+* basis, without warranty of any kind, either expressed, implied, or *
+* statutory, including, without limitation, warranties that the *
+* Covered Software is free of defects, merchantable, fit for a *
+* particular purpose or non-infringing. The entire risk as to the *
+* quality and performance of the Covered Software is with You. *
+* Should any Covered Software prove defective in any respect, You *
+* (not any Contributor) assume the cost of any necessary servicing, *
+* repair, or correction. This disclaimer of warranty constitutes an *
+* essential part of this License. No use of any Covered Software is *
+* authorized under this License except under this disclaimer. *
+* *
+************************************************************************
+
+************************************************************************
+* *
+* 7. Limitation of Liability *
+* -------------------------- *
+* *
+* Under no circumstances and under no legal theory, whether tort *
+* (including negligence), contract, or otherwise, shall any *
+* Contributor, or anyone who distributes Covered Software as *
+* permitted above, be liable to You for any direct, indirect, *
+* special, incidental, or consequential damages of any character *
+* including, without limitation, damages for lost profits, loss of *
+* goodwill, work stoppage, computer failure or malfunction, or any *
+* and all other commercial damages or losses, even if such party *
+* shall have been informed of the possibility of such damages. This *
+* limitation of liability shall not apply to liability for death or *
+* personal injury resulting from such party's negligence to the *
+* extent applicable law prohibits such limitation. Some *
+* jurisdictions do not allow the exclusion or limitation of *
+* incidental or consequential damages, so this exclusion and *
+* limitation may not apply to You. *
+* *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+ This Source Code Form is subject to the terms of the Mozilla Public
+ License, v. 2.0. If a copy of the MPL was not distributed with this
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+ This Source Code Form is "Incompatible With Secondary Licenses", as
+ defined by the Mozilla Public License, v. 2.0.
diff --git a/vendor/go-simpler.org/sloglint/README.md b/vendor/go-simpler.org/sloglint/README.md
new file mode 100644
index 000000000..8f26f3aa7
--- /dev/null
+++ b/vendor/go-simpler.org/sloglint/README.md
@@ -0,0 +1,102 @@
+# sloglint
+
+[![checks](https://github.com/go-simpler/sloglint/actions/workflows/checks.yml/badge.svg)](https://github.com/go-simpler/sloglint/actions/workflows/checks.yml)
+[![pkg.go.dev](https://pkg.go.dev/badge/go-simpler.org/sloglint.svg)](https://pkg.go.dev/go-simpler.org/sloglint)
+[![goreportcard](https://goreportcard.com/badge/go-simpler.org/sloglint)](https://goreportcard.com/report/go-simpler.org/sloglint)
+[![codecov](https://codecov.io/gh/go-simpler/sloglint/branch/main/graph/badge.svg)](https://codecov.io/gh/go-simpler/sloglint)
+
+A Go linter that ensures consistent code style when using `log/slog`.
+
+## ๐Ÿ“Œ About
+
+The `log/slog` API allows two different types of arguments: key-value pairs and attributes.
+People may have different opinions about which one is better,
+but nobody probably wants to mix them up because it makes the code harder to read.
+
+```go
+slog.Info("a user has logged in", "user_id", 42, slog.String("ip_address", "192.0.2.0")) // ugh
+```
+
+`sloglint` finds such function calls and checks that all the arguments are either key-value pairs or attributes.
+The linter has several options, so you can adjust it to your own code style.
+
+## ๐Ÿš€ Features
+
+* Forbid mixing key-value pairs and attributes within a single function call (default)
+* Enforce using either key-value pairs or attributes for the entire project (optional)
+* Enforce using constants instead of raw keys (optional)
+* Enforce putting arguments on separate lines (optional)
+
+## ๐Ÿ“ฆ Install
+
+Download a prebuilt binary from the [Releases][1] page.
+
+## ๐Ÿ“‹ Usage
+
+```shell
+sloglint [flags] ./...
+```
+
+### Key-value pairs only
+
+The `-kv-only` flag causes `sloglint` to report any use of attributes.
+
+```go
+slog.Info("a user has logged in", slog.Int("user_id", 42)) // sloglint: attributes should not be used
+```
+
+### Attributes only
+
+In contrast, the `-attr-only` flag causes `sloglint` to report any use of key-value pairs.
+
+```go
+slog.Info("a user has logged in", "user_id", 42) // sloglint: key-value pairs should not be used
+```
+
+### No raw keys
+
+To prevent typos, you may want to forbid the use of raw keys altogether.
+The `-no-raw-keys` flag causes `sloglint` to report the use of strings as keys (including `slog.Attr` calls, e.g. `slog.Int("user_id", 42)`).
+
+```go
+slog.Info("a user has logged in", "user_id", 42) // sloglint: raw keys should not be used
+```
+
+This report can be fixed by using either constants...
+
+```go
+const UserId = "user_id"
+
+slog.Info("a user has logged in", UserId, 42)
+```
+
+...or custom `slog.Attr` constructors.
+
+```go
+func UserId(value int) slog.Attr { return slog.Int("user_id", value) }
+
+slog.Info("a user has logged in", UserId(42))
+```
+
+> ๐Ÿ’ก Such helpers can be automatically generated for you by the [`sloggen`][2] tool. Give it a try too!
+
+### Arguments on separate lines
+
+To improve code readability, you may want to put arguments on separate lines, especially when using key-value pairs.
+The `-args-on-sep-lines` flag causes `sloglint` to report 2+ arguments on the same line.
+
+```go
+slog.Info("a user has logged in", "user_id", 42, "ip_address", "192.0.2.0") // sloglint: arguments should be put on separate lines
+```
+
+This report can be fixed by reformatting the code.
+
+```go
+slog.Info("a user has logged in",
+ "user_id", 42,
+ "ip_address", "192.0.2.0",
+)
+```
+
+[1]: https://github.com/go-simpler/sloglint/releases
+[2]: https://github.com/go-simpler/sloggen
diff --git a/vendor/go-simpler.org/sloglint/sloglint.go b/vendor/go-simpler.org/sloglint/sloglint.go
new file mode 100644
index 000000000..4e4520698
--- /dev/null
+++ b/vendor/go-simpler.org/sloglint/sloglint.go
@@ -0,0 +1,226 @@
+// Package sloglint implements the sloglint analyzer.
+package sloglint
+
+import (
+ "errors"
+ "flag"
+ "go/ast"
+ "go/token"
+ "go/types"
+ "strconv"
+
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/go/types/typeutil"
+)
+
+// Options are options for the sloglint analyzer.
+type Options struct {
+ KVOnly bool // Enforce using key-value pairs only (incompatible with AttrOnly).
+ AttrOnly bool // Enforce using attributes only (incompatible with KVOnly).
+ NoRawKeys bool // Enforce using constants instead of raw keys.
+ ArgsOnSepLines bool // Enforce putting arguments on separate lines.
+}
+
+// New creates a new sloglint analyzer.
+func New(opts *Options) *analysis.Analyzer {
+ if opts == nil {
+ opts = new(Options)
+ }
+ return &analysis.Analyzer{
+ Name: "sloglint",
+ Doc: "ensure consistent code style when using log/slog",
+ Flags: flags(opts),
+ Requires: []*analysis.Analyzer{inspect.Analyzer},
+ Run: func(pass *analysis.Pass) (any, error) {
+ if opts.KVOnly && opts.AttrOnly {
+ return nil, errors.New("sloglint: incompatible options provided")
+ }
+ run(pass, opts)
+ return nil, nil
+ },
+ }
+}
+
+func flags(opts *Options) flag.FlagSet {
+ fs := flag.NewFlagSet("sloglint", flag.ContinueOnError)
+
+ boolVar := func(value *bool, name, usage string) {
+ fs.Func(name, usage, func(s string) error {
+ v, err := strconv.ParseBool(s)
+ *value = v
+ return err
+ })
+ }
+
+ boolVar(&opts.KVOnly, "kv-only", "enforce using key-value pairs only (incompatible with -attr-only)")
+ boolVar(&opts.AttrOnly, "attr-only", "enforce using attributes only (incompatible with -kv-only)")
+ boolVar(&opts.NoRawKeys, "no-raw-keys", "enforce using constants instead of raw keys")
+ boolVar(&opts.ArgsOnSepLines, "args-on-sep-lines", "enforce putting arguments on separate lines")
+
+ return *fs
+}
+
+var slogFuncs = map[string]int{ // funcName:argsPos
+ "log/slog.Log": 3,
+ "log/slog.Debug": 1,
+ "log/slog.Info": 1,
+ "log/slog.Warn": 1,
+ "log/slog.Error": 1,
+ "log/slog.DebugContext": 2,
+ "log/slog.InfoContext": 2,
+ "log/slog.WarnContext": 2,
+ "log/slog.ErrorContext": 2,
+ "(*log/slog.Logger).Log": 3,
+ "(*log/slog.Logger).Debug": 1,
+ "(*log/slog.Logger).Info": 1,
+ "(*log/slog.Logger).Warn": 1,
+ "(*log/slog.Logger).Error": 1,
+ "(*log/slog.Logger).DebugContext": 2,
+ "(*log/slog.Logger).InfoContext": 2,
+ "(*log/slog.Logger).WarnContext": 2,
+ "(*log/slog.Logger).ErrorContext": 2,
+}
+
+var attrFuncs = map[string]struct{}{
+ "log/slog.String": {},
+ "log/slog.Int64": {},
+ "log/slog.Int": {},
+ "log/slog.Uint64": {},
+ "log/slog.Float64": {},
+ "log/slog.Bool": {},
+ "log/slog.Time": {},
+ "log/slog.Duration": {},
+ "log/slog.Group": {},
+ "log/slog.Any": {},
+}
+
+func run(pass *analysis.Pass, opts *Options) {
+ visit := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+ filter := []ast.Node{(*ast.CallExpr)(nil)}
+
+ visit.Preorder(filter, func(node ast.Node) {
+ call := node.(*ast.CallExpr)
+
+ fn := typeutil.StaticCallee(pass.TypesInfo, call)
+ if fn == nil {
+ return
+ }
+
+ argsPos, ok := slogFuncs[fn.FullName()]
+ if !ok {
+ return
+ }
+
+ // NOTE: we assume that the arguments have already been validated by govet.
+ args := call.Args[argsPos:]
+ if len(args) == 0 {
+ return
+ }
+
+ var keys []ast.Expr
+ var attrs []ast.Expr
+
+ for i := 0; i < len(args); i++ {
+ typ := pass.TypesInfo.TypeOf(args[i])
+ if typ == nil {
+ continue
+ }
+ switch typ.String() {
+ case "string":
+ keys = append(keys, args[i])
+ i++ // skip the value.
+ case "log/slog.Attr":
+ attrs = append(attrs, args[i])
+ }
+ }
+
+ switch {
+ case opts.KVOnly && len(attrs) > 0:
+ pass.Reportf(call.Pos(), "attributes should not be used")
+ case opts.AttrOnly && len(attrs) < len(args):
+ pass.Reportf(call.Pos(), "key-value pairs should not be used")
+ case 0 < len(attrs) && len(attrs) < len(args):
+ pass.Reportf(call.Pos(), "key-value pairs and attributes should not be mixed")
+ }
+
+ if opts.NoRawKeys && rawKeysUsed(pass.TypesInfo, keys, attrs) {
+ pass.Reportf(call.Pos(), "raw keys should not be used")
+ }
+ if opts.ArgsOnSepLines && argsOnSameLine(pass.Fset, call, keys, attrs) {
+ pass.Reportf(call.Pos(), "arguments should be put on separate lines")
+ }
+ })
+}
+
+func rawKeysUsed(info *types.Info, keys, attrs []ast.Expr) bool {
+ isConst := func(expr ast.Expr) bool {
+ ident, ok := expr.(*ast.Ident)
+ return ok && ident.Obj != nil && ident.Obj.Kind == ast.Con
+ }
+
+ for _, key := range keys {
+ if !isConst(key) {
+ return true
+ }
+ }
+
+ for _, attr := range attrs {
+ switch attr := attr.(type) {
+ case *ast.CallExpr: // e.g. slog.Int()
+ fn := typeutil.StaticCallee(info, attr)
+ if _, ok := attrFuncs[fn.FullName()]; ok && !isConst(attr.Args[0]) {
+ return true
+ }
+
+ case *ast.CompositeLit: // slog.Attr{}
+ isRawKey := func(kv *ast.KeyValueExpr) bool {
+ return kv.Key.(*ast.Ident).Name == "Key" && !isConst(kv.Value)
+ }
+
+ switch len(attr.Elts) {
+ case 1: // slog.Attr{Key: ...} | slog.Attr{Value: ...}
+ kv := attr.Elts[0].(*ast.KeyValueExpr)
+ if isRawKey(kv) {
+ return true
+ }
+ case 2: // slog.Attr{..., ...} | slog.Attr{Key: ..., Value: ...}
+ kv1, ok := attr.Elts[0].(*ast.KeyValueExpr)
+ if ok {
+ kv2 := attr.Elts[1].(*ast.KeyValueExpr)
+ if isRawKey(kv1) || isRawKey(kv2) {
+ return true
+ }
+ } else if !isConst(attr.Elts[0]) {
+ return true
+ }
+ }
+ }
+ }
+
+ return false
+}
+
+func argsOnSameLine(fset *token.FileSet, call ast.Expr, keys, attrs []ast.Expr) bool {
+ if len(keys)+len(attrs) <= 1 {
+ return false // special case: slog.Info("msg", "key", "value") is ok.
+ }
+
+ l := len(keys) + len(attrs) + 1
+ args := make([]ast.Expr, 0, l)
+ args = append(args, call)
+ args = append(args, keys...)
+ args = append(args, attrs...)
+
+ lines := make(map[int]struct{}, l)
+ for _, arg := range args {
+ line := fset.Position(arg.Pos()).Line
+ if _, ok := lines[line]; ok {
+ return true
+ }
+ lines[line] = struct{}{}
+ }
+
+ return false
+}