1
0
Fork 0
mirror of https://github.com/Luzifer/yaml-vault.git synced 2024-12-30 08:41:20 +00:00

Lint: Add PR linting, fix linter errors

Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2021-09-29 13:27:35 +02:00
parent 56dc269e16
commit a8f09ab04b
Signed by: luzifer
GPG key ID: 0066F03ED215AD7D
4 changed files with 79 additions and 3 deletions

69
.golangci.yml Normal file
View file

@ -0,0 +1,69 @@
# Derived from https://github.com/golangci/golangci-lint/blob/master/.golangci.example.yml
---
run:
# timeout for analysis, e.g. 30s, 5m, default is 1m
timeout: 5m
# Force readonly modules usage for checking
modules-download-mode: readonly
output:
format: tab
linters-settings:
forbidigo:
forbid:
- 'fmt\.Errorf' # Should use github.com/pkg/errors
funlen:
lines: 100
statements: 60
gocyclo:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
min-complexity: 15
gomnd:
settings:
mnd:
ignored-functions: 'strconv.(?:Format|Parse)\B+'
linters:
disable-all: true
enable:
- asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers [fast: true, auto-fix: false]
- bodyclose # checks whether HTTP response body is closed successfully [fast: true, auto-fix: false]
- deadcode # Finds unused code [fast: true, auto-fix: false]
- depguard # Go linter that checks if package imports are in a list of acceptable packages [fast: true, auto-fix: false]
- dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f()) [fast: true, auto-fix: false]
- exportloopref # checks for pointers to enclosing loop variables [fast: true, auto-fix: false]
- forbidigo # Forbids identifiers [fast: true, auto-fix: false]
- funlen # Tool for detection of long functions [fast: true, auto-fix: false]
- gocognit # Computes and checks the cognitive complexity of functions [fast: true, auto-fix: false]
- goconst # Finds repeated strings that could be replaced by a constant [fast: true, auto-fix: false]
- gocritic # The most opinionated Go source code linter [fast: true, auto-fix: false]
- gocyclo # Computes and checks the cyclomatic complexity of functions [fast: true, auto-fix: false]
- godox # Tool for detection of FIXME, TODO and other comment keywords [fast: true, auto-fix: false]
- gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true, auto-fix: true]
- gofumpt # Gofumpt checks whether code was gofumpt-ed. [fast: true, auto-fix: true]
- goimports # Goimports does everything that gofmt does. Additionally it checks unused imports [fast: true, auto-fix: true]
- gomnd # An analyzer to detect magic numbers. [fast: true, auto-fix: false]
- gosec # Inspects source code for security problems [fast: true, auto-fix: false]
- gosimple # Linter for Go source code that specializes in simplifying a code [fast: true, auto-fix: false]
- govet # Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string [fast: true, auto-fix: false]
- ineffassign # Detects when assignments to existing variables are not used [fast: true, auto-fix: false]
- misspell # Finds commonly misspelled English words in comments [fast: true, auto-fix: true]
- nakedret # Finds naked returns in functions greater than a specified function length [fast: true, auto-fix: false]
- noctx # noctx finds sending http request without context.Context [fast: true, auto-fix: false]
- nolintlint # Reports ill-formed or insufficient nolint directives [fast: true, auto-fix: false]
- revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint. [fast: false, auto-fix: false]
- staticcheck # Staticcheck is a go vet on steroids, applying a ton of static analysis checks [fast: true, auto-fix: false]
- structcheck # Finds unused struct fields [fast: true, auto-fix: false]
- stylecheck # Stylecheck is a replacement for golint [fast: true, auto-fix: false]
- typecheck # Like the front-end of a Go compiler, parses and type-checks Go code [fast: true, auto-fix: false]
- unconvert # Remove unnecessary type conversions [fast: true, auto-fix: false]
- unused # Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false]
- varcheck # Finds unused global variables and constants [fast: true, auto-fix: false]
...

View file

@ -4,7 +4,7 @@ image: "reporunner/golang-alpine"
checkout_dir: /go/src/github.com/Luzifer/yaml-vault checkout_dir: /go/src/github.com/Luzifer/yaml-vault
commands: commands:
- make publish - make lint publish
environment: environment:
DRAFT: 'false' DRAFT: 'false'

View file

@ -1,3 +1,8 @@
default: lint
lint:
golangci-lint run
publish: publish:
curl -sSLo golang.sh https://raw.githubusercontent.com/Luzifer/github-publish/master/golang.sh curl -sSLo golang.sh https://raw.githubusercontent.com/Luzifer/github-publish/master/golang.sh
bash golang.sh bash golang.sh

View file

@ -19,6 +19,8 @@ import (
"github.com/Luzifer/rconfig/v2" "github.com/Luzifer/rconfig/v2"
) )
const filePermissionUserWrite = 0o600
var ( var (
cfg = struct { cfg = struct {
File string `flag:"file,f" default:"vault.yaml" description:"File to import from / export to" validate:"nonzero"` File string `flag:"file,f" default:"vault.yaml" description:"File to import from / export to" validate:"nonzero"`
@ -130,7 +132,7 @@ func exportFromVault(client *api.Client) error {
} }
if !strings.HasSuffix(path, "/") { if !strings.HasSuffix(path, "/") {
path = path + "/" path += "/"
} }
if err := readRecurse(client, path, &out); err != nil { if err := readRecurse(client, path, &out); err != nil {
@ -143,7 +145,7 @@ func exportFromVault(client *api.Client) error {
return errors.Wrap(err, "Unable to marshal yaml") return errors.Wrap(err, "Unable to marshal yaml")
} }
return ioutil.WriteFile(cfg.File, data, 0600) return ioutil.WriteFile(cfg.File, data, filePermissionUserWrite)
} }
func readRecurse(client *api.Client, path string, out *importFile) error { func readRecurse(client *api.Client, path string, out *importFile) error {