Skip to content
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.

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

can't run linter goanalysis_metalinter: *inspect*: failed to load package sugar: could not load export data: no export data for #248 #2788

Closed
3 of 4 tasks
edouard-lopez opened this issue Apr 29, 2022 · 7 comments · Fixed by #3025
Labels
area: cgo Related to CGO question Further information is requested

Comments

@edouard-lopez
Copy link

edouard-lopez commented Apr 29, 2022

Welcome

  • Yes, I'm using a binary release within 2 latest major releases. Only such installations are supported.
  • Yes, I've searched similar issues on GitHub and didn't find any.
  • Yes, I've included all information below (version, config, etc).
  • Yes, I've tried with the standalone linter if available. (https://golangci-lint.run/usage/linters/)

Description of the problem

make lint
go install github.com/golangci/golangci-lint/cmd/[email protected]
golangci-lint run --skip-dirs cmd/pactgoconsumerexample_tester
ERRO Running error: 1 error occurred:
	* can't run linter goanalysis_metalinter: inspect: failed to load package sugar: could not load export data: no export data for "github.com/pact-foundation/pact-go/v2/sugar"
 
make: *** [Makefile:85: lint] Error 3

Version of golangci-lint

$ golangci-lint --version
golangci-lint has version v1.45.2 built from (unknown, mod sum: "h1:9I3PzkvscJkFAQpTQi5Ga0V4qWdJERajX1UZ7QqkW+I=") on (unknown)

Configuration file

linters:
  enable-all: true
  disable:
    # because are deprecated
    - interfacer
    - scopelint
    - golint
    - maligned
    # because refuse this rules with the internal policy (get more detail in associated linters-settings rules)
    - exhaustivestruct
    - nestif
    - cyclop
    - gci
    - godot
    - gofmt
    - gofumpt
    - goheader
    - goimports
    - depguard
    - ifshort
    - importas
    - misspell
    - predeclared
    - paralleltest
    - nolintlint
    - revive
    - tagliatelle
    - testpackage
    - thelper
    - whitespace
    - wrapcheck # should be used after define the error strategie context
    - wsl
    - gochecknoinits # configuration not documented
    - ireturn

run:
  # timeout for analysis, e.g. 30s, 5m, default is 1m
  timeout: 3m

