Skip to content

Commit a5be5bd

Browse files
fix: correct step indentation in CI workflow
2 parents 8fcb9cf + 0e28634 commit a5be5bd

3 files changed

Lines changed: 27 additions & 27 deletions

File tree

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -22,48 +22,48 @@
2222
pip install rh-deadcode
2323

2424
# Scan current project
25-
deadcode scan
25+
rh-deadcode scan
2626

2727
# Scan a specific project
28-
deadcode scan -p /path/to/project
28+
rh-deadcode scan -p /path/to/project
2929

3030
# Preview removable dead code
31-
deadcode remove --dry-run
31+
rh-deadcode remove --dry-run
3232

3333
# Remove confirmed dead code
34-
deadcode remove
34+
rh-deadcode remove
3535
```
3636

3737
## Commands
3838

39-
### `deadcode scan`
39+
### `rh-deadcode scan`
4040

4141
Scan a TypeScript/React/Next.js project for all categories of dead code.
4242

4343
```bash
44-
deadcode scan # Scan current directory
45-
deadcode scan -p /path/to/project # Scan specific project
46-
deadcode scan --json-output # Machine-readable JSON
47-
deadcode scan -c unused_export # Filter by category
48-
deadcode scan -i "generated/" # Ignore paths
44+
rh-deadcode scan # Scan current directory
45+
rh-deadcode scan -p /path/to/project # Scan specific project
46+
rh-deadcode scan --json-output # Machine-readable JSON
47+
rh-deadcode scan -c unused_export # Filter by category
48+
rh-deadcode scan -i "generated/" # Ignore paths
4949
```
5050

51-
### `deadcode remove`
51+
### `rh-deadcode remove`
5252

5353
Remove dead code after previewing. Always preview with `--dry-run` first.
5454

5555
```bash
56-
deadcode remove --dry-run # Preview changes (no writes)
57-
deadcode remove # Apply removals
58-
deadcode remove -c orphaned_css # Remove only orphaned CSS
56+
rh-deadcode remove --dry-run # Preview changes (no writes)
57+
rh-deadcode remove # Apply removals
58+
rh-deadcode remove -c orphaned_css # Remove only orphaned CSS
5959
```
6060

61-
### `deadcode stats`
61+
### `rh-deadcode stats`
6262

6363
Quick overview of dead code in your project.
6464

6565
```bash
66-
deadcode stats
66+
rh-deadcode stats
6767
```
6868

6969
## Categories
@@ -88,7 +88,7 @@ deadcode stats
8888
## Ignore Patterns
8989

9090
```bash
91-
deadcode scan -i "generated/" -i "**/*.generated.ts"
91+
rh-deadcode scan -i "generated/" -i "**/*.generated.ts"
9292
```
9393

9494
Default ignores: `node_modules/`, `.git/`, `.next/`, `dist/`, `build/`, `public/`, `static/`
@@ -133,16 +133,16 @@ DeadCode is one of eight tools in the Revenue Holdings suite. One license covers
133133

134134
```bash
135135
# Generate report for CI
136-
deadcode scan --json-output > deadcode-report.json
136+
rh-deadcode scan --json-output > deadcode-report.json
137137

138138
# Fail CI if any dead routes found
139-
deadcode scan -c dead_route --fail 1
139+
rh-deadcode scan -c dead_route --fail 1
140140

141141
# Fail CI if total findings exceed threshold
142-
deadcode scan --fail 10
142+
rh-deadcode scan --fail 10
143143

144144
# Track dead code trends over time
145-
deadcode scan --json-output > baseline-$(date +%Y-%m-%d).json
145+
rh-deadcode scan --json-output > baseline-$(date +%Y-%m-%d).json
146146
```
147147

148148
## Configuration (.deadcode.yml)
@@ -206,4 +206,4 @@ scoop bucket add Coding-Dev-Tools https://github.com/Coding-Dev-Tools/scoop-buck
206206
scoop install deadcode
207207
```
208208

209-
Then run: `deadcode --help`
209+
Then run: `rh-deadcode --help`

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ dependencies = [
3333
[project.optional-dependencies]
3434
licensing = ["revenueholdings-license>=0.1.0"]
3535
dev = [
36-
"pytest>=7.0.0",
37-
"pytest-cov>=4.0.0",
36+
"pytest>=7.0.0",
37+
"pytest-cov>=4.0.0",
3838
]
3939

4040
[project.scripts]

src/deadcode/cli.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
from __future__ import annotations
44

5-
import click
65
import json
76
import sys
87
from pathlib import Path
8+
9+
import click
910
from rich.console import Console
1011
from rich.table import Table
11-
1212
try:
1313
from revenueholdings_license import require_license
1414
except ImportError:
@@ -19,7 +19,7 @@ def require_license(product: str) -> None: # type: ignore[misc]
1919

2020
from . import __version__
2121
from .config import DeadCodeConfig
22-
from .scanner import DeadCodeScanner, Finding
22+
from .scanner import DeadCodeScanner, ScanResult, Finding
2323

2424
console = Console()
2525
err_console = Console(stderr=True)

0 commit comments

Comments
 (0)