Commit5b57aa0

committed

Provide an example .golangci.yml file

The default [.golangci.yml](https://github.com/golangci/golangci-lint/blob/master/.golangci.example.yml) file is great, but fairly large to grok. To show how to enable the linter specifically, we here provide a trimmed down example of the file that enables JUST the example linter (and typecheck).

1 parent8e299eb commit5b57aa0Copy full SHA for 5b57aa0

File tree

+15

-0

lines changed

+15

-0

lines changed

Lines changed: 15 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,15 @@`
	`1`	`+linters-settings:`
	`2`	`+custom:`
	`3`	`+example:`
	`4`	`+# Path is required`
	`5`	`+path:example.so`
	`6`	`+# description is optional`
	`7`	+description:The description of the linter. This is optional, but shows up when running `golangci-lint linters`.
	`8`	`+# original-url is optional, and is only used for documentation purposes.`
	`9`	`+original-url:github.com/golangci/example-linter`
	`10`	`+linters:`
	`11`	`+disable-all:true`
	`12`	`+enable:`
	`13`	`+ -example`
	`14`	`+# Typecheck is how golangci-lint reports compile errors, so should always be enabled.`
	`15`	`+ -typecheck`

Comments

(0)