# https://golangci-lint.run/usage/configuration/
linters-settings:
  #cyclop:
  # the maximal code complexity to report
  #max-complexity: 10
  # the maximal average package complexity. If it's higher than 0.0 (float) the check is enabled (default 0.0)
  #package-average: 0.0
  # should ignore tests (default false)
  #skip-tests: false
  ## internal note mm: disable because cover by gocyclo tool which is more explicit in his documentation

  dogsled:
    # checks assignments with too many blank identifiers; default is 2
    ## internal note mm: if you need avoid more, maybe your function don't doing what is was intended when it was written
    max-blank-identifiers: 1

  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: true

    # [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
    # default: fmt:.*,io/ioutil:^Read.*
    ignore: fmt:.*

    # path to a file containing a list of functions to exclude from checking
    # see https://github.com/kisielk/errcheck#excluding-functions for details
    # default: /path/to/file.txt
    exclude:

  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: false
    # Check for plain error comparisons
    comparison: false

  exhaustive:
    # check switch statements in generated files also
    check-generated: false
    # 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

  exhaustivestruct:
    # Struct Patterns is list of expressions to match struct packages and names
    # The struct packages have the form example.com/package.ExampleStruct
    # The matching patterns can use matching syntax from https://pkg.go.dev/path#Match
    # If this list is empty, all structs are tested.
    #struct-patterns:
    #  - '*.Test'
    #  - 'example.com/package.ExampleStruct'
    ## internal note mm: disable because too wordy and we have more exceptions like json payload api

  forbidigo:
    # Forbid the following identifiers
    forbid:
      - fmt.Errorf # consider errors.Errorf in github.com/pkg/errors
      - fmt.Print.* # too much log noise
      - ginkgo\\.F.* # these are used just for local development
    # Exclude godoc examples from forbidigo checks.  Default is true.
    exclude-godoc-examples: true

  funlen:
    lines: 80
    statements: 40

  gci:
    # put imports beginning with prefix after 3rd-party packages;
    # only support one prefix
    # if not set, use goimports.local-prefixes
    local-prefixes: git.foo.bar/

  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
    # disable because already cover with gocognit to (cognitive complexity) and gocyclo (cyclomatic complexity)

  goconst:
    # minimal length of string constant, 3 by default
    min-len: 0
    # minimal occurrences count to trigger, 3 by default
    min-occurrences: 2
    ## internal note mm: no string hard coded 2 times

  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:
      - truncateCmp
      - nestingReduce
      - unnamedResult

    # 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
    disabled-tags:
      - experimental

    # 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: 256
      nestingReduce:
        # min number of statements inside a branch to trigger a warning (default 5)
        bodyWidth: 5
      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: 32
        # whether to check test functions (default true)
        skipTestFuncs: true
      # ruleguard:
      # path to a gorules file for the ruleguard checker
      #  rules: ''
      ## internal note mm: useless
      truncateCmp:
        # whether to skip int/uint/uintptr types (default true)
        skipArchDependent: true
      underef:
        # whether to skip (*x).method() calls where x is a pointer receiver (default true)
        skipRecvDeref: true
      unnamedResult:
        # whether to check exported functions
        checkExported: 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: all
  # 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
  # disable because re-write files without be able just print the detection

  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
      - BUG
      - FIXME
      - nolint

  # gofmt:
  # simplify code: gofmt with `-s` option, true by default
  # simplify: true
  # disable because re-write files without be able just print the detection

  # gofumpt:
  #  # Choose whether or not to use the extra rules that are disabled
  #  # by default
  #  extra-rules: false
  # disable because re-write files without be able just print the detection

  # goheader:
  #  values:
  #    const:
  # define here const type values in format k:v, for example:
  # 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:
  # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time.
  #
  # {{ 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
  # useless to the mm

  # goimports:
  # put imports beginning with prefix after 3rd-party packages;
  # it's a comma-separated list of prefixes
  #  local-prefixes: github.com/org/project
  # disable because re-write files without be able just print the detection

  # golint:
  # minimal confidence for issues, default is 0.8
  #  min-confidence: 0.8
  # deprecated

  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:
    #  - launchpad.net/gocheck
    # 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:
      # List of allowed modules
      modules:
        # - gopkg.in/yaml.v2
      # List of allowed module domains
      domains:
        # - golang.org
    blocked:
      # List of blocked modules
      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)
      # List of blocked module version constraints
      versions:
        # - 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: true # 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:
      - G101 # Look for hard coded credentials
      - G102 # Bind to all interfaces
      - G103 # Audit the use of unsafe block
      - G104 # Audit errors not checked
      - G106 # Audit the use of ssh.InsecureIgnoreHostKey
      - G107 # Url provided to HTTP request as taint input
      - G108 # Profiling endpoint automatically exposed on /debug/pprof
      - G109 # Potential Integer overflow made by strconv.Atoi result conversion to int16/32
      - G110 # Potential DoS vulnerability via decompression bomb
    # To specify a set of rules to explicitly exclude.
    # Available rules: https://github.com/securego/gosec#available-rules
    excludes:
      - G201 # SQL query construction using format string
      - G202 # SQL query construction using string concatenation
      - G203 # Use of unescaped data in HTML templates
      - G204 # Audit use of command execution
      - G301 # Poor file permissions used when creating a directory
      - G302 # Poor file permissions used with chmod
      - G303 # Creating tempfile using a predictable path
      - G304 # File path provided as taint input
      - G305 # File traversal when extracting zip/tar archive
      - G306 # Poor file permissions used when writing to a new file
      - G307 # Deferring a method which returns an error
      - G401 # Detect the usage of DES, RC4, MD5 or SHA1
      - G402 # Look for bad TLS connection settings
      - G403 # Ensure minimum RSA key length of 2048 bits
      - G404 # Insecure random number source (rand)
      - G501 # Import blocklist: crypto/md5
      - G502 # Import blocklist: crypto/des
      - G503 # Import blocklist: crypto/rc4
      - G504 # Import blocklist: net/http/cgi
      - G505 # Import blocklist: crypto/sha1
      - G601 # Implicit memory aliasing of items from a range statement
    # 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"
    # internal note: don't use specific documentation because not commented
    # use only mis block

  gosimple:
    # Select the Go version to target. The default is '1.13'.
    go: "1.16"

  govet:
    # report about shadowed variables
    check-shadowing: true

    # 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:
      - unusedwrite
      - fieldalignment
      # - shadow
    #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"
  # internal note mm: useless

  # 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: 1
  # internal note mm: special case to if statement useless and cover by general rules

  #importas:
  #  # if set to `true`, force to use alias.
  #  no-unaliased: true
  #  # List of aliases
  #  alias:
  #    # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
  #    - pkg: knative.dev/serving/pkg/apis/serving/v1
  #      alias: servingv1
  #    # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
  #    - pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
  #      alias: autoscalingv1alpha1
  #    # You can specify the package path by regular expression,
  #    # and alias by regular expression expansion syntax like below.
  #    # see https://github.com/julz/importas#use-regular-expression for details
  #    - pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+)
  #      alias: $1$2
  # internal note mm: useless

  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: 120
    # tab width in spaces. Default to 1.
    tab-width: 1

  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
  # internal note mm: deprecated

  # 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
  # internal note mm: Bad working with easy word like langugae or other example. Too update the file instead of return a wraning

  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: 10

  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: true # Report preallocation suggestions on for loops, false by default

  # promlinter:
  #   # Promlinter cannot infer all metrics 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"
  # internal note mm: useless

  #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
  # internal note mm: alreadt cover by compiler

  #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: false
  # internal note mm: cover bby godox (no usage of nolint directives)

  rowserrcheck:
    packages:
      - github.com/jmoiron/sqlx
      - database/sql

  #revive:
  #  # see https://github.com/mgechev/revive#available-rules for details.
  #  ignore-generated-header: true
  #  severity: warning
  #  rules:
  #    - name: indent-error-flow
  #      severity: warning
  # internal note mm: cover by any other tools

  staticcheck:
    # Select the Go version to target. The default is '1.13'.
    go: "1.16"

  stylecheck:
    # Select the Go version to target. The default is '1.13'.
    go: "1.16"

  # 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: camel
  #       yaml: camel
  #       xml: camel
  #       bson: camel
  #       avro: snake
  #       mapstructure: kebab
  ## internal note mm: not used because it does not support multiple cases

  #testpackage:
  #  # regexp pattern to skip files
  #  skip-regexp: ^.*_test\.go
  # internal note mm: useless because don't catch file name with different name of *_test.go (just package name)

  #thelper:
  #  # The following configurations enable all checks. It can be omitted because all checks are enabled by default.
  #  # You can enable only required checks deleting unnecessary checks.
  #  test:
  #    first: true
  #    name: true
  #    begin: true
  #  benchmark:
  #    first: true
  #    name: true
  #    begin: true
  #  tb:
  #    first: true
  #    name: true
  #    begin: true
  # internal note mm: useless

  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.16"

    #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
  # internal note mm: not enought mature

  #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.
  #  ignoreSigs:
  #    - .Errorf(
  #    - errors.New(
  #    - errors.Unwrap(
  #    - .Wrap(
  #    - .Wrapf(
  #    - .WithMessage(

  #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
  # internal note mm: more aggressive

  # 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

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:
  #  -

  # 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:
    #      - gocyclo
    #      - errcheck
    #      - dupl
    #      - gosec

    # 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: "SA1012:"

    - linters:
        - staticcheck
      text: "SA1000:"

    # Exclude lll issues for long lines with go:generate
    - linters:
        - lll
      source: "^//go:generate "
    - linters:
        - lll
      source: "^// @"

    - linters:
        - gocritic
      text: "hugeParam:"

    - linters:
        - goconst
        - funlen
        - gocognit
        - gocyclo
        - dupl
      path: _test\.go
    - linters:
        - errcheck
      source: defer # TODO: find a way of handling these errors to enable this check

    # Exclude some globals variable to built-in injection
    - linters:
        - gochecknoglobals
      text: "^appName "
    - linters:
        - gochecknoglobals
      text: "^appVersion "
    - linters:
        - gochecknoglobals
      text: "^appCommit "
    - linters:
        - varnamelen
      source: "ID "
    - linters:
        - dupl
      path: "handler.go" # only for the paxt example
    - linters:
        - dupl
      path: "_contract_test.go" # only for the paxt example

  # 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

  # Fix found issues (if it's supported by the linter)
  fix: false

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

