eeafj/golangci-lint
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

docs: add note about binary requirement for plugin (#3468)

Browse Source
This commit is contained in:
Philip Linell 2023-01-12 14:47:01 +01:00 committed by GitHub
parent 43e1edae93
commit 8f6de2c658
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/src/docs/contributing/new-linters.mdx
View File

@ -41,6 +41,11 @@ Some people and organizations may choose to have custom-made linters run as a pa
Typically, these linters can't be open-sourced or too specific.
Such linters can be added through Go's plugin library.
For a private linter (which acts as a plugin) to work properly,
the plugin as well as the golangci-lint binary needs to be built for the same environment. `CGO_ENABLED` is another requirement.
This means that `golangci-lint` needs to be built for whatever machine you intend to run it on
(cloning the golangci-lint repository and running a `CGO_ENABLED=1 make build` should do the trick for your machine).
### Configure a Plugin
If you already have a linter plugin available, you can follow these steps to define it's usage in a projects