Skip to content

Commit abcc656

Browse files
authored
Add configuration options to README (#21)
1 parent 2a9c521 commit abcc656

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,26 @@ The default values are used internally, but might to be adjusted for your specif
1616

1717
Funlen is included in [golangci-lint](https://github.com/golangci/golangci-lint/). Install it and enable funlen.
1818

19+
## Configuration
20+
21+
Available configuration options:
22+
23+
```yaml
24+
linters-settings:
25+
funlen:
26+
# Checks the number of lines in a function.
27+
# If lower than 0, disable the check.
28+
# Default: 60
29+
lines: 60
30+
# Checks the number of statements in a function.
31+
# If lower than 0, disable the check.
32+
# Default: 40
33+
statements: 60
34+
# Ignore comments when counting lines.
35+
# Default false
36+
ignore-comments: false
37+
```
38+
1939
# Exclude for tests
2040
2141
golangci-lint offers a way to exclude linters in certain cases. More info can be found here: https://golangci-lint.run/usage/configuration/#issues-configuration.

0 commit comments

Comments
 (0)