Go environment

$ go version && go env
go version go1.18.1 linux/amd64
GO111MODULE=""
GOARCH="amd64"
GOBIN=""
GOCACHE="/root/.cache/go-build"
GOENV="/root/.config/go/env"
GOEXE=""
GOEXPERIMENT=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GOMODCACHE="/go/pkg/mod"
GONOPROXY="git.foo.bar"
GONOSUMDB="git.foo.bar"
GOOS="linux"
GOPATH="/go"
GOPRIVATE="git.foo.bar"
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/usr/local/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/usr/local/go/pkg/tool/linux_amd64"
GOVCS=""
GOVERSION="go1.18.1"
GCCGO="gccgo"
GOAMD64="v1"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/go/src/app/go.mod"
GOWORK=""
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build4191921493=/tmp/go-build -gno-record-gcc-switches"

Verbose output of running

$ golangci-lint cache clean
$ golangci-lint run -v
level=info msg="[config_reader] Config search paths: [./ /go/src/app/cmd /go/src/app /go/src /go / /root]"
level=info msg="[config_reader] Used config file .golangci.yaml"
level=info msg="[lintersdb] Active 59 linters: [asciicheck bidichk bodyclose containedctx contextcheck deadcode decorder dogsled dupl durationcheck errcheck errchkjson errname errorlint exhaustive exportloopref forbidigo forcetypeassert funlen gochecknoglobals gocognit goconst gocritic gocyclo godox goerr113 gomnd gomoddirectives gomodguard goprintffuncname gosec gosimple govet grouper ineffassign lll maintidx makezero nakedret nilerr nilnil nlreturn noctx prealloc promlinter rowserrcheck sqlclosecheck staticcheck structcheck stylecheck tenv tparallel typecheck unconvert unparam unused varcheck varnamelen wastedassign]"
level=info msg="[loader] Go packages loading at mode 575 (imports|name|types_sizes|deps|files|compiled_files|exports_file) took 15.783272652s"
level=info msg="[runner/filename_unadjuster] Pre-built 0 adjustments in 550.04µs"
level=warning msg="[linters context] bodyclose is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] contextcheck is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=info msg="[linters context/goanalysis] analyzers took 6.86029433s with top 10 stages: exhaustive: 2.792170481s, inspect: 1.041499869s, bidichk: 931.313432ms, printf: 697.791873ms, ctrlflow: 622.900032ms, findcall: 616.807947ms, the_only_name: 30.90699ms, gocritic: 28.985257ms, dupl: 25.783767ms, unconvert: 21.273275ms"
level=warning msg="[runner] Can't run linter goanalysis_metalinter: inspect: failed to load package sugar: could not load export data: no export data for \"github.com/pact-foundation/pact-go/v2/sugar\""
level=warning msg="[linters context] gosimple is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] nilerr is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] noctx is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] rowserrcheck is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] sqlclosecheck is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] staticcheck is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] structcheck is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] stylecheck is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] tparallel is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] unparam is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] wastedassign is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=warning msg="[linters context] unused is disabled because of go1.18. You can track the evolution of the go1.18 support by following the https://github.com/golangci/golangci-lint/issues/2649."
level=info msg="[runner] processing took 2.995µs with stages: max_same_issues: 430ns, nolint: 428ns, skip_dirs: 354ns, max_from_linter: 200ns, cgo: 191ns, path_prettifier: 177ns, uniq_by_line: 149ns, exclude: 139ns, filename_unadjuster: 138ns, skip_files: 136ns, autogenerated_exclude: 131ns, identifier_marker: 130ns, source_code: 53ns, path_shortener: 52ns, sort_results: 50ns, path_prefixer: 49ns, exclude-rules: 48ns, max_per_file_from_linter: 48ns, severity-rules: 46ns, diff: 46ns"
level=info msg="[runner] linters took 3.763087325s with stages: goanalysis_metalinter: 3.762952689s, bodyclose: 10.347µs, unparam: 7.06µs, wastedassign: 6.692µs, unused: 6.386µs, gosimple: 5.92µs, tparallel: 5.868µs, nilerr: 5.764µs, noctx: 5.403µs, sqlclosecheck: 5.199µs, staticcheck: 5.192µs, structcheck: 5.159µs, rowserrcheck: 4.951µs, stylecheck: 4.823µs, contextcheck: 4.457µs"
level=error msg="Running error: 1 error occurred:\n\t* can't run linter goanalysis_metalinter: inspect: failed to load package sugar: could not load export data: no export data for \"github.com/pact-foundation/pact-go/v2/sugar\"\n\n"
level=info msg="Memory: 197 samples, avg is 109.9MB, max is 638.6MB"
level=info msg="Execution took 19.552194031s"
make: *** [Makefile:88: lint] Error 3

