.golangci.yml

# This file contains all available configuration options
# with their default values.
# options for analysis running
run:
  # default concurrency is a available CPU number
  # concurrency: 4
  # timeout for analysis, e.g. 30s, 5m, default is 1m
  timeout: 5m
  # exit code when at least one issue was found, default is 1
  issues-exit-code: 1
  # include test files or not, default is true
  tests: true
  # list of build tags, all linters use it. Default is empty list.
  build-tags:
  # - mytag
  # which dirs to skip: issues from them won't be reported;
  # can use regexp here: generated.*, regexp is applied on full path;
  # default value is empty list, but default dirs are skipped independently
  # from this option's value (see skip-dirs-use-default).
  # "/" will be replaced by current OS file path separator to properly work
  # on Windows.
  skip-dirs:
    - internal/client/graphql
    - internal/handler/graphql
    - internal/handler/graphql/generated
  # default is true. Enables skipping of directories:
  #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
  skip-dirs-use-default: true
  # which files to skip: they will be analyzed, but issues from them
  # won't be reported. Default value is empty list, but there is
  # no need to include all autogenerated files, we confidently recognize
  # autogenerated files. If it's not please let us know.
  # "/" will be replaced by current OS file path separator to properly work
  # on Windows.
  skip-files:
    - internal/handler/graphql/schema.resolvers.go
    - pkg/fxmod/connect/trace.go
  # - ".*\\.my\\.go$"
  # - lib/bad.go
  # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
  # If invoked with -mod=readonly, the go command is disallowed from the implicit
  # automatic updating of go.mod described above. Instead, it fails when any changes
  # to go.mod are needed. This setting is most useful to check that go.mod does
  # not need updates, such as in a continuous integration and testing system.
  # If invoked with -mod=vendor, the go command assumes that the vendor
  # directory holds the correct copies of dependencies and ignores
  # the dependency descriptions in go.mod.
  # modules-download-mode: readonly|release|vendor
  modules-download-mode: readonly
  # Allow multiple parallel golangci-lint instances running.
  # If false (default) - golangci-lint acquires file lock on start.
  allow-parallel-runners: false
# output configuration options
output:
  # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
  format: colored-line-number
  # print lines of code with issue, default is true
  print-issued-lines: true
  # print linter name in the end of issue text, default is true
  print-linter-name: true
  # make issues output unique by line, default is true
  uniq-by-line: true
  # add a prefix to the output file references; default is no prefix
  path-prefix: ""
