kuberay/.golangci.yml at master · ray-project/kuberay · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
version: "2"
linters:
  default: none
  enable:
    - asciicheck
    - errcheck
    - ginkgolinter
    - gosec
    - govet
    - ineffassign
    - makezero
    - misspell
    - modernize
    - nilerr
    - nolintlint
    - predeclared
    - testifylint
    - unconvert
    - unparam
    - unused
    - wastedassign
    - errorlint
    - staticcheck
    - noctx
    - revive
  settings:
    staticcheck:
      checks: ["all", "-ST1001", "-ST1003", "-ST1005", "-QF1008"]
    ginkgolinter:
      forbid-focus-container: true
    gocyclo:
      min-complexity: 15
    gosec:
      excludes:
        - G601
    lll:
      line-length: 120
    misspell:
      locale: US
    nolintlint:
      require-explanation: true
      require-specific: true
    revive:
      rules:
        - name: blank-imports
        - name: context-as-argument
        - name: context-keys-type
        - name: empty-block
        - name: error-naming
        - name: error-return
        - name: error-strings
        - name: errorf
        - name: exported
          disabled: true
        - name: if-return
        - name: increment-decrement
        - name: indent-error-flow
        - name: package-comments
        - name: range
        - name: receiver-naming
        - name: redefines-builtin-id
        - name: superfluous-else
        - name: time-naming
        - name: unexported-return
        - name: unreachable-code
        - name: unused-parameter
        - name: var-declaration
        - name: var-naming
          arguments:
            - ["ID", "JSON", "HTTP", "IP"] # AllowList
            - [] # DenyList
            - - upperCaseConst: true
          exclude:
            - '**/ray-operator/apis/config/v1alpha1/*.go'
            - '**/ray-operator/apis/ray/v1alpha1/*.go'
            - '**/ray-operator/apis/ray/v1/*.go'
            - '**/ray-operator/controllers/ray/batchscheduler/utils/*.go'
            - '**/ray-operator/controllers/ray/common/*.go'
            - '**/ray-operator/controllers/ray/utils/*.go'
            - '**/ray-operator/pkg/utils/*.go'
            - '**/ray-operator/controllers/ray/utils/types/*.go'
            - '**/apiserver/pkg/http/*.go'
            - '**/apiserver/pkg/util/*.go'
            - '**/apiserversdk/util/*.go'
            - '**/kubectl-plugin/pkg/util/*.go'
    modernize:
      disable:
        - omitzero
        # Disable newexpr check for now since it introduces too many changes in our existing codebase.
        # To be re-enabled as a part of https://github.com/ray-project/kuberay/issues/4694.
        - newexpr
  exclusions:
    # Suppress SA1019 for the project's own deprecated API fields that are
    # intentionally maintained for backward compatibility. External deprecated
    # API usage (e.g., from third-party libraries) will still be caught.
    rules:
      - linters: [staticcheck]
        text: "SA1019:.*\\.State is deprecated: the State field"
      - linters: [staticcheck]
        text: "SA1019:.*\\.ServiceStatus is deprecated"
      - linters: [staticcheck]
        text: "SA1019:.*ServiceUnhealthySecondThreshold is deprecated"
      - linters: [staticcheck]
        text: "SA1019:.*DeploymentUnhealthySecondThreshold is deprecated"
      # NewSimpleClientset is deprecated in favor of NewClientset, but
      # NewClientset requires complete structured-merge-diff type schemas
      # for field management which breaks Update-based tests.
      # TODO(#4627): migrate once SMD schemas are properly generated.
      - linters: [staticcheck]
        text: "SA1019:.*NewSimpleClientset"
      # controller-runtime deprecations from K8s 1.36 update.
      # These require non-trivial migration and should be addressed separately.
      - linters: [staticcheck]
        text: "SA1019:.*GetEventRecorderFor is deprecated"
    generated: strict
    presets:
      - comments
      - common-false-positives
      - legacy
      - std-error-handling
    paths:
      - third_party$
      - builtin$
      - examples$
      - _generated.go
issues:
  max-issues-per-linter: 0
  max-same-issues: 0
formatters:
  enable:
    - gci
    - gofmt
    - gofumpt
    - goimports
  settings:
    gci: # Splits all import blocks into different sections and sorts them.
      sections:
        - standard # Go official imports, like "fmt"
        - default # Third-party libraries (anything not in standard or prefix)
        - prefix(github.com/ray-project/kuberay) # kuberay packages
    gofmt:
      simplify: true
    goimports:
      local-prefixes:
        - github.com/ray-project/kuberay
  exclusions:
    generated: lax
    paths:
      - third_party$
      - builtin$
      - examples$
run:
  # timeout for analysis, e.g. 30s, 5m, default timeout is disabled
  timeout: 10m