scratchfoundation/golangci-lint
1
0
Fork 0
mirror of https://github.com/scratchfoundation/golangci-lint.git synced 2025-08-01 08:58:56 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: improve documentation about debugging. ()

Browse source
This commit is contained in:
Ludovic Fernandez 2022-12-27 10:48:48 +01:00 • committed by GitHub
parent ab8a120755
commit cca68dcffe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 15 deletions
docs/src/docs/contributing
debug.mdx

25
docs/src/docs/contributing/debug.mdx
View file

@ -4,12 +4,21 @@ title: Debugging
You can see a verbose output of linter by using `-v` option.
If you would like to see more detailed logs you can set environment variable `GL_DEBUG` to debug `golangci-lint`.
It's value is a list of debug tags. For example, `GL_DEBUG=loader,gocritic golangci-lint run`.
Existing debug tags:
```bash
golangci-lint run -v
```
1. `gocritic` - debug `go-critic` linter;
2. `env` - debug `go env` command;
3. `loader` - debug packages loading (including `go/packages` internal debugging);
4. `autogen_exclude` - debug a filter excluding autogenerated source code;
5. `nolint` - debug a filter excluding issues by `//nolint` comments.
If you would like to see more detailed logs you can use the environment variable `GL_DEBUG`.
Its value is a list of debug tags.
The existing debug tags are documented in the following file: https://github.com/golangci/golangci-lint/blob/master/pkg/logutils/logutils.go
For example:
```bash
GL_DEBUG="loader,gocritic" golangci-lint run
```
```bash
GL_DEBUG="loader,env" golangci-lint run
```