From 6734a9714dda340b26017c084fa74acb388d4290 Mon Sep 17 00:00:00 2001 From: Cole Wippern Date: Thu, 28 Nov 2019 10:06:39 -0800 Subject: [PATCH] add golangci.yaml file matching current config --- .golangci.yaml | 191 +++++++++++++++++++++++++++++++++++++++++++++++++ hack/linter.sh | 13 +--- 2 files changed, 192 insertions(+), 12 deletions(-) create mode 100644 .golangci.yaml diff --git a/.golangci.yaml b/.golangci.yaml new file mode 100644 index 0000000000..bb2c7b5a9e --- /dev/null +++ b/.golangci.yaml @@ -0,0 +1,191 @@ +# This file contains all available configuration options +# with their default values. + +# options for analysis running +run: + # default concurrency is a available CPU number + concurrency: 4 + + # timeout for analysis, e.g. 30s, 5m, default is 1m + deadline: 1m + + # 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: + + # which dirs to skip: they won't be analyzed; + # can use regexp here: generated.*, regexp is applied on full path; + # default value is empty list, but next dirs are always skipped independently + # from this option's value: + # vendor$, third_party$, testdata$, examples$, Godeps$, builtin$ + skip-dirs: + + # 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: + +# output configuration options +output: + # colored-line-number|line-number|json|tab|checkstyle, 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 + + +# all available settings of specific linters +linters-settings: + 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: 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 + govet: + # report about shadowed variables + #check-shadowing: true + + # Obtain type information from installed (to $GOPATH/pkg) package files: + # golangci-lint will execute `go install -i` and `go test -i` for analyzed packages + # before analyzing them. + # By default this option is disabled and govet gets type information by loader from source code. + # Loading from source code is slow, but it's done only once for all linters. + # Go-installing of packages first time is much slower than loading them from source code, + # therefore this option is disabled by default. + # But repeated installation is fast in go >= 1.10 because of build caching. + # Enable this option only if all conditions are met: + # 1. you use only "fast" linters (--fast e.g.): no program loading occurs + # 2. you use go >= 1.10 + # 3. you do repeated runs (false for CI) or cache $GOPATH/pkg or `go env GOCACHE` dir in CI. + #use-installed-packages: 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 + #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: + # 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 + #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: + # call graph construction algorithm (cha, rta). In general, use cha for libraries, + # and rta for programs with main packages. Default is cha. + algo: cha + + # 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 + #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: + - goconst + - goimports + - golint + - interfacer + - maligned + - misspell + - unconvert + - unparam + enable-all: false + disable: + - errcheck + - gas + disable-all: false + presets: + - bugs + - unused + fast: false + + +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: + + # 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: true + + # Maximum issues count per one linter. Set to 0 to disable. Default is 50. + max-per-linter: 50 + + # Maximum count of issues with the same text. Set to 0 to disable. Default is 3. + max-same: 3 + + # 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 + + ## Show only new issues created after git revision `REV` + #new-from-rev: REV + + ## Show only new issues created in git patch with set file path. + #new-from-patch: path/to/patch/file diff --git a/hack/linter.sh b/hack/linter.sh index fb4713b087..8ae6246960 100755 --- a/hack/linter.sh +++ b/hack/linter.sh @@ -23,15 +23,4 @@ if ! [ -x "$(command -v golangci-lint)" ]; then ${DIR}/install_golint.sh -b $GOPATH/bin v1.9.3 fi -golangci-lint run \ - --no-config \ - -E goconst \ - -E goimports \ - -E golint \ - -E interfacer \ - -E maligned \ - -E misspell \ - -E unconvert \ - -E unparam \ - -D errcheck \ - -D gas +golangci-lint run