garbage-code-hunter 0.2.0

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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

# πŸ—‘οΈ Garbage Code Hunter

[![CI/CD](https://github.com/yourusername/garbage-code-hunter/actions/workflows/ci.yml/badge.svg)](https://github.com/yourusername/garbage-code-hunter/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/garbage-code-hunter.svg)](https://crates.io/crates/garbage-code-hunter)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Rust Version](https://img.shields.io/badge/rust-stable-orange.svg)](https://www.rust-lang.org/)

[English](README.md) | [δΈ­ζ–‡](./README_zh.md)

A humorous Rust code quality detector that roasts your garbage code with style!

> **Inspiration**: https://github.com/Done-0/fuck-u-code.git

## What is this?

Garbage Code Hunter is a Rust static analysis tool. Unlike traditional linters that give you dry warnings, we tell you how bad your code is in a **sarcastic, witty, and brutally honest** way.

Think of it as a code reviewer who isn't afraid to hurt your feelings (but it's for your own good).

## What can it do?

- πŸ” **Detect code smells**: Bad naming, deep nesting, long functions, unwrap abuse...
- πŸ”— **Cross-file duplication detection** (NEW!): Find copy-pasted code across files
- 🎯 **Context-aware analysis**: Automatically adjusts sensitivity for tests/examples/UI code
- πŸ—£οΈ **Savage roasts**: Every warning comes with a humorous roast to make you laugh while fixing
- πŸ“Š **Quality scoring**: 0-100 scale, higher score = worse code
- 🌍 **Bilingual**: Supports both English and Chinese roasts
- πŸ€– **LLM powered**: Connect to Ollama for even more creative roasts
- πŸ”Œ **VSCode extension**: Real-time roasting in your editor

## ✨ New in v0.2.0

### πŸš€ Cross-File Duplication Detection
Automatically detects duplicated functions across your entire codebase:
```bash
garbage-code-hunter --verbose src/
# Output includes: πŸ“Œ cross-file-duplication: 33 issues
```

### 🎯 Context-Aware Analysis
Reduces false positives by understanding code context:
- **Example/Demo code**: Reduces sensitivity by 70%
- **Test code**: Reduces sensitivity by 80%
- **Benchmark/Documentation**: Further reductions
- **Business code**: Full detection (default)

### ⚑ Performance Improvements
- **5x faster**: Large projects (200+ files) analyzed in <1 second
- **Low memory usage**: <50MB for 200+ file projects
- **Zero warnings**: Clean compilation with 57 passing tests

## Quick Start

### Install

```bash
cargo install garbage-code-hunter
```

### Usage

```bash
# Analyze current directory
garbage-code-hunter

# Analyze specific file
garbage-code-hunter src/main.rs

# Chinese roasts
garbage-code-hunter --lang zh-CN src/

# Generate Markdown report
garbage-code-hunter --markdown src/ > report.md
```

## Example Output

```
πŸ—‘οΈ  Garbage Code Hunter πŸ—‘οΈ

πŸ“Š Code Quality Report
────────────────────────────────────
πŸ“ˆ Issue Statistics:
   8 πŸ”₯ Nuclear Issues (fix immediately)
   15 🌢️  Spicy Issues (should fix)
   12 😐 Mild Issues (can ignore)

πŸ† Code Quality Score
────────────────────────────────────
   πŸ“Š Total: 63.0/100 😞
   🎯 Level: Poor

πŸ“ src/main.rs
  🏷️ Naming issue: "This variable name is more random than my passwords"
  πŸ“¦ Nesting issue: "Nesting so deep, trying to dig to the Earth's core?"
  ⚠️ Unwrap abuse: "unwrap() is more unstable than my emotions"
```

## VSCode Extension

Get real-time roasting in VSCode:

1. Install the `garbage-code-hunter` CLI
2. Search "Garbage Code Hunter" in VSCode marketplace
3. Analysis triggers automatically when you save Rust files

## License

Apache License 2.0

---

**Remember**: We roast the code, not you. Let's make code reviews a bit more fun! πŸš€