# all available settings of specific linters
linters-settings:
  ireturn:
    # ireturn does not allow using `allow` and `reject` settings at the same time.
    # Both settings are lists of the keywords and regular expressions matched to interface or package names.
    # keywords:
    # - `empty` for `interface{}`
    # - `error` for errors
    # - `stdlib` for standard library
    # - `anon` for anonymous interfaces
    # - `generic` for generic interfaces added in go 1.18

    # By default, it allows using errors, empty interfaces, anonymous interfaces,
    # and interfaces provided by the standard library.
    allow:
      - anon
      - error
      - empty
      - stdlib
      # You can specify idiomatic endings for interface
      - (or|er)$
      - go.uber.org/fx.Option
      - go.temporal.io/sdk/client.Client
      - orgv1beta1connect.OrgServiceClient
      - profilev1beta1connect.ProfileServiceClient
      - licensev1beta1connect.LicenseServiceClient
  varnamelen:
    # The longest distance, in source lines, that is being considered a "small scope".
    # Variables used in at most this many lines will be ignored.
    # Default: 5
    max-distance: 6
    # The minimum length of a variable's name that is considered "long".
    # Variable names that are at least this long will be ignored.
    # Default: 3
    min-name-length: 2
    # Check method receivers.
    # Default: false
    check-receiver: false
    # Check named return values.
    # Default: false
    check-return: true
    # Check type parameters.
    # Default: false
    check-type-param: true
    # Ignore "ok" variables that hold the bool return value of a type assertion.
    # Default: false
    ignore-type-assert-ok: true
    # Ignore "ok" variables that hold the bool return value of a map index.
    # Default: false
    ignore-map-index-ok: true
    # Ignore "ok" variables that hold the bool return value of a channel receive.
    # Default: false
    ignore-chan-recv-ok: true
    # Optional list of variable names that should be ignored completely.
    # Default: []
    ignore-names:
      - err
    # Optional list of variable declarations that should be ignored completely.
    # Entries must be in one of the following forms (see below for examples):
    # - for variables, parameters, named return values, method receivers, or type parameters:
    #   <name> <type>  (<type> can also be a pointer/slice/map/chan/...)
    # - for constants: const <name>
    #
    # Default: []
    ignore-decls:
      - c echo.Context
      - t testing.T
      - f *foo.Bar
      - e error
      - i int
      - const C
      - T any
      - m map[string]int
      - ok bool
  govet:
    # Report about shadowed variables.
    # Default: false
    check-shadowing: true
    # Settings per analyzer.
    settings:
      # Analyzer name, run `go tool vet help` to see all analyzers.
      printf:
        # Comma-separated list of print function names to check (in addition to default, see `go tool vet help printf`).
        # Default: []
        funcs:
          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
      shadow:
        # Whether to be strict about shadowing; can be noisy.
        # Default: false
        strict: true
      unusedresult:
        # Comma-separated list of functions whose results must be used
        # (in addition to defaults context.WithCancel,context.WithDeadline,context.WithTimeout,context.WithValue,
        # errors.New,fmt.Errorf,fmt.Sprint,fmt.Sprintf,sort.Reverse)
        # Default []
        funcs:
          - pkg.MyFunc
        # Comma-separated list of names of methods of type func() string whose results must be used
        # (in addition to default Error,String)
        # Default []
        stringmethods:
          - MyMethod
    # Enable all analyzers.
    # Default: false
    enable-all: true
    disable:
      - fieldalignment
  wrapcheck:
    # An array of strings that specify substrings of signatures to ignore.
    # If this set, it will override the default set of ignored signatures.
    # See https://github.com/tomarrell/wrapcheck#configuration for more information.
    # Default: [".Errorf(", "errors.New(", "errors.Unwrap(", ".Wrap(", ".Wrapf(", ".WithMessage(", ".WithMessagef(", ".WithStack("]
    ignoreSigs:
      - .Errorf(
      - errors.New(
      - errors.Unwrap(
      - .Wrap(
      - .Wrapf(
      - .WithMessage(
      - .WithMessagef(
      - .WithStack(
    # An array of strings that specify regular expressions of signatures to ignore.
    # Default: []
    ignoreSigRegexps:
      - \.New.*Error\(
    # An array of strings that specify globs of packages to ignore.
    # Default: []
    ignorePackageGlobs:
      - encoding/*
      - github.com/kevinmichaelchen/*
    # An array of strings that specify regular expressions of interfaces to ignore.
    # Default: []
    ignoreInterfaceRegexps:
      - ^(?i)c(?-i)ach(ing|e)
  gci:
    # Section configuration to compare against.
    # Section names are case-insensitive and may contain parameters in ().
    # The default order of sections is `standard > default > custom > blank > dot`,
    # If `custom-order` is `true`, it follows the order of `sections` option.
    # Default: ["standard", "default"]
    sections:
      - standard # Standard section: captures all standard packages.
      - default # Default section: contains all imports that could not be matched to another section type.
      - prefix(github.com/kevinmichaelchen/temporal-saga-grpc) # Custom section: groups all imports with the specified Prefix.
      - blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled.
      - dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled.
    # Skip generated files.
    # Default: true
    skip-generated: false
    # Enable custom order of sections.
    # If `true`, make the section order the same as the order of `sections`.
    # Default: false
    custom-order: true
  depguard:
    # Rules to apply.
    #
    # Variables:
    # - File Variables
    #   you can still use and exclamation mark ! in front of a variable to say not to use it.
    #   Example !$test will match any file that is not a go test file.
    #
    #   `$all` - matches all go files
    #   `$test` - matches all go test files
    #
    # - Package Variables
    #
    #  `$gostd` - matches all of go's standard library (Pulled from `GOROOT`)
    #
    # Default: no rules.
    rules:
      # Name of a rule.
      main:
        # Packages that are not allowed where the value is a suggestion.
        deny:
          - pkg: "github.com/sirupsen/logrus"
            desc: Should be replaced by zerolog
          - pkg: "github.com/pkg/errors"
            desc: Should be replaced by standard lib errors package
  staticcheck:
    go: "1.20"
    checks: [ "all", "-SA1012", "-SA9003"]
  dogsled:
    # checks assignments with too many blank identifiers; default is 2
    max-blank-identifiers: 2
  dupl:
    # tokens count to trigger issue, 150 by default
    threshold: 100
  errcheck:
    # report about not checking of errors in type assertions: `a := b.(MyStruct)`;
    # default is false: such cases aren't reported by default.
    check-type-assertions: false
    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
    # default is false: such cases aren't reported by default.
    check-blank: false
    # [deprecated] comma-separated list of pairs of the form pkg:regex
    # the regex is used to ignore names within pkg. (default "fmt:.*").
    # see https://github.com/kisielk/errcheck#the-deprecated-method for details
    #    ignore: fmt:.*,io/ioutil:^Read.*
    # path to a file containing a list of functions to exclude from checking
    # see https://github.com/kisielk/errcheck#excluding-functions for details
  #    exclude: /path/to/file.txt
  exhaustive:
    # indicates that switch statements are to be considered exhaustive if a
    # 'default' case is present, even if all enum members aren't listed in the
    # switch
    default-signifies-exhaustive: false
  funlen:
    lines: 80
    statements: 40
  revive:
    rules:
      - name: unused-parameter
        severity: warning
        disabled: false
        arguments:
          - allowRegex: "ctx"

#  gci:
# put imports beginning with prefix after 3rd-party packages;
# only support one prefix
# if not set, use goimports.local-prefixes
#    local-prefixes: github.com/kevinmichaelchen/temporal-saga-grpc
gocognit:
  # minimal code complexity to report, 30 by default (but we recommend 10-20)
  min-complexity: 10
nestif:
  # minimal complexity of if statements to report, 5 by default
  min-complexity: 4
goconst:
  # minimal length of string constant, 3 by default
  min-len: 3
  # minimal occurrences count to trigger, 3 by default
  min-occurrences: 3
gocritic:
  # Which checks should be enabled; can't be combined with 'disabled-checks';
  # See https://go-critic.github.io/overview#checks-overview
  # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`
  # By default list of stable checks is used.
  enabled-checks:
    - rangeValCopy
    - captLocal
  # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
  disabled-checks:
  # - regexpMust
  # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.
  # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
  enabled-tags:
  # - performance
  settings: # settings passed to gocritic
    captLocal: # must be valid enabled check name
      paramsOnly: true
    rangeValCopy:
      sizeThreshold: 32
gocyclo:
  # minimal code complexity to report, 30 by default (but we recommend 10-20)
  min-complexity: 10
godot:
  # check all top-level comments, not only declarations
  check-all: false
godox:
  # report any comments starting with keywords, this is useful for TODO or FIXME comments that
  # might be left in the code accidentally and should be resolved before merging
  keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting
    - NOTE
    - OPTIMIZE # marks code that should be optimized before merging
    - HACK # marks hack-arounds that should be removed before merging
gofmt:
  # simplify code: gofmt with `-s` option, true by default
  simplify: true
goheader:
  values:
    const:
    # define here const type values in format k:v, for example:
    # YEAR: 2020
    # COMPANY: MY COMPANY
    regexp:
    # define here regexp type values, for example
    # AUTHOR: .*@mycompany\.com
  template:
  # put here copyright header template for source code files, for example:
  #    {{ AUTHOR }} {{ COMPANY }} {{ YEAR }}
  #    SPDX-License-Identifier: Apache-2.0
  #
  #    Licensed under the Apache License, Version 2.0 (the "License");
  #    you may not use this file except in compliance with the License.
  #    You may obtain a copy of the License at:
  #
  #      http://www.apache.org/licenses/LICENSE-2.0
  #
  #    Unless required by applicable law or agreed to in writing, software
  #    distributed under the License is distributed on an "AS IS" BASIS,
  #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  #    See the License for the specific language governing permissions and
  #    limitations under the License.
  template-path:
  # also as alternative of directive 'template' you may put the path to file with the template source
goimports:
  # put imports beginning with prefix after 3rd-party packages;
  # it's a comma-separated list of prefixes
  local-prefixes: github.com/kevinmichaelchen/temporal-saga-grpc

gomnd:
  settings:
    mnd:
      # the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
      checks: argument,case,condition,operation,return,assign
gomodguard:
  allowed:
    modules:                                                        # List of allowed modules
    # - gopkg.in/yaml.v2
    domains:                                                        # List of allowed module domains
    # - golang.org
  blocked:
    modules:                                                        # List of blocked modules
    # - github.com/uudashr/go-module:                             # Blocked module
    #     recommendations:                                        # Recommended modules that should be used instead (Optional)
    #       - golang.org/x/mod
    #     reason: "`mod` is the official go.mod parser library."  # Reason why the recommended module should be used (Optional)
    versions:                                                       # List of blocked module version constraints
    # - github.com/mitchellh/go-homedir:                          # Blocked module with version constraint
    #     version: "< 1.1.0"                                      # Version constraint, see https://github.com/Masterminds/semver#basic-comparisons
    #     reason: "testing if blocked version constraint works."  # Reason why the version constraint exists. (Optional)
  # settings per analyzer
  settings:
    printf: # analyzer name, run `go tool vet help` to see all analyzers
      funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer
        - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
        - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
        - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
        - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
  # enable or disable analyzers by name
  enable:
    - atomicalign
  enable-all: false
  disable:
    - shadow
  disable-all: false
lll:
  # max line length, lines longer will be reported. Default is 120.
  # '\t' is counted as 1 character by default, and can be changed with the tab-width option
  line-length: 80
  # tab width in spaces. Default to 1.
  tab-width: 1
govet:
  # print struct with more effective memory layout or not, false by default
  suggest-new: true
misspell:
  # Correct spellings using locale preferences for US or UK.
  # Default is to use a neutral variety of English.
  # Setting locale to US will correct the British spelling of 'colour' to 'color'.
  locale: US
  ignore-words:
    - someword
nakedret:
  # make an issue if func has more lines of code than this setting and it has naked returns; default is 30
  max-func-lines: 30
prealloc:
  # XXX: we don't recommend using this linter before doing performance profiling.
  # For most programs usage of prealloc will be a premature optimization.
  # Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
  # True by default.
  simple: true
  range-loops: true # Report preallocation suggestions on range loops, true by default
  for-loops: false # Report preallocation suggestions on for loops, false by default
nolintlint:
  # Enable to ensure that nolint directives are all used. Default is true.
  allow-unused: false
  # Disable to ensure that nolint directives don't have a leading space. Default is true.
  allow-leading-space: true
  # Exclude following linters from requiring an explanation.  Default is [].
  allow-no-explanation: []
  # Enable to require an explanation of nonzero length after each nolint directive. Default is false.
  require-explanation: true
  # Enable to require nolint directives to mention the specific linter being suppressed. Default is false.
  require-specific: true
rowserrcheck:
  packages:
    - github.com/jmoiron/sqlx
testpackage:
  # regexp pattern to skip files
  skip-regexp: (export|internal)_test\.go
unparam:
  # Inspect exported functions, default is false. Set to true if no external program/library imports your code.
  # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
  # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
  # with golangci-lint call it on a directory with the changed file.
  check-exported: false
unused:
  # treat code as a program (not a library) and report unused exported identifiers; default is false.
  # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
  # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
  # with golangci-lint call it on a directory with the changed file.
  check-exported: false
whitespace:
  multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
  multi-func: false # Enforces newlines (or comments) after every multi-line function signature
wsl:
  # If true append is only allowed to be cuddled if appending value is
  # matching variables, fields or types on line above. Default is true.
  strict-append: true
  # Allow calls and assignments to be cuddled as long as the lines have any
  # matching variables, fields or types. Default is true.
  allow-assign-and-call: true
  # Allow multiline assignments to be cuddled. Default is true.
  allow-multiline-assign: true
  # Allow declarations (var) to be cuddled.
  allow-cuddle-declarations: false
  # Allow trailing comments in ending of blocks
  allow-trailing-comment: false
  # Force newlines in end of case at this limit (0 = never).
  force-case-trailing-whitespace: 0
  # Force cuddling of err checks with err var assignment
  force-err-cuddling: false
  # Allow leading comments to be separated with empty liens
  allow-separated-leading-comment: false
gofumpt:
  # Choose whether or not to use the extra rules that are disabled
  # by default
  extra-rules: false
    # The custom section can be used to define linter plugins to be loaded at runtime. See README doc
    #  for more info.
    #  custom:
    # Each custom linter should have a unique name.
    #    example:
    # The path to the plugin *.so. Can be absolute or local. Required for each custom linter
    #      path: /path/to/example.so
  # The description of the linter. Optional, just for documentation purposes.
  #      description: This is an example usage of a plugin linter.
  # Intended to point to the repo location of the linter. Optional, just for documentation purposes.
#      original-url: github.com/golangci/example-linter
linters:
  enable-all: true
  disable:
    - deadcode
    - depguard # TEMPORARY
    - errorlint # TEMPORARY
    - exhaustruct
    - exhaustivestruct
    - gochecknoglobals
    - godox
    - golint
    - gomnd
    - ifshort
    - interfacer
    - maligned
    - nosnakecase
    - prealloc
    - scopelint
    - structcheck
    - testpackage
    - varcheck
issues:
  # List of regexps of issue texts to exclude, empty list by default.
  # But independently from this option we use default exclude patterns,
  # it can be disabled by `exclude-use-default: false`. To list all
  # excluded by default patterns execute `golangci-lint run --help`
  exclude:
  # - abcdef
  # Excluding configuration per-path, per-linter, per-text and per-source
  exclude-rules:
    - path: test/mock
      linters:
        - revive
    - path: _test\.go
      linters:
        - gocyclo
        - errcheck
        - dupl
        - funlen
        - gosec
        - scopelint
        - unparam
        - gochecknoglobals
        - lll
        - goconst
    - path: test
      linters:
        - gocyclo
        - errcheck
        - dupl
        - gosec
        - scopelint
        - unparam
    # Exclude some staticcheck messages
    #    - linters:
    #        - staticcheck
    #      text: "SA9003:"
    #    - linters:
    #        - staticcheck
    #      text: "SA1012:"
    # Exclude lll issues for long lines with go:generate
    - linters:
        - lll
      source: "^//go:generate "
  # Independently from option `exclude` we use default exclude patterns,
  # it can be disabled by this option. To list all
  # excluded by default patterns execute `golangci-lint run --help`.
  # Default value for this option is true.
  exclude-use-default: false
  # The default value is false. If set to true exclude and exclude-rules
  # regular expressions become case sensitive.
  exclude-case-sensitive: false
  # The list of ids of default excludes to include or disable. By default it's empty.
  include:
    - EXC0002 # disable excluding of issues about comments from golint
  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
  max-issues-per-linter: 0
  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
  max-same-issues: 0
  # Show only new issues: if there are unstaged changes or untracked files,
  # only those changes are analyzed, else only changes in HEAD~ are analyzed.
  # It's a super-useful option for integration of golangci-lint into existing
  # large codebase. It's not practical to fix all existing issues at the moment
  # of integration: much better don't allow issues in new code.
  # Default is false.
  new: false
  # Show only new issues created after git revision `REV`
  # new-from-rev: REV
  # Show only new issues created in git patch with set file path.
  # new-from-patch: path/to/patch/file
severity:
  # Default value is empty string.
  # Set the default severity for issues. If severity rules are defined and the issues
  # do not match or no severity is provided to the rule this will be the default
  # severity applied. Severities should match the supported severity names of the
  # selected out format.
  # - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity
  # -   Checkstyle: https://checkstyle.sourceforge.io/property_types.html#severity
  # -       Github: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
  default-severity: error
  # The default value is false.
  # If set to true severity-rules regular expressions become case sensitive.
  case-sensitive: false
  # Default value is empty list.
  # When a list of severity rules are provided, severity information will be added to lint
  # issues. Severity rules have the same filtering capability as exclude rules except you
  # are allowed to specify one matcher per severity rule.
  # Only affects out formats that support setting severity information.
  rules:
    - linters:
        - dupl
      severity: info