Code example or link to a public repository

File importing and using sugar

package b2b

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"testing"

	"github.com/pact-foundation/pact-go/v2/sugar"

	"github.com/stretchr/testify/require"
)

func TestClientProduct(t *testing.T) {

	mockProvider, err := sugar.NewV2Pact(sugar.MockHTTPProviderConfig{
		Consumer: "ms.pact-consumer-example-for-go.b2b",
		Provider: "ms.pact-provider-example-for-go",
		PactDir:  "../../contracts",
	})
	require.NoError(t, err)

	t.Run("the product 1 exists", func(t *testing.T) {
		// Setup my expected interactions
		mockProvider.AddInteraction().
			Given("A product with id 1 exists").
			UponReceiving("a request Product 1").
			WithRequest(http.MethodGet, sugar.S("/api/v1/product/1")).
			WillRespondWith(http.StatusOK).
			WithJSONBody(sugar.Map{
				"id":             sugar.Integer(1),
				"name":           sugar.S("foo 2"),
				"brand":          sugar.S("bar 2"),
				"price_excl_tax": sugar.Decimal(20.125),
			}).
			WithHeader("Content-Type", sugar.Term("application/json; charset=utf-8", `application/json`))

		// Wrap my test in an callback function
		test := func(config sugar.MockServerConfig) error {
			var product Product
			var err error
			var myService B2b

			// set up the configuration for the driver
			baseURL := fmt.Sprintf("http://%s:%d", config.Host, config.Port)

			if err = os.Setenv("PACTGOCONSUMEREXAMPLE_PACTGOPROVIDEREXAMPLE_URL", baseURL); err != nil {
				return err
			}

			// instanciate the service
			if myService, err = New(); err != nil {
				return err
			}

			product, err = myService.Product(context.Background(), 1)
			require.NoError(t, err)

			require.Equal(t, 1, product.ID)
			require.Equal(t, "foo 2", product.Name)
			require.Equal(t, "bar 2", product.Brand)
			require.Equal(t, 20.125, product.Price)

			return nil
		}

		// Execute the test and check the expectation
		err := mockProvider.ExecuteTest(t, test)
		require.NoError(t, err)
	})
	t.Run("the product 2 doesn't exists", func(t *testing.T) {
		// Setup my expected interactions
		mockProvider.AddInteraction().
			Given("A product with id 2 does not exist").
			UponReceiving("a request Product 2").
			WithRequest(http.MethodGet, sugar.S("/api/v1/product/2")).
			WillRespondWith(http.StatusNotFound).
			WithHeader("Content-Type", sugar.Term("application/json; charset=utf-8", `application/json`))

		// Wrap my test in an callback function
		test := func(config sugar.MockServerConfig) error {
			var product Product
			var err error
			var myService B2b

			// set up the configuration for the driver
			baseURL := fmt.Sprintf("http://%s:%d", config.Host, config.Port)

			if err = os.Setenv("PACTGOCONSUMEREXAMPLE_PACTGOPROVIDEREXAMPLE_URL", baseURL); err != nil {
				return err
			}

			// instanciate the service
			if myService, err = New(); err != nil {
				return err
			}

			product, err = myService.Product(context.Background(), 2)
			require.Error(t, err)
			require.Equal(t, Product{}, product)

			return nil
		}

		// Execute the test and check the expectation
		err := mockProvider.ExecuteTest(t, test)
		require.NoError(t, err)
	})
}
@edouard-lopez edouard-lopez added the bug Something isn't working label Apr 29, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Apr 29, 2022

