.golangci.yml

run:
  build-tags:
    - integration
  timeout: 10m
linters:
  enable:
    - canonicalheader
    - dogsled
    - dupl
    - gci
    - gocritic
    - godot
    - gofmt
    - goheader
    - goimports
    - gosec
    - misspell
    - nakedret
    - paralleltest
    - perfsprint
    - revive
    - sliceofpointers
    - stylecheck
    - tparallel
    - unconvert
    - unparam
    - whitespace
linters-settings:
  custom:
    sliceofpointers:
      type: module
      description: Reports usage of []*string and slices of structs without pointers.
      original-url: github.com/google/go-github/v68/tools/sliceofpointers
  gocritic:
    disable-all: true
    enabled-checks:
      - commentedOutCode
      - commentFormatting
  goheader:
    values:
      regexp:
        CopyrightDate: "Copyright \\d{4} "
    template: |-
      {{CopyrightDate}}The go-github AUTHORS. All rights reserved.
      
      Use of this source code is governed by a BSD-style
      license that can be found in the LICENSE file.
  gosec:
    excludes:
      # duplicates errcheck
      - G104
      # int(os.Stdin.Fd())
      - G115
  misspell:
    locale: US
    ignore-words:
      - "analyses" # returned by the GitHub API
      - "cancelled" # returned by the GitHub API
    # extra words from https://go.dev//wiki/Spelling
    extra-words:
      - typo: "marshall"
        correction: "marshal"
      - typo: "marshalled"
        correction: "marshaled"
      - typo: "marshalling"
        correction: "marshaling"
      - typo: "unmarshall"
        correction: "unmarshal"
      - typo: "unmarshalling"
        correction: "unmarshaling"
      - typo: "unmarshalled"
        correction: "unmarshaled"
      - typo: "unmarshalling"
        correction: "unmarshaling"
  perfsprint:
    errorf: true
    strconcat: false
  revive:
    # Set below 0.8 to enable error-strings rule.
    confidence: 0.6
    rules:
      - name: blank-imports
      - name: bool-literal-in-expr
      - name: context-as-argument
      - name: context-keys-type
      - name: dot-imports
      - name: early-return
      - name: empty-block
      - name: error-naming
      - name: error-return
      - name: error-strings
      - name: errorf
      - name: filename-format
        arguments:
          - "^[_a-z][_a-z0-9]*.go$"
      - name: increment-decrement
      - name: indent-error-flow
      - name: package-comments
      - name: range
      - name: receiver-naming
      - name: redefines-builtin-id
      - name: superfluous-else
      - name: time-equal
      - name: time-naming
      - name: unexported-naming
      - name: unexported-return
      - name: unreachable-code
      - name: var-declaration
      - name: var-naming
issues:
  exclude-use-default: false
  exclude-rules:
    - linters:
        - dupl
        - unparam
        - gosec
        - dogsled
      path: _test\.go

    # We need to pass nil Context in order to test DoBare erroring on nil ctx.
    - linters: [staticcheck]
      text: "SA1012: do not pass a nil Context"
      path: _test\.go

    # We need to use sha1 for validating signatures
    - linters: [gosec]
      text: "G505: Blocklisted import crypto/sha1: weak cryptographic primitive"

    # This is adapted from golangci-lint's default exclusions. It disables linting for error checks on
    # os.RemoveAll, fmt.Fprint*, fmt.Scanf, and any function ending in "Close".
    - linters: [errcheck]
      text: Error return value of .(.*Close|fmt\.Fprint.*|fmt\.Scanf|os\.Remove(All)?). is not checked

    # We don't care about file inclusion via variable in examples or internal tools.
    - linters: [gosec]
      text: "G304: Potential file inclusion via variable"
      path: '^(example|tools)\/'

    # We don't run parallel integration tests
    - linters: [paralleltest, tparallel]
      path: "^test/integration"

    # Because fmt.Sprint(reset.Unix())) is more readable than strconv.FormatInt(reset.Unix(), 10).
    - linters: [perfsprint]
      text: "fmt.Sprint.* can be replaced with faster strconv.FormatInt"