Enable golangci-lint static check (#15)

Add hack/verify-staticcheck.sh
This commit is contained in:
Hongcai Ren 2020-11-16 10:40:41 +08:00 committed by GitHub
parent 96c15b45c6
commit 5f4abb5e3e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 64 additions and 0 deletions

43
.golangci.yml Normal file
View File

@ -0,0 +1,43 @@
# This files contains all configuration options for analysis running.
# More details please refer to: https://golangci-lint.run/usage/configuration/
run:
# timeout for analysis, e.g. 30s, 5m, default is 1m
timeout: 5m
# which dirs to skip: issues from them won't be reported;
# can use regexp here: generated.*, regexp is applied on full path;
# default value is empty list, but default dirs are skipped independently
# from this option's value (see skip-dirs-use-default).
# "/" will be replaced by current OS file path separator to properly work
# on Windows.
skip-dirs:
# default is true. Enables skipping of directories:
# vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
skip-dirs-use-default: true
# One of 'readonly' and 'vendor'.
# - readonly: the go command is disallowed from the implicit automatic updating of go.mod described above.
# Instead, it fails when any changes to go.mod are needed. This setting is most useful to check
# that go.mod does not need updates, such as in a continuous integration and testing system.
# - vendor: the go command assumes that the vendor directory holds the correct copies of dependencies and ignores
# the dependency descriptions in go.mod.
modules-download-mode: readonly
linters:
enable:
# linters maintained by golang.org
- gofmt
- golint
- govet
# linters default enabled by golangci-lint .
- deadcode
- errcheck
- gosimple
- ineffassign
- staticcheck
- structcheck
- typecheck
- unused
- varcheck

21
hack/verify-staticcheck.sh Executable file
View File

@ -0,0 +1,21 @@
#!/usr/bin/env bash
set -o errexit
set -o nounset
set -o pipefail
REPO_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
# TODO(RainbowMango): Pin golangci-lint verison to @v1.32.2
# go get github.com/golangci/golangci-lint/cmd/golangci-lint@v1.32.2
cd ${REPO_ROOT}
if golangci-lint run; then
echo 'Congratulations! All Go source files have passed staticcheck.'
else
echo # print one empty line, separate from warning messages.
echo 'Please review the above warnings.'
echo 'If the above warnings do not make sense, feel free to file an issue.'
exit 1
fi