Hey, thank you for opening your first Issue ! 🙂 If you would like to contribute we have a guide for contributors.

@ldez ldez added question Further information is requested bug Something isn't working and removed bug Something isn't working question Further information is requested labels Apr 29, 2022
@ldez
Copy link
Member

ldez commented Apr 29, 2022

Hello,

I used your example (and added missing parts):

package sandbox

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"testing"

	"github.com/pact-foundation/pact-go/v2/sugar"
	"github.com/stretchr/testify/require"
)

type Product struct {
	ID    int
	Name  string
	Brand string
	Price float64
}

type B2b struct{}

func New() (B2b, error) {
	return B2b{}, nil
}

func (b B2b) Product(ctx context.Context, i int) (Product, error) {
	return Product{}, nil
}

func TestClientProduct(t *testing.T) {
	mockProvider, err := sugar.NewV2Pact(sugar.MockHTTPProviderConfig{
		Consumer: "ms.pact-consumer-example-for-go.b2b",
		Provider: "ms.pact-provider-example-for-go",
		PactDir:  "../../contracts",
	})
	require.NoError(t, err)

	t.Run("the product 1 exists", func(t *testing.T) {
		// Setup my expected interactions
		mockProvider.AddInteraction().
			Given("A product with id 1 exists").
			UponReceiving("a request Product 1").
			WithRequest(http.MethodGet, sugar.S("/api/v1/product/1")).
			WillRespondWith(http.StatusOK).
			WithJSONBody(sugar.Map{
				"id":             sugar.Integer(1),
				"name":           sugar.S("foo 2"),
				"brand":          sugar.S("bar 2"),
				"price_excl_tax": sugar.Decimal(20.125),
			}).
			WithHeader("Content-Type", sugar.Term("application/json; charset=utf-8", `application/json`))

		// Wrap my test in a callback function
		test := func(config sugar.MockServerConfig) error {
			var product Product
			var err error
			var myService B2b

			// set up the configuration for the driver
			baseURL := fmt.Sprintf("http://%s:%d", config.Host, config.Port)

			if err = os.Setenv("PACTGOCONSUMEREXAMPLE_PACTGOPROVIDEREXAMPLE_URL", baseURL); err != nil {
				return err
			}

			// instantiate the service
			if myService, err = New(); err != nil {
				return err
			}

			product, err = myService.Product(context.Background(), 1)
			require.NoError(t, err)

			require.Equal(t, 1, product.ID)
			require.Equal(t, "foo 2", product.Name)
			require.Equal(t, "bar 2", product.Brand)
			require.Equal(t, 20.125, product.Price)

			return nil
		}

		// Execute the test and check the expectation
		err := mockProvider.ExecuteTest(t, test)
		require.NoError(t, err)
	})
	t.Run("the product 2 doesn't exists", func(t *testing.T) {
		// Setup my expected interactions
		mockProvider.AddInteraction().
			Given("A product with id 2 does not exist").
			UponReceiving("a request Product 2").
			WithRequest(http.MethodGet, sugar.S("/api/v1/product/2")).
			WillRespondWith(http.StatusNotFound).
			WithHeader("Content-Type", sugar.Term("application/json; charset=utf-8", `application/json`))

		// Wrap my test in an callback function
		test := func(config sugar.MockServerConfig) error {
			var product Product
			var err error
			var myService B2b

			// set up the configuration for the driver
			baseURL := fmt.Sprintf("http://%s:%d", config.Host, config.Port)

			if err = os.Setenv("PACTGOCONSUMEREXAMPLE_PACTGOPROVIDEREXAMPLE_URL", baseURL); err != nil {
				return err
			}

			// instantiate the service
			if myService, err = New(); err != nil {
				return err
			}

			product, err = myService.Product(context.Background(), 2)
			require.Error(t, err)
			require.Equal(t, Product{}, product)

			return nil
		}

		// Execute the test and check the expectation
		err := mockProvider.ExecuteTest(t, test)
		require.NoError(t, err)
	})
}

