aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/ultraware/funlen/README.md
diff options
context:
space:
mode:
authorTaras Madan <tarasmadan@google.com>2025-01-22 16:07:17 +0100
committerTaras Madan <tarasmadan@google.com>2025-01-23 10:42:36 +0000
commit7b4377ad9d8a7205416df8d6217ef2b010f89481 (patch)
treee6fec4fd12ff807a16d847923f501075bf71d16c /vendor/github.com/ultraware/funlen/README.md
parent475a4c203afb8b7d3af51c4fd32bb170ff32a45e (diff)
vendor: delete
Diffstat (limited to 'vendor/github.com/ultraware/funlen/README.md')
-rw-r--r--vendor/github.com/ultraware/funlen/README.md47
1 files changed, 0 insertions, 47 deletions
diff --git a/vendor/github.com/ultraware/funlen/README.md b/vendor/github.com/ultraware/funlen/README.md
deleted file mode 100644
index af2187694..000000000
--- a/vendor/github.com/ultraware/funlen/README.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# Funlen linter
-
-Funlen is a linter that checks for long functions. It can check both on the number of lines and the number of statements.
-
-The default limits are 60 lines and 40 statements. You can configure these.
-
-## Description
-
-The intent for the funlen linter is to fit a function within one screen. If you need to scroll through a long function, tracing variables back to their definition or even just finding matching brackets can become difficult.
-
-Besides checking lines there's also a separate check for the number of statements, which gives a clearer idea of how much is actually being done in a function.
-
-The default values are used internally, but might to be adjusted for your specific environment.
-
-## Installation
-
-Funlen is included in [golangci-lint](https://github.com/golangci/golangci-lint/). Install it and enable funlen.
-
-# Exclude for tests
-
-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.
-
-## Disable funlen for \_test.go files
-
-You can utilize the issues configuration in `.golangci.yml` to exclude the funlen linter for all test files:
-
-```yaml
-issues:
- exclude-rules:
- # disable funlen for all _test.go files
- - path: _test.go
- linters:
- - funlen
-```
-
-## Disable funlen only for Test funcs
-
-If you want to keep funlen enabled for example in helper functions in test files but disable it specifically for Test funcs, you can use the following configuration:
-
-```yaml
-issues:
- exclude-rules:
- # disable funlen for test funcs
- - source: "^func Test"
- linters:
- - funlen
-```