| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you 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. |
| |
| |
| # 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: |
| |
| # 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). |
| skip-dirs: |
| |
| # 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. |
| skip-files: |
| |
| # output configuration options |
| output: |
| # colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions |
| # 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: "" |
| |
| # sorts results by: filepath, line and column |
| sort-results: false |
| |
| |
| # all available settings of specific linters |
| linters-settings: |
| 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 |
| |
| # list of functions to exclude from checking, where each entry is a single function to exclude. |
| # see https://github.com/kisielk/errcheck#excluding-functions for details |
| exclude-functions: |
| |
| errchkjson: |
| # with check-error-free-encoding set to true, errchkjson does warn about errors |
| # from json encoding functions that are safe to be ignored, |
| # because they are not possible to happen (default false) |
| # |
| # if check-error-free-encoding is set to true and errcheck linter is enabled, |
| # it is recommended to add the following exceptions to prevent from false positives: |
| # |
| # linters-settings: |
| # errcheck: |
| # exclude-functions: |
| # - encoding/json.Marshal |
| # - encoding/json.MarshalIndent |
| # - (*encoding/json.Encoder).Encode |
| check-error-free-encoding: false |
| # if report-no-exported is true, encoding a struct without exported fields is reported as issue (default false) |
| report-no-exported: false |
| |
| errorlint: |
| # Check whether fmt.Errorf uses the %w verb for formatting errors. See the readme for caveats |
| errorf: true |
| # Check for plain type assertions and type switches |
| asserts: true |
| # Check for plain error comparisons |
| comparison: true |
| |
| funlen: |
| lines: 120 |
| statements: 120 |
| |
| gocognit: |
| # minimal code complexity to report, 30 by default (but we recommend 10-20) |
| min-complexity: 20 |
| |
| goconst: |
| # minimal length of string constant, 3 by default |
| min-len: 3 |
| # minimum occurrences of constant string count to trigger issue, 3 by default |
| min-occurrences: 3 |
| # ignore test files, false by default |
| ignore-tests: false |
| # look for existing constants matching the values, true by default |
| match-constant: true |
| # search also for duplicated numbers, false by default |
| numbers: false |
| # minimum value, only works with goconst.numbers, 3 by default |
| min: 3 |
| # maximum value, only works with goconst.numbers, 3 by default |
| max: 3 |
| # ignore when constant is not used as function argument, true by default |
| ignore-calls: true |
| |
| 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: |
| |
| # 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 passed to gocritic. |
| # The settings key is the name of a supported gocritic checker. |
| # The list of supported checkers can be find in https://go-critic.github.io/overview. |
| settings: |
| captLocal: # must be valid enabled check name |
| # whether to restrict checker to params only (default true) |
| paramsOnly: true |
| elseif: |
| # whether to skip balanced if-else pairs (default true) |
| skipBalanced: true |
| hugeParam: |
| # size in bytes that makes the warning trigger (default 80) |
| sizeThreshold: 80 |
| rangeExprCopy: |
| # size in bytes that makes the warning trigger (default 512) |
| sizeThreshold: 512 |
| # whether to check test functions (default true) |
| skipTestFuncs: true |
| rangeValCopy: |
| # size in bytes that makes the warning trigger (default 128) |
| sizeThreshold: 128 |
| # whether to check test functions (default true) |
| skipTestFuncs: true |
| underef: |
| # whether to skip (*x).method() calls where x is a pointer receiver (default true) |
| skipRecvDeref: true |
| |
| gocyclo: |
| # minimal code complexity to report, 30 by default (but we recommend 10-20) |
| min-complexity: 10 |
| |
| godot: |
| # comments to be checked: `declarations`, `toplevel`, or `all` |
| scope: declarations |
| # list of regexps for excluding particular comment lines from check |
| exclude: |
| # example: exclude comments which contain numbers |
| # - '[0-9]+' |
| # check that each sentence starts with a capital letter |
| capital: 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 |
| |
| gofmt: |
| # simplify code: gofmt with `-s` option, true by default |
| simplify: true |
| |
| goimports: |
| # put imports beginning with prefix after 3rd-party packages; |
| # it's a comma-separated list of prefixes |
| local-prefixes: |
| |
| golint: |
| # minimal confidence for issues, default is 0.8 |
| min-confidence: 0.8 |
| |
| 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 |
| # ignored-numbers: 1000 |
| # ignored-files: magic_.*.go |
| # ignored-functions: math.* |
| |
| gomoddirectives: |
| # Allow local `replace` directives. Default is false. |
| replace-local: false |
| # List of allowed `replace` directives. Default is empty. |
| replace-allow-list: |
| # Allow to not explain why the version has been retracted in the `retract` directives. Default is false. |
| retract-allow-no-explanation: false |
| # Forbid the use of the `exclude` directives. Default is false. |
| exclude-forbidden: false |
| |
| 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) |
| local_replace_directives: false # Set to true to raise lint issues for packages that are loaded from a local path via replace directive |
| |
| gosec: |
| # To select a subset of rules to run. |
| # Available rules: https://github.com/securego/gosec#available-rules |
| includes: |
| - G401 |
| - G306 |
| - G101 |
| # To specify a set of rules to explicitly exclude. |
| # Available rules: https://github.com/securego/gosec#available-rules |
| excludes: |
| - G204 |
| - G401 |
| # Exclude generated files |
| exclude-generated: true |
| # Filter out the issues with a lower severity than the given value. Valid options are: low, medium, high. |
| severity: "low" |
| # Filter out the issues with a lower confidence than the given value. Valid options are: low, medium, high. |
| confidence: "low" |
| # To specify the configuration of rules. |
| # The configuration of rules is not fully documented by gosec: |
| # https://github.com/securego/gosec#configuration |
| # https://github.com/securego/gosec/blob/569328eade2ccbad4ce2d0f21ee158ab5356a5cf/rules/rulelist.go#L60-L102 |
| config: |
| G306: "0600" |
| G101: |
| pattern: "(?i)example" |
| ignore_entropy: false |
| entropy_threshold: "80.0" |
| per_char_threshold: "3.0" |
| truncate: "32" |
| |
| gosimple: |
| # Select the Go version to target. The default is '1.13'. |
| go: "1.19" |
| # https://staticcheck.io/docs/options#checks |
| checks: [ "all" ] |
| |
| govet: |
| # report about shadowed variables |
| check-shadowing: false |
| |
| # 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 |
| # run `go tool vet help` to see all analyzers |
| enable: |
| # - atomicalign |
| enable-all: true |
| disable: |
| - shadow |
| - fieldalignment |
| disable-all: false |
| |
| depguard: |
| list-type: blacklist |
| include-go-root: false |
| packages: |
| # - github.com/sirupsen/logrus |
| packages-with-error-message: |
| # specify an error message to output when a blacklisted package is used |
| # - github.com/sirupsen/logrus: "logging is allowed only by logutils.Log" |
| |
| ifshort: |
| # Maximum length of variable declaration measured in number of lines, after which linter won't suggest using short syntax. |
| # Has higher priority than max-decl-chars. |
| max-decl-lines: 1 |
| # Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax. |
| max-decl-chars: 30 |
| |
| 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: 160 |
| # tab width in spaces. Default to 1. |
| tab-width: 4 |
| |
| makezero: |
| # Allow only slices initialized with a length of zero. Default is false. |
| always: false |
| |
| maligned: |
| # 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: |
| - automizely |
| |
| 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 |
| |
| nestif: |
| # minimal complexity of if statements to report, 5 by default |
| min-complexity: 5 |
| |
| nilnil: |
| # By default, nilnil checks all returned types below. |
| checked-types: |
| - ptr |
| - func |
| - iface |
| - map |
| - chan |
| |
| nlreturn: |
| # size of the block (including return statement that is still "OK") |
| # so no return split required. |
| block-size: 1 |
| |
| nolintlint: |
| # Disable to ensure that all nolint directives actually have an effect. Default is false. |
| 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: false |
| # Enable to require nolint directives to mention the specific linter being suppressed. Default is false. |
| require-specific: false |
| |
| 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 |
| |
| promlinter: |
| # Promlinter cannot infer all middlewares name in static analysis. |
| # Enable strict mode will also include the errors caused by failing to parse the args. |
| strict: false |
| # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage. |
| disabled-linters: |
| # - "Help" |
| # - "MetricUnits" |
| # - "Counter" |
| # - "HistogramSummaryReserved" |
| # - "MetricTypeInName" |
| # - "ReservedChars" |
| # - "CamelCase" |
| # - "lintUnitAbbreviations" |
| |
| predeclared: |
| # comma-separated list of predeclared identifiers to not report on |
| ignore: "" |
| # include method names and field names (i.e., qualified names) in checks |
| q: false |
| |
| rowserrcheck: |
| packages: |
| - github.com/jmoiron/sqlx |
| |
| revive: |
| # see https://github.com/mgechev/revive#available-rules for details. |
| ignore-generated-header: true |
| severity: warning |
| rules: |
| - name: indent-error-flow |
| severity: warning |
| |
| staticcheck: |
| # Select the Go version to target. The default is '1.13'. |
| go: "1.19" |
| # https://staticcheck.io/docs/options#checks |
| checks: [ "all" ] |
| |
| stylecheck: |
| # Select the Go version to target. The default is '1.13'. |
| go: "1.19" |
| # https://staticcheck.io/docs/options#checks |
| checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ] |
| # https://staticcheck.io/docs/options#dot_import_whitelist |
| dot-import-whitelist: |
| # https://staticcheck.io/docs/options#initialisms |
| initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS" ] |
| # https://staticcheck.io/docs/options#http_status_code_whitelist |
| http-status-code-whitelist: [] |
| |
| tagliatelle: |
| # check the struck tag name case |
| case: |
| # use the struct field name to check the name of the struct tag |
| use-field-name: true |
| rules: |
| # any struct tag type can be used. |
| # support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower` |
| json: snake |
| |
| 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: |
| # Select the Go version to target. The default is '1.13'. |
| go: "1.19" |
| |
| 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: |
| # See https://github.com/bombsimon/wsl/blob/master/doc/configuration.md for |
| # documentation of available settings. These are the defaults for |
| # `golangci-lint`. |
| allow-assign-and-anything: false |
| allow-assign-and-call: true |
| allow-cuddle-declarations: false |
| allow-multiline-assign: true |
| allow-separated-leading-comment: false |
| allow-trailing-comment: false |
| force-case-trailing-whitespace: 0 |
| force-err-cuddling: false |
| force-short-decl-cuddling: false |
| strict-append: true |
| |
| linters: |
| enable: |
| - dogsled |
| - forcetypeassert |
| - funlen |
| - goconst |
| - govet |
| - gofmt |
| - goimports |
| - lll |
| - megacheck |
| - misspell |
| - nilnil |
| - revive |
| disable: |
| - maligned |
| - prealloc |
| - scopelint |
| disable-all: false |
| presets: |
| - bugs |
| - unused |
| - sql |
| fast: false |
| |
| 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: |
| - G404 |
| - SA1029 |
| |
| # Excluding configuration per-path, per-linter, per-text and per-source |
| exclude-rules: |
| # Exclude some linters from running on tests files. |
| - path: _test\.go |
| linters: |
| - cyclop |
| - dupl |
| - errcheck |
| - funlen |
| - gocognit |
| - goconst |
| - gocritic |
| - gocyclo |
| - gosec |
| - lll |
| - thelper |
| - wrapcheck |
| |
| # Exclude known linters from partially hard-vendored code, |
| # which is impossible to exclude via "nolint" comments. |
| - path: internal/hmac/ |
| text: "weak cryptographic primitive" |
| linters: |
| - gosec |
| |
| # Exclude some staticcheck messages |
| - linters: |
| - staticcheck |
| text: "SA9003:" |
| |
| # 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: true |
| |
| # 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: true |
| |
| # Show only new issues created after git revision `REV` |
| new-from-rev: "" |
| |
| # Show only new issues created in git patch with set file path. |
| new-from-patch: |
| |
| # Fix found issues (if it's supported by the linter) |
| fix: true |
| |
| 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 |