cli/.golangci.yaml at main · databricks/cli · 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
version: "2"
linters:
  default: none
  enable:
    - bodyclose
    - errcheck
    - gocritic
    - govet
    - ineffassign
    - intrange
    - mirror
    - perfsprint
    - revive
    - staticcheck
    - testifylint
    - unconvert
    - unused
    - exhaustruct
    - exhaustive
    - copyloopvar
    - forbidigo
    - depguard
  settings:
    depguard:
      rules:
        no-experimental-imports:
          # depguard matches against absolute file paths, so patterns must
          # start with **/ to match regardless of the repository location.
          files:
            - "**"
            - "!**/cmd/cmd.go"
            - "!**/cmd/experimental/**"
            - "!**/experimental/**"
          deny:
            - pkg: "github.com/databricks/cli/experimental"
              desc: "must not import experimental/ packages; use an interface or move the dependency"
    forbidigo:
      forbid:
        - pattern: 'term\.IsTerminal'
          msg: Use cmdio.IsPromptSupported(ctx) to check for a TTY.
        - pattern: 'isatty\.IsTerminal'
          msg: Use cmdio.IsPromptSupported(ctx) to check for a TTY.
        - pattern: 'isatty\.IsCygwinTerminal'
          msg: Use cmdio.IsPromptSupported(ctx) to check for a TTY.
        - pattern: 'os\.UserHomeDir'
          msg: Use env.UserHomeDir(ctx) from libs/env instead.
        - pattern: 'os\.Getenv'
          msg: Use env.Get(ctx) from the libs/env package instead of os.Getenv.
      analyze-types: true
    copyloopvar:
      check-alias: true
    errcheck:
      exclude-functions:
        - (*github.com/spf13/cobra.Command).RegisterFlagCompletionFunc
        - (*github.com/spf13/cobra.Command).MarkFlagRequired
        - (*github.com/spf13/pflag.FlagSet).MarkDeprecated
        - (*github.com/spf13/pflag.FlagSet).MarkHidden
    revive:
      rules:
        - name: blank-imports
        - name: context-as-argument
          exclude:
            - TEST
            - "**/integration/**"
            - "**/internal/testcli/**"
            - "**/internal/testutil/**"
            - "**/libs/testdiff/**"
            - "**/libs/python/pythontest/**"
        - name: context-keys-type
        - name: error-return
        - name: errorf
        - name: range-val-in-closure
        - name: waitgroup-by-value
        - name: unconditional-recursion
        - name: use-waitgroup-go
    gocritic:
      disable-all: true
      enabled-checks:
        - ruleguard
        - offBy1
      settings:
        ruleguard:
          failOn: all
          rules: libs/gorules/rule_*.go
    govet:
      disable:
        - fieldalignment
        - shadow
      enable-all: true
      settings:
        printf:
          funcs:
            - (github.com/databricks/cli/internal/testutil.TestingT).Infof
            - (github.com/databricks/cli/internal/testutil.TestingT).Errorf
            - (github.com/databricks/cli/internal/testutil.TestingT).Fatalf
            - (github.com/databricks/cli/internal/testutil.TestingT).Skipf
    staticcheck:
      checks:
        - all
        # disabled checks:
        - -ST1003
    testifylint:
      enable-all: true
      disable:
        - require-error # good check, but we have too many assert.(No)?Errorf? so excluding for now
        - empty
        - len
        - equal-values
        - encoded-compare # Always replaces Equal() with JSONEq, but sometimes exact string match is wanted for JSON
    exhaustive:
      default-signifies-exhaustive: true
  exclusions:
    generated: lax
    presets:
      - comments
      - common-false-positives
      - legacy
      - std-error-handling
    rules:
      - path-except: bundle/direct/dresources|bundle/config/mutator/load_dbalert_files.go
        linters:
          - exhaustruct
      - path: bundle/direct/dresources/.*_test.go
        linters:
          - exhaustruct
      - text: "Use env\\.Get"
        path: "_test\\.go$"
        linters:
          - forbidigo
      # TODO: remove these exceptions by moving the dependency out of experimental/.
      - path: cmd/apps/init.go
        linters:
          - depguard
issues:
  max-issues-per-linter: 1000
  max-same-issues: 1000
formatters:
  enable:
    - gofmt
    - gofumpt
    - goimports
  settings:
    gofmt:
      rewrite-rules:
        - pattern: a[b:len(a)]
          replacement: a[b:]
        - pattern: interface{}
          replacement: any
    gofumpt:
      module-path: github.com/databricks/cli
      extra-rules: true
  exclusions:
    generated: lax