Skip to content

docs: updates usage settings for go-mnd #2476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 14, 2022
Merged

docs: updates usage settings for go-mnd #2476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions .golangci.example.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,10 +389,17 @@ linters-settings:
settings:
mnd:
# the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
checks: argument,case,condition,operation,return,assign
# ignored-numbers: 1000
# ignored-files: magic_.*.go
# ignored-functions: math.*
checks:
- argument
- case
- condition
- operation
- return
- assign
Comment on lines +392 to +398
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its also possible to supply it as comma-separated string, however having an array as example better from a documentation perspective (easier to add validation checks for json schema)

# Next settings are expecting comma separated string values
ignored-numbers: "0666,0755,42" # values always ignored: 1, 1.0, 0 and 0.0
ignored-files: "magic1_.*.go" # values always ignored:_test.go
ignored-functions: "math.*,http.StatusText,make" # values always ignored: time.Time

gomoddirectives:
# Allow local `replace` directives. Default is false.
Expand Down