Skip to content

Commit 8b0283a

Browse files
committed
docs: update deslop-around documentation for pipeline architecture
Added comprehensive documentation for the new 3-phase slop detection pipeline introduced in #107: - **Architecture section**: Explains Phase 1 (regex), Phase 2 (multi-pass), Phase 3 (CLI tools) with certainty levels (HIGH/MEDIUM/LOW) - **Thoroughness levels**: Documents quick/normal/deep modes - **Language-aware tools**: Lists recommended tools per language - JavaScript/TypeScript: jscpd, madge, escomplex - Python: pylint, radon - Go: golangci-lint - Rust: clippy - **Enhanced detection list**: Added buzzword inflation and code smells Updated files: - README.md: Main command reference - docs/USAGE.md: Detailed usage guide Refs #107
1 parent 1d7569b commit 8b0283a

2 files changed

Lines changed: 36 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,14 +152,28 @@ Ship your code from commit to production with full validation and state integrat
152152

153153
### `/deslop-around` - AI Slop Cleanup
154154

155-
Remove debugging code, old TODOs, and AI slop from your codebase.
155+
Remove debugging code, old TODOs, and AI slop from your codebase with a 3-phase detection pipeline.
156156

157157
```bash
158158
/deslop-around # Report mode - analyze only
159159
/deslop-around apply # Apply fixes with verification
160160
/deslop-around apply src/ 10 # Fix up to 10 issues in src/
161161
```
162162

163+
**Architecture:**
164+
- **Phase 1** - Built-in regex patterns (HIGH certainty)
165+
- **Phase 2** - Multi-pass analyzers (MEDIUM certainty)
166+
- **Phase 3** - Optional CLI tools (LOW certainty, graceful degradation)
167+
- JavaScript/TypeScript: jscpd, madge, escomplex
168+
- Python: pylint, radon
169+
- Go: golangci-lint
170+
- Rust: clippy
171+
172+
**Thoroughness levels:**
173+
- `quick` - Phase 1 only (fastest)
174+
- `normal` - Phase 1 + Phase 2 (default)
175+
- `deep` - Phase 1 + Phase 2 + Phase 3 (if tools available)
176+
163177
**Detects:**
164178
- Console debugging (`console.log`, `print()`, `dbg!()`)
165179
- Old TODOs and commented code
@@ -170,6 +184,7 @@ Remove debugging code, old TODOs, and AI slop from your codebase.
170184
- Phantom references (issue/PR mentions, file path references in comments)
171185
- Infrastructure components configured but never used (unused DB clients, caches, API clients)
172186
- Code smells: boolean blindness, message chains, mutable globals, dead code, shotgun surgery
187+
- Buzzword inflation (quality claims without evidence)
173188

174189
---
175190

docs/USAGE.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,38 @@ Complete guide to using awesome-slash commands with real-world examples.
4747

4848
### `/deslop-around`
4949

50-
Remove debugging code, old TODOs, and AI slop from your codebase.
50+
Remove debugging code, old TODOs, and AI slop from your codebase with a 3-phase detection pipeline.
5151

5252
```bash
5353
/deslop-around # Report mode (safe, no changes)
5454
/deslop-around apply # Apply fixes automatically
5555
/deslop-around apply src/ 10 # Fix 10 issues in src/ only
5656
```
5757

58+
**Architecture:**
59+
- **Phase 1** - Built-in regex patterns (HIGH certainty) - always runs
60+
- **Phase 2** - Multi-pass analyzers (MEDIUM certainty) - context-aware
61+
- **Phase 3** - Optional CLI tools (LOW certainty) - graceful degradation
62+
- JavaScript/TypeScript: jscpd, madge, escomplex
63+
- Python: pylint, radon
64+
- Go: golangci-lint
65+
- Rust: clippy
66+
67+
**Thoroughness levels:**
68+
- `quick` - Phase 1 only (fastest)
69+
- `normal` - Phase 1 + Phase 2 (default, recommended)
70+
- `deep` - All phases if tools available (most thorough)
71+
5872
**Detects:**
5973
- Console debugging (`console.log`, `print()`, `dbg!()`)
6074
- Old TODOs and commented code
6175
- Placeholder text, magic numbers
6276
- Empty catch blocks, disabled linters
77+
- Placeholder functions
78+
- Excessive documentation
79+
- Phantom references
80+
- Buzzword inflation
81+
- Code smells and over-engineering patterns
6382

6483
---
6584

0 commit comments

Comments
 (0)