When I try to run the test, I have a compilation error:

$ go test -v .         
# github.com/pact-foundation/pact-go/v2/internal/native
/usr/bin/ld: cannot find -lpact_ffi: No such file or directory
collect2: error: ld returned 1 exit status
FAIL    github.com/golangci/sandbox [build failed]
FAIL

Golangci-lint requires that the code compile.

Note: github.com/pact-foundation/pact-go/ relies on CGo and CGo is not Go.

@edouard-lopez
Copy link
Author

edouard-lopez commented Apr 29, 2022

related: pact-foundation/pact-go#212

pact_ffi is a lib needed by pact to run the test. You can install it with following command:

if ! type pact-go > /dev/null; then \
		go install github.com/pact-foundation/pact-go/[email protected]; \
		pact-go -l DEBUG install; \
		if test ! -x /usr/local/lib/libpact_ffi.so; then \
			chmod +x --quiet /usr/local/lib/libpact_ffi.so \
			|| sudo chmod +x /usr/local/lib/libpact_ffi.so; \
		fi \
	fi

@gursimran3108

This comment was marked as off-topic.

@ldez ldez added the area: cgo Related to CGO label May 13, 2022
@squeakycheese75

This comment was marked as off-topic.

@mefellows
Copy link

So the issue is that the package relies on CGo - does this project not support packages with native integrations?

@priyankshah217
Copy link

priyankshah217 commented Jun 20, 2022

@mefellows I am also facing the same issue. I wanted to exclude auto-generated pb files from code analysis.

can't run linter goanalysis_metalinter: inspect: failed to load package : could not load export data: no export data for "github.com/priyankshah217/Helloworld/Helloworld/Helloworld_proto"

config file:

run:
  skip-dirs:
    - Helloworld/Helloworld_proto
    - Helloworld/pb
  # Timeout for analysis, e.g. 30s, 5m.
  # Default: 1m
  timeout: 3m

  # Define the Go version limit.
  # Mainly related to generics support in go1.18.
  # Default: use Go version from the go.mod file, fallback on the env var `GOVERSION`, fallback on 1.17
  go: "1.16" # TODO: change to 1.18 when most linters support it, see https://github.com/golangci/golangci-lint/issues/2649


