deadrule 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.ko.md ADDED
@@ -0,0 +1,158 @@
1
+ # deadrule
2
+
3
+ AI 코딩 어시스턴트 설정에서 죽은 규칙을 찾아줍니다.
4
+
5
+ AI 코딩 도구(Claude Code, Cursor, Codex)에서 규칙과 스킬을 정의할 수 있습니다. 시간이 지나면 규칙이 쌓입니다. 어떤 건 작업과 전혀 관련이 없고, 어떤 건 서로 중복되고, 어떤 건 AI가 이미 하는 것을 또 지시합니다. **deadrule**이 찾아줍니다.
6
+
7
+ **[English README](README.md)**
8
+
9
+ ## 데모
10
+
11
+ ![deadrule 데모](demo/demo.gif)
12
+
13
+ ## 바로 시작
14
+
15
+ ```bash
16
+ npx deadrule
17
+ ```
18
+
19
+ API 키 불필요. 설정 불필요. 런타임 의존성 0개.
20
+
21
+ ## 검사 항목
22
+
23
+ | 검사 | 찾는 것 |
24
+ |------|---------|
25
+ | **죽은 규칙** | 한 번도 쓰지 않는 언어의 규칙 (세션 로그 기반) |
26
+ | **중복 파일** | 서로 겹치는 규칙 파일 |
27
+ | **겹치는 지시사항** | 여러 파일에 복붙된 동일 지시문 |
28
+ | **기본 동작 중복** | Claude가 이미 하는 행동을 또 지시하는 규칙 |
29
+ | **모호한 지시사항** | 너무 추상적이라 실행 불가능한 지시문 |
30
+ | **토큰 비용** | 각 규칙 파일이 소비하는 토큰 수 |
31
+ | **오래된 규칙** | 90일 이상 수정되지 않은 규칙 |
32
+
33
+ ## 죽은 규칙을 찾는 방법
34
+
35
+ deadrule은 모든 프로젝트의 Claude Code 세션 로그(JSONL)를 읽습니다. 실제로 편집한 파일 확장자(`.ts`, `.py`, `.go` 등)를 추출한 뒤, 규칙과 대조합니다. Python 규칙이 있는데 `.py` 파일을 한 번도 편집하지 않았다면 — 그 규칙은 **죽은 규칙**입니다.
36
+
37
+ ## 커스텀 경로
38
+
39
+ ```bash
40
+ # 특정 디렉토리 스캔
41
+ deadrule ./my-rules/
42
+
43
+ # 여러 경로 동시 스캔
44
+ deadrule ./rules/ ./agents/
45
+
46
+ # 클론한 규칙 세트 스캔
47
+ deadrule ~/everything-claude-code/rules/
48
+ ```
49
+
50
+ ## 기본 스캔 위치
51
+
52
+ - `~/.claude/rules/*.md` (글로벌 규칙)
53
+ - `.claude/rules/*.md` (프로젝트 규칙)
54
+ - `CLAUDE.md` (프로젝트 루트)
55
+ - `.cursorrules` (Cursor)
56
+
57
+ ## 실전 테스트: Everything Claude Code (136개 규칙)
58
+
59
+ ```
60
+ $ deadrule ./rules/ ./agents/
61
+
62
+ deadrule v0.2.1
63
+ ================
64
+
65
+ Scanned: 136 rules (0 global, 136 project)
66
+ Total token cost: ~90,077 tokens (45.0% of context)
67
+
68
+ DEAD RULES (based on 34 sessions across all projects)
69
+ Languages you actually use:
70
+ .js 8 file edits
71
+ .ts 7 file edits
72
+ .tsx 7 file edits
73
+ .html 7 file edits
74
+ .py 4 file edits
75
+
76
+ Rules for languages you NEVER use:
77
+ cpp/coding-style.md
78
+ -> No C++ files edited in 34 sessions
79
+ dart/coding-style.md
80
+ -> No Dart/Flutter files edited in 34 sessions
81
+ rust/coding-style.md
82
+ -> No Rust files edited in 34 sessions
83
+ ... (총 61개 죽은 규칙)
84
+
85
+ OVERLAPPING DIRECTIVES (50 found, showing top 5)
86
+ "Surgical fixes only - don't refactor, just fix the error"
87
+ -> repeated in: 7 files
88
+
89
+ "Approve: No CRITICAL or HIGH issues"
90
+ -> repeated in: 11 files
91
+
92
+ REDUNDANT WITH CLAUDE DEFAULTS
93
+ "SQL injection prevention (parameterized queries)"
94
+ -> Claude already uses parameterized queries by default
95
+
96
+ SUMMARY
97
+ 61 DEAD rule(s) - never relevant to your work
98
+ 1 duplicate pair(s)
99
+ 50 overlapping directive(s)
100
+ 13 redundant with Claude defaults
101
+ 25 vague directive(s)
102
+ ```
103
+
104
+ 주요 발견:
105
+ - **136개 규칙 중 61개가 죽은 규칙** — 매 세션 로드되지만 한 번도 관련 없음
106
+ - **약 9만 토큰 (컨텍스트의 45%)** 이 규칙에만 소비됨
107
+
108
+ ## GitHub Action
109
+
110
+ 워크플로우에 추가하면 PR마다 자동으로 규칙 건강 상태를 체크합니다:
111
+
112
+ ```yaml
113
+ # .github/workflows/deadrule.yml
114
+ name: Rule Health Check
115
+ on: [pull_request]
116
+
117
+ jobs:
118
+ deadrule:
119
+ runs-on: ubuntu-latest
120
+ steps:
121
+ - uses: actions/checkout@v4
122
+ - uses: JSK9999/deadrule@main
123
+ with:
124
+ paths: '.claude/rules'
125
+ ```
126
+
127
+ 문제가 발견되면 PR에 자동으로 리포트 코멘트가 달립니다.
128
+
129
+ ## CLI 옵션
130
+
131
+ ```bash
132
+ # 기본 스캔
133
+ npx deadrule
134
+
135
+ # 커스텀 경로 스캔
136
+ npx deadrule ./rules/ ./agents/
137
+
138
+ # CI/CD용 JSON 출력
139
+ npx deadrule --json
140
+ ```
141
+
142
+ ## 로드맵
143
+
144
+ [이슈 목록](https://github.com/JSK9999/deadrule/issues)에서 계획된 기능을 확인하세요.
145
+
146
+ - [x] CI/CD용 `--json` 출력
147
+ - [x] GitHub Action + PR 코멘트
148
+ - [ ] `--fix` 중복 규칙 자동 병합
149
+ - [ ] Cursor `.mdc` 및 Codex `AGENTS.md` 지원
150
+ - [ ] 프로젝트 간 규칙 비교
151
+
152
+ ## 기여
153
+
154
+ [CONTRIBUTING.md](CONTRIBUTING.md)에서 설정 방법과 가이드라인을 확인하세요.
155
+
156
+ ## 라이선스
157
+
158
+ Apache 2.0
package/README.md CHANGED
@@ -2,7 +2,13 @@
2
2
 
3
3
  Find dead rules in your AI coding assistant config.
4
4
 
5
- AI coding tools (Claude Code, Cursor, Codex) let you define rules and skills. Over time, rules pile up. Some duplicate each other. Some repeat what the AI already does. Some are too vague to follow. **deadrule** finds them.
5
+ AI coding tools (Claude Code, Cursor, Codex) let you define rules and skills. Over time, rules pile up. Some are never relevant to your work. Some duplicate each other. Some repeat what the AI already does. **deadrule** finds them.
6
+
7
+ **[한국어 README](README.ko.md)**
8
+
9
+ ## Demo
10
+
11
+ ![deadrule demo](demo/demo.gif)
6
12
 
7
13
  ## Quick Start
8
14
 
@@ -16,6 +22,7 @@ No API keys. No setup. No runtime dependencies.
16
22
 
17
23
  | Check | What it finds |
18
24
  |-------|--------------|
25
+ | **Dead rules** | Rules for languages you never use (based on session logs) |
19
26
  | **Duplicates** | Rules that overlap with each other |
20
27
  | **Overlapping directives** | Same instruction copied across multiple files |
21
28
  | **Claude defaults** | Rules that repeat Claude's built-in behavior |
@@ -23,12 +30,14 @@ No API keys. No setup. No runtime dependencies.
23
30
  | **Token cost** | How many tokens each rule file consumes |
24
31
  | **Stale rules** | Rules not modified in 90+ days |
25
32
 
26
- ## Custom Paths
33
+ ## How it finds dead rules
34
+
35
+ deadrule reads your Claude Code session logs (JSONL) across all projects. It extracts which file types you actually edit (`.ts`, `.py`, `.go`, etc.), then cross-references with your rules. If you have Python rules but never edited a `.py` file — those rules are **dead**.
27
36
 
28
- Scan any directory of rules:
37
+ ## Custom Paths
29
38
 
30
39
  ```bash
31
- # Scan a specific rules directory
40
+ # Scan a specific directory
32
41
  deadrule ./my-rules/
33
42
 
34
43
  # Scan multiple paths
@@ -38,7 +47,7 @@ deadrule ./rules/ ./agents/
38
47
  deadrule ~/everything-claude-code/rules/
39
48
  ```
40
49
 
41
- ## Where it scans (default)
50
+ ## Default scan locations
42
51
 
43
52
  - `~/.claude/rules/*.md` (global rules)
44
53
  - `.claude/rules/*.md` (project rules)
@@ -50,55 +59,94 @@ deadrule ~/everything-claude-code/rules/
50
59
  ```
51
60
  $ deadrule ./rules/ ./agents/
52
61
 
53
- deadrule v0.1.0
62
+ deadrule v0.2.1
54
63
  ================
55
64
 
56
65
  Scanned: 136 rules (0 global, 136 project)
57
66
  Total token cost: ~90,077 tokens (45.0% of context)
58
67
 
59
- DUPLICATES
60
- agents/java-build-resolver.md <-> agents/kotlin-build-resolver.md (51% overlap)
61
-
62
- OVERLAPPING DIRECTIVES (50 found, showing top 10)
68
+ DEAD RULES (based on 34 sessions across all projects)
69
+ Languages you actually use:
70
+ .js 8 file edits
71
+ .ts 7 file edits
72
+ .tsx 7 file edits
73
+ .html 7 file edits
74
+ .py 4 file edits
75
+
76
+ Rules for languages you NEVER use:
77
+ cpp/coding-style.md
78
+ -> No C++ files edited in 34 sessions
79
+ dart/coding-style.md
80
+ -> No Dart/Flutter files edited in 34 sessions
81
+ rust/coding-style.md
82
+ -> No Rust files edited in 34 sessions
83
+ ... (61 dead rules total)
84
+
85
+ OVERLAPPING DIRECTIVES (50 found, showing top 5)
63
86
  "Surgical fixes only - don't refactor, just fix the error"
64
- -> repeated in: agents/cpp-build-resolver.md, agents/dart-build-resolver.md,
65
- agents/java-build-resolver.md, agents/rust-build-resolver.md,
66
- agents/go-build-resolver.md, agents/kotlin-build-resolver.md,
67
- agents/pytorch-build-resolver.md
87
+ -> repeated in: 7 files
68
88
 
69
89
  "Approve: No CRITICAL or HIGH issues"
70
- -> repeated in: common/code-review.md, agents/code-reviewer.md,
71
- agents/cpp-reviewer.md, agents/csharp-reviewer.md, ... (11 files)
90
+ -> repeated in: 11 files
72
91
 
73
92
  REDUNDANT WITH CLAUDE DEFAULTS
74
- common/security.md: "SQL injection prevention (parameterized queries)"
75
- -> Claude already uses parameterized queries by default
76
-
77
- java/security.md: "Always use parameterized queries - never concat..."
93
+ "SQL injection prevention (parameterized queries)"
78
94
  -> Claude already uses parameterized queries by default
79
95
 
80
- TOKEN COST BREAKDOWN (top 10)
81
- agents/flutter-reviewer.md ~ 3510 tokens ||||...... 4%
82
- agents/performance-optimizer.md ~ 3111 tokens |||....... 3%
83
- agents/code-reviewer.md ~ 2187 tokens ||........ 2%
84
- ... 126 more files (~69,115 tokens)
85
-
86
96
  SUMMARY
97
+ 61 DEAD rule(s) - never relevant to your work
87
98
  1 duplicate pair(s)
88
99
  50 overlapping directive(s)
89
100
  13 redundant with Claude defaults
90
101
  25 vague directive(s)
91
102
  ```
92
103
 
93
- Key finding: **ECC loads ~90K tokens (45% of context window) in rules alone.**
104
+ Key findings:
105
+ - **61 out of 136 rules are dead** — loaded every session but never relevant
106
+ - **~90K tokens (45% of context window)** consumed by rules alone
107
+
108
+ ## GitHub Action
109
+
110
+ Add to your workflow to automatically check rule health on every PR:
111
+
112
+ ```yaml
113
+ # .github/workflows/deadrule.yml
114
+ name: Rule Health Check
115
+ on: [pull_request]
116
+
117
+ jobs:
118
+ deadrule:
119
+ runs-on: ubuntu-latest
120
+ steps:
121
+ - uses: actions/checkout@v4
122
+ - uses: JSK9999/deadrule@main
123
+ with:
124
+ paths: '.claude/rules'
125
+ ```
126
+
127
+ This will comment on PRs with a rule health report when issues are found.
128
+
129
+ ## CLI Options
130
+
131
+ ```bash
132
+ # Default scan
133
+ npx deadrule
134
+
135
+ # Scan custom paths
136
+ npx deadrule ./rules/ ./agents/
137
+
138
+ # JSON output for CI/CD
139
+ npx deadrule --json
140
+ ```
94
141
 
95
142
  ## Roadmap
96
143
 
97
144
  See [open issues](https://github.com/JSK9999/deadrule/issues) for planned features.
98
145
 
99
- - [ ] Runtime rule tracking via hooks (find truly unused rules)
100
- - [ ] `--json` output for CI/CD
146
+ - [x] `--json` output for CI/CD
147
+ - [x] GitHub Action with PR comments
101
148
  - [ ] `--fix` auto-merge duplicate rules
149
+ - [ ] Cursor `.mdc` and Codex `AGENTS.md` support
102
150
  - [ ] Cross-project rule comparison
103
151
 
104
152
  ## Contributing
package/dist/index.js CHANGED
@@ -9,8 +9,10 @@ import { analyzeStaleness } from "./analyzers/staleness.js";
9
9
  import { analyzeUsage } from "./analyzers/usage.js";
10
10
  import { printReport } from "./reporter.js";
11
11
  async function main() {
12
+ const args = process.argv.slice(2);
13
+ const jsonMode = args.includes("--json");
12
14
  const cwd = process.cwd();
13
- const customPaths = process.argv.slice(2).filter((a) => !a.startsWith("-"));
15
+ const customPaths = args.filter((a) => !a.startsWith("-"));
14
16
  const scanResults = await scanRuleFiles(cwd, customPaths);
15
17
  if (scanResults.length === 0) {
16
18
  console.log("No rule files found.");
@@ -44,13 +46,18 @@ async function main() {
44
46
  }
45
47
  : undefined,
46
48
  };
47
- printReport(result);
48
49
  const issues = duplicates.length +
49
50
  directiveOverlaps.length +
50
51
  defaultMatches.length +
51
52
  vagueDirectives.length +
52
53
  staleRules.length +
53
54
  (result.usage?.deadRules.length ?? 0);
55
+ if (jsonMode) {
56
+ console.log(JSON.stringify({ ...result, issueCount: issues }, null, 2));
57
+ }
58
+ else {
59
+ printReport(result);
60
+ }
54
61
  process.exit(issues > 0 ? 1 : 0);
55
62
  }
56
63
  main().catch((err) => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "deadrule",
3
- "version": "0.2.1",
3
+ "version": "0.3.0",
4
4
  "description": "Find dead rules in your AI coding assistant config",
5
5
  "type": "module",
6
6
  "bin": {