Skip to content

Commit 6459b31

Browse files
committed
docs: add settings limitations
1 parent e817b81 commit 6459b31

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/src/docs/contributing/new-linters.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ That is all the configuration that is required to run a custom linter in your pr
8686
Custom linters are disabled by default, and are not enabled when `linters.enable-all` is specified.
8787
They can be enabled by adding them the `linters.enable` list, or providing the enabled option on the command line (`golangci-lint run -Eexample`).
8888

89+
The configuration inside the `settings` field of linter have some limitations (there are NOT related to the plugin system itself):
90+
we use Viper to handle the configuration but Viper put all the keys in lowercase, and `.` cannot be used inside a key.
91+
8992
### Create a Plugin
9093

9194
Your linter must provide one or more `golang.org/x/tools/go/analysis.Analyzer` structs.

0 commit comments

Comments
 (0)