Skip to content

Commit 1bf8205

Browse files
authored
docs: improve linters page (#2617)
1 parent 56d77e2 commit 1bf8205

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

.golangci.example.yml

+19-6
Original file line numberDiff line numberDiff line change
@@ -1033,16 +1033,29 @@ linters-settings:
10331033

10341034
revive:
10351035
# Maximum number of open files at the same time.
1036-
# https://github.com/mgechev/revive#command-line-flags
1036+
# See https://github.com/mgechev/revive#command-line-flags
10371037
# Defaults to unlimited.
10381038
max-open-files: 2048
1039+
1040+
# When set to false, ignores files with "GENERATED" header, similar to golint.
10391041
# See https://github.com/mgechev/revive#available-rules for details.
1042+
# Default: false
10401043
ignore-generated-header: true
1041-
severity: warning
1042-
enable-all-rules: false
1043-
# confidence: 0.8
1044-
# error-code: 0
1045-
# warning-code: 0
1044+
1045+
# Sets the default severity.
1046+
# See https://github.com/mgechev/revive#configuration
1047+
# Default: warning
1048+
severity: error
1049+
1050+
# Enable all available rules.
1051+
# Default: false
1052+
enable-all-rules: true
1053+
1054+
# Sets the default failure confidence.
1055+
# This means that linting errors with less than 0.8 confidence will be ignored.
1056+
# Default: 0.8
1057+
confidence: 0.1
1058+
10461059
rules:
10471060
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant
10481061
- name: add-constant

docs/src/docs/usage/linters.mdx

+2-2
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)