.golangci.yml

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:
  #  - src/external_libs
  #  - autogenerated_by_my_lib

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

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

    # 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

  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/snapcore/snapd
  govet:
    # report about shadowed variables
    check-shadowing: false
  golint:
    # minimal confidence for issues, default is 0.8
    min-confidence: 0.8
  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: github.com/snapcore/snapd
  gocyclo:
    # minimal code complexity to report, 30 by default (but we recommend 10-20)
    min-complexity: 10
  maligned:
    # print struct with more effective memory layout or not, false by default
    suggest-new: true
  dupl:
    # tokens count to trigger issue, 150 by default
    threshold: 100
  goconst:
    # minimal length of string constant, 3 by default
    min-len: 3
    # minimal occurrences count to trigger, 3 by default
    min-occurrences: 3
  depguard:
    rules:
      osuser:
        files:
          - "!**/osutil/user/*.go"
        deny:
          - pkg: "os/user"
            desc: "Please use osutil/user instead. See https://github.com/canonical/snapd/pull/13776"
      testtime:
        files:
          - "!$test"
        deny:
          - pkg: "github.com/snapcore/snapd/testtime"
            desc: "Cannot use testtime outside of test code"
          - pkg: "github.com/canonical/snapd/testtime"
            desc: "Cannot use testtime outside of test code"

  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
      - auther
      - PROCES
      - PROCESSS
      - proces
      - processs
      - exportfs
  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
  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
  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
  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: 5
  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

linters:
  # enable the following linters
  enable:
    - govet
    - misspell
    - unused
    # gosimple may suggest patterns that work only with more recent Go versions
    # - gosimple
    - nakedret
    # formatting is disabled until we move to Go 1.13
    # - gofmt
    - ineffassign
    # disabling until https://github.com/daixiang0/gci/issues/54 is fixed
    # - gci
    - testpackage
    - depguard
  # disable everything else
  disable-all: true


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:
    # Exclude some linters from running on tests files.
    - path: _test\.go
      linters:
        - gocyclo
        - errcheck
        - dupl
        - gosec

    - path: export.*_test\.go
      linters:
        - deadcode
        - testpackage

    - path: osutil/.*_test.go
      linters:
        - testpackage

    # an external dependency that was imported
    - path: udev/netlink/.*.go
      linters:
        - testpackage
        - nakedret

    - path: udev/crawler/.*.go
      linters:
        - testpackage
        - nakedret

    # test files that do live in corresponding xxx_test packages, they will
    # need over time to be moved to *_internal_test.go or fixed
    - path: arch/arch_test.go
      linters:
        - testpackage
    - path: asserts/findwildcard_test.go
      linters:
        - testpackage
    - path: cmd/snapctl/main_test.go
      linters:
        - testpackage
    - path: cmd/snap-update-ns/sorting_test.go
      linters:
        - testpackage
    - path: daemon/daemon_test.go
      linters:
        - testpackage
    - path: daemon/ucrednet_test.go
      linters:
        - testpackage
    - path: i18n/i18n_test.go
      linters:
        - testpackage
    - path: i18n/xgettext-go/main_test.go
      linters:
        - testpackage
    - path: interfaces/hotplug/deviceinfo_test.go
      linters:
        - testpackage
    - path: interfaces/hotplug/proposed_slot_test.go
      linters:
        - testpackage
    - path: interfaces/hotplug/udevadm_test.go
      linters:
        - testpackage
    - path: overlord/hookstate/context_test.go
      linters:
        - testpackage
    - path: overlord/hookstate/repository_test.go
      linters:
        - testpackage
    - path: overlord/snapstate/cookies_test.go
      linters:
        - testpackage
    - path: overlord/snapstate/progress_test.go
      linters:
        - testpackage
    - path: polkit/pid_start_time_test.go
      linters:
        - testpackage
    - path: snap/snapenv/snapenv_test.go
      linters:
        - testpackage
    - path: snap/types_test.go
      linters:
        - testpackage
    - path: store/details_v2_test.go
      linters:
        - testpackage
    - path: store/stringlist_test.go
      linters:
        - testpackage
    - path: strutil/shlex/shlex_test.go
      linters:
        - testpackage
    - path: tests/lib/fakestore/store/store_test.go
      linters:
        - testpackage
    - path: testutil/exec_test.go
      linters:
        - testpackage
    - path: timeout/timeout_test.go
      linters:
        - testpackage

  # 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

  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
  max-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