From be5462cf626ff29817ebefa6aaac2e9da0a90599 Mon Sep 17 00:00:00 2001 From: Niels de Vos Date: Tue, 29 Apr 2025 11:28:54 +0200 Subject: [PATCH] ci: update golangci-lint to v2.1.5 The format of the configuration file has changed a bit. A lot of the options are not valid anymore, and `golangci-lint migrate` helped with converting the old format to the new. Signed-off-by: Niels de Vos --- build.env | 2 +- scripts/golangci.yml.in | 214 +++++++++++++++------------------------- 2 files changed, 79 insertions(+), 137 deletions(-) diff --git a/build.env b/build.env index 579302d48..896d8d879 100644 --- a/build.env +++ b/build.env @@ -33,7 +33,7 @@ GO111MODULE=on COMMITLINT_VERSION=latest # static checks and linters -GOLANGCI_VERSION=v1.62.2 +GOLANGCI_VERSION=v2.1.5 # external snapshotter version # Refer: https://github.com/kubernetes-csi/external-snapshotter/releases diff --git a/scripts/golangci.yml.in b/scripts/golangci.yml.in index a0bcba726..8e2b754e9 100644 --- a/scripts/golangci.yml.in +++ b/scripts/golangci.yml.in @@ -2,6 +2,7 @@ # https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml # This file contains all available configuration options # with their default values. +version: "2" # options for analysis running run: @@ -23,12 +24,6 @@ run: # include test files or not, default is true tests: 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. - skip-files: - issues: # which dirs to skip: they won't be analyzed; # can use regexp here: generated.*, regexp is applied on full path; @@ -43,136 +38,13 @@ output: # colored-line-number|line-number|json|tab|checkstyle|code-climate, # default is "colored-line-number" formats: - - 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 - -# all available settings of specific linters -linters-settings: - cyclop: - max-complexity: 20 - errcheck: - # report about not checking of errors in type assetions: - # `a := b.(MyStruct)`; - # default is false: such cases aren't reported by default. - check-type-assertions: true - - # 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 - - # 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 - golint: - # minimal confidence for issues, default is 0.8 - min-confidence: 0 - 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/ceph/ceph-csi - gocyclo: - # minimal code complexity to report, 30 by default (but we recommend 10-20) - min-complexity: 20 - 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: - list-type: blacklist - include-go-root: false - packages: - - github.com/davecgh/go-spew/spew - 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 - 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 - gocritic: - enabled-tags: - - performance - - style - - experimental - disabled-checks: - - sloppyReassign - - elseif - - unslice - - wrapperFunc - - unnamedResult - - dupImport # https://github.com/go-critic/go-critic/issues/845 - # TODO: uncheckedInlineErr gives many false-positives - - uncheckedInlineErr - gosec: - excludes: - # TODO: G115 gives many false-positives - - G115 # Potential integer overflow when converting between integer types - 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: 30 - gocognit: - # minimal code complexity to report, 30 by default (but we recommend 10-20) - # TODO: decrease complexity with refacoring the code - min-complexity: 40 - dogsled: - max-blank-identifiers: 3 - nestif: - min-complexity: 7 - revive: - rules: - # dot-imports is already checked by golint - - name: dot-imports - disabled: true - stylecheck: - checks: - # "should not use dot imports" is handled by golint - - "-ST1001" + text: + path: stdout + print-linter-name: true + print-issued-lines: true linters: - enable-all: true + default: all disable: - prealloc - dupl @@ -191,8 +63,6 @@ linters: - forbidigo # TODO: enable gomoddirectives - gomoddirectives - # TODO: enable gci - - gci # TODO: enable wrapcheck linter # See: https://github.com/ceph/ceph-csi/pull/2268 - wrapcheck @@ -212,3 +82,75 @@ linters: # TODO enable linters added in golangci-lint 1.60 - iface - recvcheck + settings: + cyclop: + max-complexity: 20 + dogsled: + max-blank-identifiers: 3 + dupl: + threshold: 100 + errcheck: + check-type-assertions: true + check-blank: true + gocognit: + min-complexity: 40 + goconst: + min-len: 3 + min-occurrences: 3 + gocritic: + disabled-checks: + - sloppyReassign + - elseif + - unslice + - wrapperFunc + - unnamedResult + - dupImport + - uncheckedInlineErr + enabled-tags: + - performance + - style + - experimental + gocyclo: + min-complexity: 20 + gosec: + excludes: + - G115 + lll: + line-length: 120 + tab-width: 1 + misspell: + locale: US + ignore-rules: + - someword + nakedret: + max-func-lines: 30 + nestif: + min-complexity: 7 + revive: + rules: + - name: dot-imports + disabled: true + staticcheck: + checks: + - -ST1001 + unparam: + check-exported: false + +formatters: + enable: + - gofmt + - gofumpt + - goimports + settings: + gofmt: + simplify: true + goimports: + local-prefixes: + - github.com/ceph/ceph-csi + exclusions: + generated: lax + paths: + - vendor$ + - third_party$ + - builtin$ + - examples$