# This file contains only configs which differ from defaults.
# All possible options can be found here https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
linters-settings:
  cyclop:
    # The maximal code complexity to report.
    # Default: 10
    max-complexity: 30
    # The maximal average package complexity.
    # If it's higher than 0.0 (float) the check is enabled
    # Default: 0.0
    package-average: 10.0

  errcheck:
    # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
    # Such cases aren't reported by default.
    # Default: false
    check-type-assertions: true

  funlen:
    # Checks the number of lines in a function.
    # If lower than 0, disable the check.
    # Default: 60
    lines: 100
    # Checks the number of statements in a function.
    # If lower than 0, disable the check.
    # Default: 40
    statements: 50

  gocognit:
    # Minimal code complexity to report
    # Default: 30 (but we recommend 10-20)
    min-complexity: 20

  gocritic:
    # 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:
        # Whether to restrict checker to params only.
        # Default: true
        paramsOnly: false
      underef:
        # Whether to skip (*x).method() calls where x is a pointer receiver.
        # Default: true
        skipRecvDeref: false

  gomnd:
    # List of function patterns to exclude from analysis.
    # Values always ignored: `time.Date`
    # Default: []
    ignored-functions:
      - os.Chmod
      - os.Mkdir
      - os.MkdirAll
      - os.OpenFile
      - os.WriteFile
      - prometheus.ExponentialBuckets
      - prometheus.ExponentialBucketsRange
      - prometheus.LinearBuckets
      - strconv.FormatFloat
      - strconv.FormatInt
      - strconv.FormatUint
      - strconv.ParseFloat
      - strconv.ParseInt
      - strconv.ParseUint

  gomodguard:
    blocked:
      # List of blocked modules.
      # Default: []
      modules:
        - github.com/golang/protobuf:
            recommendations:
              - google.golang.org/protobuf
            reason: "see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules"
        - github.com/satori/go.uuid:
            recommendations:
              - github.com/google/uuid
            reason: "satori's package is not maintained"
        - github.com/gofrs/uuid:
            recommendations:
              - github.com/google/uuid
            reason: "see recommendation from dev-infra team: https://confluence.gtforge.com/x/gQI6Aw"

  govet:
    # Enable all analyzers.
    # Default: false
    enable-all: true
    # Disable analyzers by name.
    # Run `go tool vet help` to see all analyzers.
    # Default: []
    disable:
      - fieldalignment # too strict
    # Settings per analyzer.
    settings:
      shadow:
        # Whether to be strict about shadowing; can be noisy.
        # Default: false
        strict: true

  nakedret:
    # Make an issue if func has more lines of code than this setting, and it has naked returns.
    # Default: 30
    max-func-lines: 0

  nolintlint:
    # Exclude following linters from requiring an explanation.
    # Default: []
    allow-no-explanation: [ funlen, gocognit, lll ]
    # Enable to require an explanation of nonzero length after each nolint directive.
    # Default: false
    require-explanation: true
    # Enable to require nolint directives to mention the specific linter being suppressed.
    # Default: false
    require-specific: true

  rowserrcheck:
    # database/sql is always checked
    # Default: []
    packages:
      - github.com/jmoiron/sqlx

  tenv:
    # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
    # Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
    # Default: false
    all: true

  varcheck:
    # Check usage of exported fields and variables.
    # Default: false
    exported-fields: false # default false # TODO: enable after fixing false positives


