Skip to content

Commit eb229c9

Browse files
ldezSeigeC
authored andcommitted
docs: improve linters page (golangci#2617)
1 parent f32362b commit eb229c9

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

.golangci.example.yml

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1058,16 +1058,29 @@ linters-settings:
10581058

10591059
revive:
10601060
# Maximum number of open files at the same time.
1061-
# https://github.com/mgechev/revive#command-line-flags
1061+
# See https://github.com/mgechev/revive#command-line-flags
10621062
# Defaults to unlimited.
10631063
max-open-files: 2048
1064+
1065+
# When set to false, ignores files with "GENERATED" header, similar to golint.
10641066
# See https://github.com/mgechev/revive#available-rules for details.
1067+
# Default: false
10651068
ignore-generated-header: true
1066-
severity: warning
1067-
enable-all-rules: false
1068-
# confidence: 0.8
1069-
# error-code: 0
1070-
# warning-code: 0
1069+
1070+
# Sets the default severity.
1071+
# See https://github.com/mgechev/revive#configuration
1072+
# Default: warning
1073+
severity: error
1074+
1075+
# Enable all available rules.
1076+
# Default: false
1077+
enable-all-rules: true
1078+
1079+
# Sets the default failure confidence.
1080+
# This means that linting errors with less than 0.8 confidence will be ignored.
1081+
# Default: 0.8
1082+
confidence: 0.1
1083+
10711084
rules:
10721085
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant
10731086
- name: add-constant

docs/src/docs/usage/linters.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ To see a list of supported linters and which linters are enabled/disabled:
88
golangci-lint help linters
99
```
1010

11-
## Enabled By Default Linters
11+
## Enabled by Default
1212

1313
{.EnabledByDefaultLinters}
1414

15-
## Disabled By Default Linters (`-E/--enable`)
15+
## Disabled by Default
1616

1717
{.DisabledByDefaultLinters}
1818

0 commit comments

Comments
 (0)