garbage-code-hunter 0.2.2

A humorous Rust code quality detector that roasts your garbage code
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# Configuration

Garbage Code Hunter reads project-level settings from `.garbage-code-hunter.toml`.
The file is discovered by walking upward from the target path.

## Project config example

```toml
[project-type]
web-service = {}

[whitelists]
magic-numbers = [8080, 443, 80, 3000, 5000]
variable-names = ["ctx", "req", "res", "err", "db", "wg", "mu"]
directories = ["vendor/", "generated/", "testdata/"]
exclude-patterns = [
  "*.pb.go",
  "*.pulsar.go",
  "*_grpc.pb.go",
  "*.gen.ts",
  "*.generated.*",
  "node_modules/",
  "venv/",
  "__pycache__/",
  "vendor/",
]

[rules.naming]
enabled = true
severity = "mild"
allowed-names = ["id", "ok", "tx", "rx", "fs"]

[rules.unwrap]
enabled = true
threshold = 1
nuclear-threshold = 15

[rules.magic-number]
enabled = true
allowed-numbers = [200, 201, 204, 400, 401, 403, 404, 500]

[rules.println]
enabled = true

[[overrides]]
pattern = "generated/"
```

## Configuration sections

- `project-type`: optional project hint for analysis context
- `whitelists.magic-numbers`: numbers that should not be flagged
- `whitelists.variable-names`: variable names that are allowed
- `whitelists.directories`: directories that reduce sensitivity
- `whitelists.exclude-patterns`: files or paths to skip
- `rules.*`: per-rule switches and thresholds
- `signals.*`: detector configuration for special signal checks
- `overrides`: path-based overrides for generated or special folders

## Severity levels

| Level | Weight | Meaning |
|---|---:|---|
| `mild` | 0.5 | Low-priority issue |
| `spicy` | 1.5 | Should be fixed |
| `nuclear` | 3.0 | Fix immediately |

## CLI flags

```bash
# Analyze a path
garbage-code-hunter analyze [PATH]

# Filter by language
garbage-code-hunter analyze --lang go

# Exclude paths
garbage-code-hunter analyze --exclude "vendor/*" --exclude "*.pb.go"

# Save a scan result
garbage-code-hunter scan --save

# Output format
garbage-code-hunter analyze --format json
garbage-code-hunter analyze --format markdown
```

## LLM mode

The application can switch to LLM-backed roast generation.
Use `--llm` together with `--llm-provider`, `--llm-endpoint`, `--llm-model`, `--llm-api-key`, and `--llm-timeout`.
The supported providers currently include `ollama` and generic OpenAI-style endpoints.

Example:

```bash
garbage-code-hunter analyze --llm --llm-provider ollama
```