linters:
  disable-all: true
  enable:
    ## enabled by default
    - deadcode # Finds unused code
    - errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
    - gosimple # Linter for Go source code that specializes in simplifying a code
    - govet # Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
    - ineffassign # Detects when assignments to existing variables are not used
    - staticcheck # Staticcheck is a go vet on steroids, applying a ton of static analysis checks
    - structcheck # Finds unused struct fields
    - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code
    - unused # Checks Go code for unused constants, variables, functions and types
    - varcheck # Finds unused global variables and constants
    ## disabled by default
    - asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers
    - bidichk # Checks for dangerous unicode character sequences
    - bodyclose # checks whether HTTP response body is closed successfully
    - contextcheck # check the function whether use a non-inherited context
    - cyclop # checks function and package cyclomatic complexity
    - dupl # Tool for code clone detection
    - durationcheck # check for two durations multiplied together
    - errname # Checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error.
    - errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13.
    - execinquery # execinquery is a linter about query string checker in Query function which reads your Go src files and warning it finds
    - exhaustive # check exhaustiveness of enum switch statements
    - exportloopref # checks for pointers to enclosing loop variables
    - forbidigo # Forbids identifiers
    - funlen # Tool for detection of long functions
    - gochecknoglobals # check that no global variables exist
    - gochecknoinits # Checks that no init functions are present in Go code
    - gocognit # Computes and checks the cognitive complexity of functions
    - goconst # Finds repeated strings that could be replaced by a constant
    - gocritic # Provides diagnostics that check for bugs, performance and style issues.
    - gocyclo # Computes and checks the cyclomatic complexity of functions
    - godot # Check if comments end in a period
    - goimports # In addition to fixing imports, goimports also formats your code in the same style as gofmt.
    - gomnd # An analyzer to detect magic numbers.
    - gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.
    - gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations.
    - goprintffuncname # Checks that printf-like functions are named with f at the end
    - gosec # Inspects source code for security problems
    - lll # Reports long lines
    - makezero # Finds slice declarations with non-zero initial length
    - nakedret # Finds naked returns in functions greater than a specified function length
    - nestif # Reports deeply nested if statements
    - nilerr # Finds the code that returns nil even if it checks that the error is not nil.
    - nilnil # Checks that there is no simultaneous return of nil error and an invalid value.
    - noctx # noctx finds sending http request without context.Context
    - nolintlint # Reports ill-formed or insufficient nolint directives
    - nonamedreturns # Reports all named returns
    - nosprintfhostport # Checks for misuse of Sprintf to construct a host with port in a URL.
    - predeclared # find code that shadows one of Go's predeclared identifiers
    - promlinter # Check Prometheus metrics naming via promlint
    - revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.
    - rowserrcheck # checks whether Err of rows is checked successfully
    - sqlclosecheck # Checks that sql.Rows and sql.Stmt are closed.
    - stylecheck # Stylecheck is a replacement for golint
    - tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17
    - testpackage # linter that makes you use a separate _test package
    - tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes
    - unconvert # Remove unnecessary type conversions
    - unparam # Reports unused function parameters
    - wastedassign # wastedassign finds wasted assignment statements.
    - whitespace # Tool for detection of leading and trailing whitespace
    ## you may want to enable
    #- decorder # check declaration order and count of types, constants, variables and functions
    #- exhaustruct # Checks if all structure fields are initialized
    #- goheader # Checks is file header matches to pattern
    #- ireturn # Accept Interfaces, Return Concrete Types
    #- prealloc # [premature optimization, but can be used in some cases] Finds slice declarations that could potentially be preallocated
    #- varnamelen # [great idea, but too many false positives] checks that the length of a variable's name matches its scope
    #- wrapcheck # Checks that errors returned from external packages are wrapped
    ## disabled
    #- containedctx # containedctx is a linter that detects struct contained context.Context field
    #- depguard # [replaced by gomodguard] Go linter that checks if package imports are in a list of acceptable packages
    #- dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
    #- errchkjson # [don't see profit + I'm against of omitting errors like in the first example https://github.com/breml/errchkjson] Checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted.
    #- forcetypeassert # [replaced by errcheck] finds forced type assertions
    #- gci # Gci controls golang package import order and makes it always deterministic.
    #- godox # Tool for detection of FIXME, TODO and other comment keywords
    #- goerr113 # [too strict] Golang linter to check the errors handling expressions
    #- gofmt # [replaced by goimports] Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
    #- gofumpt # [replaced by goimports, gofumports is not available yet] Gofumpt checks whether code was gofumpt-ed.
    #- grouper # An analyzer to analyze expression groups.
    #- ifshort # Checks that your code uses short syntax for if-statements whenever possible
    #- importas # Enforces consistent import aliases
    #- maintidx # maintidx measures the maintainability index of each function.
    #- misspell # [useless] Finds commonly misspelled English words in comments
    #- nlreturn # [too strict and mostly code is not more readable] nlreturn checks for a new line before return and branch statements to increase code clarity
    #- paralleltest # [too many false positives] paralleltest detects missing usage of t.Parallel() method in your Go test
    #- tagliatelle # Checks the struct tags.
    #- thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers
    #- wsl # [too strict and mostly code is not more readable] Whitespace Linter - Forces you to use empty lines!
    ## deprecated
    #- exhaustivestruct # [deprecated, replaced by exhaustruct] Checks if all struct's fields are initialized
    #- golint # [deprecated, replaced by revive] Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
    #- interfacer # [deprecated] Linter that suggests narrower interface types
    #- maligned # [deprecated, replaced by govet fieldalignment] Tool to detect Go structs that would take less memory if their fields were sorted
    #- scopelint # [deprecated, replaced by exportloopref] Scopelint checks for unpinned variables in go programs


issues:
  # Maximum count of issues with the same text.
  # Set to 0 to disable.
  # Default: 3
  max-same-issues: 50

  exclude-rules:
    - source: "^//\\s*go:generate\\s"
      linters: [ lll ]
    - source: "(noinspection|TODO)"
      linters: [ godot ]
    - source: "//noinspection"
      linters: [ gocritic ]
    - source: "^\\s+if _, ok := err\\.\\([^.]+\\.InternalError\\); ok {"
      linters: [ errorlint ]
    - path: "_test\\.go"
      linters:
        - bodyclose
        - dupl
        - funlen
        - goconst
        - gosec
        - noctx
        - wrapcheck

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: cgo Related to CGO question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants