-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathcli.py
More file actions
375 lines (314 loc) · 12.6 KB
/
Copy pathcli.py
File metadata and controls
375 lines (314 loc) · 12.6 KB
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
"""DeadCode CLI — Detect and remove unused code in TS/React/Next.js projects."""
from __future__ import annotations
import json
import sys
from pathlib import Path
import click
from rich.console import Console
from rich.table import Table
from . import __version__
from .config import DeadCodeConfig
from .scanner import DeadCodeScanner, Finding
console = Console()
err_console = Console(stderr=True)
FORMAT_HELP = "Output format: pretty (default), compact, github, or json"
ALL_CATEGORIES = [
"unused_export",
"dead_route",
"orphaned_css",
"unreferenced_component",
]
FORMAT_CHOICES = click.Choice(["pretty", "compact", "github", "json"])
@click.group()
@click.option("--project", "-p", default=".", help="Project directory to scan")
@click.option(
"--ignore", "-i", multiple=True, help="Additional ignore patterns (gitignore-style)"
)
@click.option(
"--include",
multiple=True,
help="Include only matching files (gitignore-style whitelist)",
)
@click.version_option(__version__, prog_name="deadcode")
@click.pass_context
def cli(
ctx: click.Context, project: str, ignore: tuple[str, ...], include: tuple[str, ...]
) -> None:
"""DeadCode — Find and remove dead code in TS/React/Next.js projects.
Scans for unused exports, dead routes, orphaned CSS classes,
and unreferenced components.
"""
ctx.ensure_object(dict)
ctx.obj["project"] = project
ctx.obj["ignore"] = list(ignore) if ignore else None
ctx.obj["include"] = list(include) if include else None
# Load .deadcode.yml config
ctx.obj["config"] = DeadCodeConfig.load(project)
def _merge_config_ignore(ctx: click.Context) -> list[str] | None:
"""Merge CLI --ignore flags with .deadcode.yml ignore patterns."""
cli_ignore = ctx.obj.get("ignore")
config = ctx.obj.get("config")
config_ignore = config.ignore if config else []
if cli_ignore and config_ignore:
return config_ignore + cli_ignore
if cli_ignore:
return cli_ignore
if config_ignore:
return config_ignore
return None
def _get_fail_threshold(ctx: click.Context) -> int:
"""Get fail threshold from config."""
config = ctx.obj.get("config")
return config.fail_threshold if config else -1
# ── scan ──────────────────────────────────────────────────────────────
@cli.command()
@click.option(
"--json-output", "-j", is_flag=True, help="Alias for --format=json (deprecated)"
)
@click.option("--format", type=FORMAT_CHOICES, default="pretty", help=FORMAT_HELP)
@click.option(
"--category",
"-c",
type=click.Choice(ALL_CATEGORIES),
default=None,
help="Filter by category",
)
@click.option(
"--fail",
"fail_threshold",
type=int,
default=None,
help="Exit code 1 if findings >= threshold (overrides .deadcode.yml)",
)
@click.pass_context
def scan(
ctx: click.Context,
json_output: bool,
format: str | None,
category: str | None,
fail_threshold: int | None,
) -> None:
"""Scan project for dead code."""
project = ctx.obj["project"]
ignore = _merge_config_ignore(ctx)
if not Path(project).exists():
err_console.print(f"[red]Project directory '{project}' not found.[/red]")
sys.exit(1)
include_patterns = ctx.obj.get("include")
scanner = DeadCodeScanner(
project, ignore_patterns=ignore, include_patterns=include_patterns
)
result = scanner.scan()
# Filter by category
findings = result.findings
if category:
findings = [f for f in findings if f.category == category]
# Also respect config-level category filter if no CLI override
config = ctx.obj.get("config")
if not category and config and config.categories:
findings = [f for f in findings if f.category in config.categories]
# Determine effective format (legacy --json-output maps to json)
effective_format = "json" if json_output else (format or "pretty")
if effective_format == "json":
output = {
"files_scanned": result.files_scanned,
"findings": [
{
"file": f.file,
"line": f.line,
"name": f.name,
"category": f.category,
"detail": f.detail,
"removable": f.removable,
}
for f in findings
],
"errors": result.errors,
}
console.print(json.dumps(output, indent=2, default=str))
elif effective_format == "compact":
if not findings:
console.print("OK — 0 findings")
else:
for f in findings:
console.print(f"{f.file}:{f.line} \u2014 {f.category}: {f.name}")
console.print(f"\n{len(findings)} findings")
elif effective_format == "github":
# GitHub Actions annotation syntax
# ::warning file={name},line={line},endLine={line}::{message}
if not findings:
console.print("deadcode: 0 findings")
else:
for f in findings:
level = "error" if f.removable else "warning"
msg = f"{f.category}: {f.name}"
if f.detail:
msg += f" ({f.detail[:120]})"
console.print(f"::{level} file={f.file},line={f.line}::{msg}")
console.print(f"\n::notice::deadcode: {len(findings)} findings")
else:
# Summary
console.print(
f"\n[bold]DeadCode Scan[/bold] — {result.files_scanned} files scanned\n"
)
if not findings:
console.print("[green]✓ No dead code found![/green]")
else:
# Group by category
by_category: dict[str, list[Finding]] = {}
for f in findings:
by_category.setdefault(f.category, []).append(f)
category_labels = {
"unused_export": "Unused Exports",
"dead_route": "Dead Routes",
"orphaned_css": "Orphaned CSS",
"unreferenced_component": "Unreferenced Components",
}
for cat, cat_findings in by_category.items():
label = category_labels.get(cat, cat)
console.print(
f"\n[bold yellow]{label}[/bold yellow] ({len(cat_findings)})"
)
table = Table(show_header=True)
table.add_column("File", style="cyan")
table.add_column("Line", style="magenta", justify="right")
table.add_column("Name", style="green")
table.add_column("Detail")
for f in cat_findings[:50]: # Limit display
table.add_row(f.file, str(f.line), f.name, f.detail[:60])
console.print(table)
if len(cat_findings) > 50:
console.print(f" [dim]... and {len(cat_findings) - 50} more[/dim]")
# Total
removable = sum(1 for f in findings if f.removable)
console.print(
f"\n[bold]Total:[/bold] {len(findings)} findings ({removable} removable)"
)
if result.errors:
console.print(
f"\n[yellow]{len(result.errors)} scan errors (use --json-output to see)[/yellow]"
)
# CI fail threshold
effective_threshold = (
fail_threshold if fail_threshold is not None else _get_fail_threshold(ctx)
)
if effective_threshold >= 0 and len(findings) >= effective_threshold:
if effective_format not in ("json", "github"):
console.print(
f"\n[red]FAIL: {len(findings)} findings >= threshold {effective_threshold}[/red]"
)
sys.exit(1)
# ── remove ────────────────────────────────────────────────────────────
@cli.command()
@click.option(
"--dry-run",
is_flag=True,
help="Preview what would be removed without making changes",
)
@click.option(
"--category",
"-c",
type=click.Choice(ALL_CATEGORIES),
default=None,
help="Only remove findings in this category",
)
@click.pass_context
def remove(ctx: click.Context, dry_run: bool, category: str | None) -> None:
"""Remove dead code (with --dry-run for preview).
WARNING: This modifies files. Always use --dry-run first and
commit your code before running without it.
"""
project = ctx.obj["project"]
ignore = _merge_config_ignore(ctx)
if not Path(project).exists():
err_console.print(f"[red]Project directory '{project}' not found.[/red]")
sys.exit(1)
if not dry_run:
console.print(
"[red]WARNING: This will modify files. Use --dry-run first![/red]"
)
console.print("[dim]Press Ctrl+C to abort. Running in 3 seconds...[/dim]")
import time
time.sleep(3)
include_patterns = ctx.obj.get("include")
scanner = DeadCodeScanner(
project, ignore_patterns=ignore, include_patterns=include_patterns
)
result = scanner.scan()
findings = result.findings
if category:
findings = [f for f in findings if f.category == category]
# Also respect config-level category filter if no CLI override
config = ctx.obj.get("config")
if not category and config and config.categories:
findings = [f for f in findings if f.category in config.categories]
# Only remove removable findings
removable = [f for f in findings if f.removable]
if not removable:
console.print("[green]✓ Nothing removable found.[/green]")
return
# Group by file
by_file: dict[str, list[Finding]] = {}
for f in removable:
by_file.setdefault(f.file, []).append(f)
removed_count = 0
project_path = Path(project).resolve()
for rel_file, file_findings in sorted(by_file.items()):
filepath = project_path / rel_file
if not filepath.exists():
continue
try:
lines = filepath.read_text(encoding="utf-8", errors="replace").splitlines(
keepends=True
)
except Exception as e:
console.print(f"[red]Error reading {rel_file}: {e}[/red]")
continue
# Remove lines in reverse order to preserve line numbers
lines_to_remove = sorted(set(f.line for f in file_findings), reverse=True)
if dry_run:
for line_num in sorted(lines_to_remove):
content = lines[line_num - 1].rstrip() if line_num <= len(lines) else ""
console.print(
f"[yellow]WOULD REMOVE[/yellow] {rel_file}:{line_num} — {content.strip()[:80]}"
)
removed_count += len(lines_to_remove)
else:
for line_num in lines_to_remove:
if 0 < line_num <= len(lines):
lines[line_num - 1] = "" # Blank the line (safer than deleting)
filepath.write_text("".join(lines), encoding="utf-8")
removed_count += len(lines_to_remove)
console.print(
f"[green]✓[/green] Cleaned {rel_file} ({len(lines_to_remove)} lines)"
)
action = "Would remove" if dry_run else "Removed"
console.print(f"\n[bold]{action}: {removed_count} dead code entries[/bold]")
# ── stats ─────────────────────────────────────────────────────────────
@cli.command()
@click.pass_context
def stats(ctx: click.Context) -> None:
"""Show quick stats about the project's dead code."""
project = ctx.obj["project"]
ignore = _merge_config_ignore(ctx)
include_patterns = ctx.obj.get("include")
scanner = DeadCodeScanner(
project, ignore_patterns=ignore, include_patterns=include_patterns
)
result = scanner.scan()
console.print(f"Files scanned: [bold]{result.files_scanned}[/bold]")
console.print(
f"Unused exports: [bold yellow]{len(result.unused_exports)}[/bold yellow]"
)
console.print(f"Dead routes: [bold red]{len(result.dead_routes)}[/bold red]")
console.print(
f"Orphaned CSS: [bold magenta]{len(result.orphaned_css)}[/bold magenta]"
)
console.print(
f"Unreferenced components: [bold cyan]{len(result.unreferenced_components)}[/bold cyan]"
)
console.print(f"Total findings: [bold]{len(result.findings)}[/bold]")
if result.errors:
console.print(f"[yellow]Errors: {len(result.errors)}[/yellow]")
if __name__ == "__main__":
cli()