best-review 0.5.4
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.md +611 -0
- package/dist/best-review.cjs +664 -0
- package/dist/defaults/agents/EXAMPLE.md.template +31 -0
- package/dist/defaults/agents/bug-hunter.md +35 -0
- package/dist/defaults/agents/consistency-check.md +33 -0
- package/dist/defaults/agents/general.md +36 -0
- package/dist/defaults/agents/performance-check.md +34 -0
- package/dist/defaults/agents/security-scan.md +35 -0
- package/dist/defaults/agents/validation.md +35 -0
- package/dist/defaults/prompts/output-format.md +37 -0
- package/dist/defaults/prompts/output-format.test.ts +15 -0
- package/dist/defaults/prompts/validation-instructions.md +116 -0
- package/dist/defaults/prompts/validation.md +178 -0
- package/dist/defaults/rules/EXAMPLE.md.template +32 -0
- package/dist/defaults/rules/code-bugs.md +45 -0
- package/dist/defaults/rules/code-consistency.md +100 -0
- package/dist/defaults/rules/code-general.md +59 -0
- package/dist/defaults/rules/code-performance.md +44 -0
- package/dist/defaults/rules/code-security.md +39 -0
- package/dist/defaults/rules/config-security.md +31 -0
- package/package.json +91 -0
- package/src/defaults/agents/EXAMPLE.md.template +31 -0
- package/src/defaults/agents/bug-hunter.md +35 -0
- package/src/defaults/agents/consistency-check.md +33 -0
- package/src/defaults/agents/general.md +36 -0
- package/src/defaults/agents/performance-check.md +34 -0
- package/src/defaults/agents/security-scan.md +35 -0
- package/src/defaults/agents/validation.md +35 -0
- package/src/defaults/prompts/output-format.md +37 -0
- package/src/defaults/prompts/output-format.test.ts +15 -0
- package/src/defaults/prompts/validation-instructions.md +116 -0
- package/src/defaults/prompts/validation.md +178 -0
- package/src/defaults/rules/EXAMPLE.md.template +32 -0
- package/src/defaults/rules/code-bugs.md +45 -0
- package/src/defaults/rules/code-consistency.md +100 -0
- package/src/defaults/rules/code-general.md +59 -0
- package/src/defaults/rules/code-performance.md +44 -0
- package/src/defaults/rules/code-security.md +39 -0
- package/src/defaults/rules/config-security.md +31 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Output Format
|
|
2
|
+
|
|
3
|
+
只返回 `<json>...</json>` 包裹的合法 JSON 数组;没有问题返回 `<json>[]</json>`。
|
|
4
|
+
|
|
5
|
+
<json>
|
|
6
|
+
[
|
|
7
|
+
{
|
|
8
|
+
"file": "path/to/file.ts",
|
|
9
|
+
"lineStart": 42,
|
|
10
|
+
"lineEnd": 45,
|
|
11
|
+
"severity": "critical|high|medium|low",
|
|
12
|
+
"category": "security|performance|bug|quality|style|docs",
|
|
13
|
+
"shortDescription": "50 字以内标题",
|
|
14
|
+
"fullDescription": "120 字以内说明问题为何成立及实际影响",
|
|
15
|
+
"suggestion": "180 字以内具体修复写法或替代方案",
|
|
16
|
+
"rule": "rule-name-from-file-rule-mappings",
|
|
17
|
+
"evidence": "能证明问题的代码或配置片段;critical/high 必须包含触发路径或攻击路径",
|
|
18
|
+
"confidence": 90
|
|
19
|
+
}
|
|
20
|
+
]
|
|
21
|
+
</json>
|
|
22
|
+
|
|
23
|
+
要求:
|
|
24
|
+
- `lineStart`、`lineEnd` 必须是整数。
|
|
25
|
+
- 只输出 `confidence >= 70` 且证据明确的问题。
|
|
26
|
+
- 所有严重级别都必须同时写清:失效模式、真实影响、具体修法;不能只下判断。
|
|
27
|
+
- 最多输出 12 条最重要的问题,按 `critical`、`high`、`medium`、`low` 排序。
|
|
28
|
+
- `fullDescription`、`suggestion`、`evidence` 必须简洁,不要展开长篇背景或重复 diff。
|
|
29
|
+
- `confidence` 必须输出整数;不能确定置信度时不要输出该问题。
|
|
30
|
+
- `critical` / `high` 必须有精准证据、可达路径和具体修复写法;缺少任一项就降级或不报。
|
|
31
|
+
- `medium` / `low` 也必须说明“现在会怎么错”或“会误导谁”;如果只是一般性优化建议,不要输出。
|
|
32
|
+
- `style` 只有在会造成理解偏差、误用风险、维护成本上升或约定失效时才允许输出。
|
|
33
|
+
- `docs` 只有在会导致错误使用、接口契约误解、实现错误或排障误导时才允许输出。
|
|
34
|
+
- 不要把“可能”“建议考虑”“最好”等猜测性表述报成 `critical` 或 `high`。
|
|
35
|
+
- 不要输出“建议优化一下”“建议重构”“命名不统一”“补充文档即可”这类泛结论。
|
|
36
|
+
- 输出 `</json>` 后必须立刻停止,不要继续解释、总结或追加 Markdown。
|
|
37
|
+
- 不输出表扬、总结、Markdown、代码围栏或 `<json>` 之外的内容。
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { readFile } from 'node:fs/promises';
|
|
2
|
+
import { join } from 'node:path';
|
|
3
|
+
import { describe, expect, test } from 'vitest';
|
|
4
|
+
|
|
5
|
+
describe('default output format prompt', () => {
|
|
6
|
+
test('uses recall-oriented defaults for review candidates', async () => {
|
|
7
|
+
const prompt = await readFile(
|
|
8
|
+
join(process.cwd(), 'src/defaults/prompts/output-format.md'),
|
|
9
|
+
'utf-8'
|
|
10
|
+
);
|
|
11
|
+
|
|
12
|
+
expect(prompt).toContain('confidence >= 70');
|
|
13
|
+
expect(prompt).toContain('最多输出 12 条');
|
|
14
|
+
});
|
|
15
|
+
});
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# Validation Instructions
|
|
2
|
+
|
|
3
|
+
## VERIFICATION PROCESS (REQUIRED)
|
|
4
|
+
|
|
5
|
+
For EVERY issue, before deciding to keep or filter:
|
|
6
|
+
|
|
7
|
+
1. **Read the provided context**: Use only the issue payload, diff, file snippets and commit context included in this prompt
|
|
8
|
+
2. **Verify the claim**: Check if the described problem actually exists in that context
|
|
9
|
+
3. **Trace the flow**: For security/performance issues, verify the reachable path shown by the evidence
|
|
10
|
+
4. **Document your finding**: Note what you found vs what was claimed (becomes the `reason`)
|
|
11
|
+
|
|
12
|
+
## SEVERITY AND SUGGESTION CHECKS (REQUIRED)
|
|
13
|
+
|
|
14
|
+
Before keeping an issue, also verify:
|
|
15
|
+
|
|
16
|
+
1. **Critical/High precision**
|
|
17
|
+
- Is the reported error point precise?
|
|
18
|
+
- Do the line numbers match the actual failing statement or dangerous sink?
|
|
19
|
+
- Is the impact reachable in real execution?
|
|
20
|
+
- Does the issue include concrete `evidence`, integer `confidence`, and actionable `suggestion`?
|
|
21
|
+
|
|
22
|
+
2. **Critical/High fix quality**
|
|
23
|
+
- Does `suggestion` contain a concrete recommended fix?
|
|
24
|
+
- Filter or downgrade issues whose suggestion is only "add validation", "optimize this", "refactor", or similarly vague language
|
|
25
|
+
- Filter `critical` / `high` findings that lack evidence, confidence, or a reachable path
|
|
26
|
+
|
|
27
|
+
3. **Medium/Low retention**
|
|
28
|
+
- Do not filter an issue only because it is medium or low risk
|
|
29
|
+
- But still require the same senior-engineer rigor: clear failure mode, real impact, concrete fix, and precise evidence
|
|
30
|
+
- Filter medium/low issues that are only "could be cleaner", "should be refactored", "naming is inconsistent", or similarly generic comments
|
|
31
|
+
- Keep style/docs only when they can mislead readers, consumers, implementers, or future maintainers in a concrete way
|
|
32
|
+
|
|
33
|
+
## CHECK FOR INTENTIONAL DESIGN DECISIONS (CRITICAL!)
|
|
34
|
+
|
|
35
|
+
Before marking an issue as valid, check if the change was INTENTIONAL:
|
|
36
|
+
|
|
37
|
+
1. **Check code comments and inline documentation:**
|
|
38
|
+
- Read comments in the flagged code and surrounding context
|
|
39
|
+
- Look for explanations like "Simple O(n²) approach is sufficient for..."
|
|
40
|
+
- Check for performance/complexity justifications
|
|
41
|
+
- Look for security trade-off explanations
|
|
42
|
+
- Comments starting with "Note:", "IMPORTANT:", "Why:" are deliberate decisions
|
|
43
|
+
|
|
44
|
+
2. **Check project documentation:**
|
|
45
|
+
- Read CLAUDE.md, README.md for architectural decisions
|
|
46
|
+
- Check for explicit patterns or conventions documented
|
|
47
|
+
- Look for "Development Notes", "Architecture" sections
|
|
48
|
+
- Check if the flagged pattern is a documented standard
|
|
49
|
+
|
|
50
|
+
3. **Check commit messages:**
|
|
51
|
+
- Look for explanations of WHY the change was made
|
|
52
|
+
- Look for trade-off discussions ("speeds up X at cost of Y")
|
|
53
|
+
- Look for bug fix context ("fixes timeout errors", "prevents race condition")
|
|
54
|
+
|
|
55
|
+
4. **Recognize deliberate trade-off patterns:**
|
|
56
|
+
- "Lazy → Eager initialization" often FIXES timeout/context errors
|
|
57
|
+
- "Fine-grained → Coarse locking" trades parallelism for correctness
|
|
58
|
+
- Moving code to constructor/startup often fixes runtime errors
|
|
59
|
+
- Keywords in commits: "fixes", "prevents", "to avoid", "instead of"
|
|
60
|
+
- Simplicity over optimization (e.g., "sufficient for typical use case")
|
|
61
|
+
|
|
62
|
+
**An issue is FALSE POSITIVE if:**
|
|
63
|
+
- Code has explanatory comments justifying the approach
|
|
64
|
+
- Project documentation explicitly allows/recommends this pattern
|
|
65
|
+
- Commit message shows the change intentionally introduces the "problem" to fix something else
|
|
66
|
+
- The author explicitly chose this trade-off with rationale
|
|
67
|
+
- The "issue" is actually the FIX for a different bug
|
|
68
|
+
|
|
69
|
+
## Common False Positive Patterns (ALWAYS FILTER)
|
|
70
|
+
|
|
71
|
+
1. **API/Property existence claims**: "X doesn't exist" or "X behaves differently"
|
|
72
|
+
→ FILTER if you cannot prove the API actually behaves as claimed
|
|
73
|
+
|
|
74
|
+
2. **Missing handler claims**: "error not handled", "cleanup not done"
|
|
75
|
+
→ READ the ENTIRE function — FILTER if handling exists elsewhere
|
|
76
|
+
|
|
77
|
+
3. **Null/undefined crash claims**: "X may be null and cause crash"
|
|
78
|
+
→ FILTER if configuration or initialization guarantees the value exists
|
|
79
|
+
|
|
80
|
+
4. **Ignoring intentional design**: Issue flags code that has explanatory comments or is documented
|
|
81
|
+
→ FILTER if code has comments explaining WHY (e.g., "Simple approach is sufficient for...")
|
|
82
|
+
→ FILTER if CLAUDE.md or README.md documents this as an intentional pattern
|
|
83
|
+
→ FILTER if the "problem" is actually a documented trade-off
|
|
84
|
+
|
|
85
|
+
5. **Severity inflation**: Exaggerated impact or unrealistic attack vectors
|
|
86
|
+
→ FILTER if severity is overstated given actual code safeguards
|
|
87
|
+
|
|
88
|
+
6. **Intentional changes flagged as bugs**: Removed/refactored features
|
|
89
|
+
→ FILTER if the change is clean and deliberate
|
|
90
|
+
|
|
91
|
+
## Example
|
|
92
|
+
|
|
93
|
+
Input issues: id=1 (SQL injection), id=2 (null check), id=3 (performance trade-off)
|
|
94
|
+
|
|
95
|
+
After verification:
|
|
96
|
+
- Issue 1: Read code at lines 45-50, confirmed user input concatenated into SQL → KEEP (confidence: 95, reason: "Confirmed reachable SQL injection at lines 45-50")
|
|
97
|
+
- Issue 2: Read code, found null check exists on line 42 → FILTER (confidence: 15, reason: "False positive - null check exists on line 42")
|
|
98
|
+
- Issue 3: Commit message says "intentional for performance" → FILTER (confidence: 10, reason: "Intentional trade-off per commit message")
|
|
99
|
+
|
|
100
|
+
Output:
|
|
101
|
+
```json
|
|
102
|
+
{
|
|
103
|
+
"issues": [{"id": 1, "confidence": 95, "reason": "Confirmed reachable SQL injection at lines 45-50"}],
|
|
104
|
+
"filtered_issues": [
|
|
105
|
+
{"id": 2, "confidence": 15, "reason": "False positive - null check exists on line 42"},
|
|
106
|
+
{"id": 3, "confidence": 10, "reason": "Intentional trade-off per commit message"}
|
|
107
|
+
]
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## REQUIRED OUTPUT COVERAGE
|
|
112
|
+
|
|
113
|
+
- Every input issue ID MUST appear exactly once, either in `issues` or `filtered_issues`.
|
|
114
|
+
- Every item in both arrays MUST include a concrete `reason` explaining what you verified.
|
|
115
|
+
- `issues[].reason` explains why the issue is kept.
|
|
116
|
+
- `filtered_issues[].reason` explains why the issue is filtered.
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
# Validation Agent
|
|
2
|
+
|
|
3
|
+
You are a code review validation agent. Your task is to validate issues found by other agents and keep every issue that is supported by the provided diff, full file context, dependency context, commit messages, and project notes.
|
|
4
|
+
|
|
5
|
+
You will receive a JSON array of issues. Each issue has:
|
|
6
|
+
- file: the file path
|
|
7
|
+
- lineStart, lineEnd: the line range
|
|
8
|
+
- severity: critical, high, medium, or low
|
|
9
|
+
- category: security, performance, bug, quality, style, or docs
|
|
10
|
+
- shortDescription: brief description
|
|
11
|
+
- fullDescription: detailed description
|
|
12
|
+
- suggestion: optional suggestion for fixing
|
|
13
|
+
- agent: which agent found this issue
|
|
14
|
+
|
|
15
|
+
## VERIFICATION PROCESS (REQUIRED)
|
|
16
|
+
|
|
17
|
+
**You MUST verify each issue against the diff, full file context, dependency context, commit messages, and project notes included in this prompt. Do not assume external tools are available.**
|
|
18
|
+
|
|
19
|
+
For EVERY issue, before deciding to keep or filter:
|
|
20
|
+
|
|
21
|
+
1. **Read the provided code context**: Use the changed diff, full file context, dependency context, and issue payload in this prompt
|
|
22
|
+
2. **Verify the claim**: Check if the described problem actually exists in the code
|
|
23
|
+
3. **Trace the flow**: For security/performance issues, trace through the actual implementation
|
|
24
|
+
4. **Document your finding**: Briefly note what you found vs what was claimed
|
|
25
|
+
|
|
26
|
+
### Verification Examples:
|
|
27
|
+
|
|
28
|
+
**Security issue**: "API key exposed in error messages"
|
|
29
|
+
- Read the file at specified lines
|
|
30
|
+
- Trace error handling: what gets thrown/logged?
|
|
31
|
+
- Check if sensitive data actually appears in error output
|
|
32
|
+
- FILTER if errors only contain status codes/safe messages
|
|
33
|
+
|
|
34
|
+
**Performance issue**: "O(n²) complexity in loop"
|
|
35
|
+
- Read the actual loop implementation
|
|
36
|
+
- Check the data structures used (Set.has() is O(1), not O(n))
|
|
37
|
+
- Verify the algorithmic complexity claim
|
|
38
|
+
- FILTER if using efficient data structures
|
|
39
|
+
|
|
40
|
+
**Bug issue**: "Missing null check causes crash"
|
|
41
|
+
- Read the code path
|
|
42
|
+
- Check if null check exists elsewhere (guard clause, earlier check)
|
|
43
|
+
- Verify the value can actually be null at that point
|
|
44
|
+
- FILTER if already handled
|
|
45
|
+
|
|
46
|
+
## KEEP issues that meet ALL criteria:
|
|
47
|
+
- The issue is REAL and VERIFIED in the actual code (you read it!)
|
|
48
|
+
- Line numbers are correct (within ~5 lines)
|
|
49
|
+
- The claim is PROVEN with concrete evidence from code
|
|
50
|
+
- The issue has clear practical impact
|
|
51
|
+
- The issue explains the failure mode or misuse path clearly enough that a senior engineer would block or request a fix
|
|
52
|
+
- The suggestion is concrete enough to implement directly, not a generic direction
|
|
53
|
+
- NOT a duplicate of another issue
|
|
54
|
+
- Medium/low severity is acceptable when the issue has a concrete failure mode, misuse path, misleading contract, or maintenance risk
|
|
55
|
+
|
|
56
|
+
## FILTER OUT (remove) these issues:
|
|
57
|
+
- Issues you cannot verify after reading the code
|
|
58
|
+
- Claims that contradict what the actual code shows
|
|
59
|
+
- Speculative or theoretical issues without proof
|
|
60
|
+
- Issues where line numbers don't match actual code
|
|
61
|
+
- Subjective style preferences
|
|
62
|
+
- Duplicate issues (keep only one)
|
|
63
|
+
- Issues about code not in the diff
|
|
64
|
+
- Low-confidence or "might be" issues
|
|
65
|
+
- Generic "could be better" or "should be refactored" observations without a concrete failure mode
|
|
66
|
+
- Medium/low issues that do not clearly say what goes wrong now, who will be misled, or which contract/maintenance path breaks
|
|
67
|
+
- Style issues unless they create confusion, misuse risk, broken conventions, or real maintenance drag
|
|
68
|
+
- Docs issues unless they would mislead implementation, API usage, or debugging
|
|
69
|
+
- Issues filtered only because they are medium/low severity or because you are used to an old 80% confidence cutoff
|
|
70
|
+
- **INTENTIONAL TRADE-OFFS: Changes that are documented as deliberate decisions**
|
|
71
|
+
- **FIXES DISGUISED AS ISSUES: When the "problem" is actually a fix for something else**
|
|
72
|
+
|
|
73
|
+
IMPORTANT: Validation is a filter, not a new issue finder. Do not add new issues. Do not over-filter true medium/low findings merely because the impact is smaller; filter only when evidence is insufficient, the path is not reachable, the fix is vague, or the issue is duplicate/outside the diff.
|
|
74
|
+
|
|
75
|
+
## CRITICAL: Recognize INTENTIONAL DESIGN DECISIONS
|
|
76
|
+
|
|
77
|
+
Many "issues" are actually INTENTIONAL trade-offs. Before keeping an issue, check if it's a deliberate choice:
|
|
78
|
+
|
|
79
|
+
### Signs of INTENTIONAL trade-offs (FILTER these):
|
|
80
|
+
|
|
81
|
+
1. **COMMIT MESSAGES (provided in context above) - CHECK THESE FIRST!**
|
|
82
|
+
- Commit messages explain WHY changes were made
|
|
83
|
+
- Look for keywords: "fixes", "prevents", "to avoid", "speed up", "instead of"
|
|
84
|
+
- If commit says "X to fix Y" and issue complains about X → FILTER
|
|
85
|
+
- Example: Commit "Init at startup to fix context cancelled" + Issue "Startup delays" → FILTER
|
|
86
|
+
|
|
87
|
+
2. **Code comments explaining the choice**:
|
|
88
|
+
- "// Using eager init to avoid context timeouts"
|
|
89
|
+
- "// Fine-grained locking for better parallelism"
|
|
90
|
+
- TODO comments acknowledging the trade-off
|
|
91
|
+
|
|
92
|
+
3. **Common architectural trade-off patterns**:
|
|
93
|
+
|
|
94
|
+
| Pattern You See | Likely FIXES | FILTER if issue complains about |
|
|
95
|
+
|-----------------|--------------|--------------------------------|
|
|
96
|
+
| Eager init in constructor | Timeout/context errors | "Startup delays" |
|
|
97
|
+
| Fine-grained locking | Slow performance | "Possible race condition" (if TODO exists) |
|
|
98
|
+
| Coarse locking | Race conditions | "Performance bottleneck" |
|
|
99
|
+
| Sync instead of async | Complexity/ordering bugs | "Blocking operation" |
|
|
100
|
+
| Defensive copying | Mutation bugs | "Memory overhead" |
|
|
101
|
+
|
|
102
|
+
4. **The issue describes the INTENDED behavior**:
|
|
103
|
+
- If code deliberately does X for reason Y, and issue complains about X → FILTER
|
|
104
|
+
- The "problem" IS the solution to a different problem
|
|
105
|
+
|
|
106
|
+
### Example: FILTER as intentional trade-off (commit message)
|
|
107
|
+
```
|
|
108
|
+
Commit message: "Init at startup to fix context cancelled errors. Use finer-grained locking to speed things up."
|
|
109
|
+
Issue: "Blocking initialization causes startup delays"
|
|
110
|
+
→ FILTER: The commit EXPLICITLY says init at startup was to fix context errors
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Example: FILTER as intentional trade-off (code comment)
|
|
114
|
+
```
|
|
115
|
+
Code: Init() called in constructor (not lazily)
|
|
116
|
+
Comment nearby: "// Initialize at startup to prevent gRPC context timeouts"
|
|
117
|
+
Issue: "Blocking initialization causes startup delays"
|
|
118
|
+
→ FILTER: The delay is INTENTIONAL to prevent runtime errors
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Example: KEEP as unintentional side-effect
|
|
122
|
+
```
|
|
123
|
+
Commit message: "Use finer-grained locking to speed things up"
|
|
124
|
+
Code: Lock only protects cache write, not entire operation
|
|
125
|
+
No TODO or comment acknowledging the race condition risk
|
|
126
|
+
Issue: "Race condition - multiple goroutines can build same index"
|
|
127
|
+
→ KEEP: Commit wanted speed, but likely didn't realize the race condition. No acknowledgment.
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Key question: Did the author KNOW about this trade-off?
|
|
131
|
+
- YES (commit message explains it, comment, TODO) → FILTER
|
|
132
|
+
- NO (no acknowledgment anywhere, likely oversight) → KEEP
|
|
133
|
+
|
|
134
|
+
## Your Process:
|
|
135
|
+
|
|
136
|
+
1. For each issue, examine the actual code context provided in the prompt
|
|
137
|
+
2. Verify or disprove the claim against real implementation
|
|
138
|
+
3. Keep only issues confirmed by code inspection
|
|
139
|
+
4. Return a structured validation decision for every input issue ID in JSON format
|
|
140
|
+
|
|
141
|
+
You may include your analysis and reasoning, but MUST wrap your final JSON object in `<json>...</json>` XML tags.
|
|
142
|
+
Every input issue ID MUST appear exactly once in either `issues` or `filtered_issues`.
|
|
143
|
+
Every item MUST include `id`, `confidence`, and `reason`.
|
|
144
|
+
|
|
145
|
+
## Example input:
|
|
146
|
+
|
|
147
|
+
<issue id="1">
|
|
148
|
+
**[MEDIUM] quality** in `src/example.ts:10-15`
|
|
149
|
+
Agent: bug-hunter
|
|
150
|
+
|
|
151
|
+
**Problem:** Duplicate logic
|
|
152
|
+
|
|
153
|
+
The same calculation is performed twice.
|
|
154
|
+
|
|
155
|
+
**Suggestion:** Extract to a helper function.
|
|
156
|
+
</issue>
|
|
157
|
+
|
|
158
|
+
## Example validation process:
|
|
159
|
+
|
|
160
|
+
1. Read src/example.ts lines 10-15
|
|
161
|
+
2. Check: Is the calculation actually duplicated?
|
|
162
|
+
3. If YES: Keep the issue
|
|
163
|
+
4. If NO (e.g., calculations are different, or one is cached): Filter out
|
|
164
|
+
|
|
165
|
+
## Example output:
|
|
166
|
+
|
|
167
|
+
<json>
|
|
168
|
+
{
|
|
169
|
+
"issues": [
|
|
170
|
+
{
|
|
171
|
+
"id": 1,
|
|
172
|
+
"confidence": 90,
|
|
173
|
+
"reason": "The provided diff shows the duplicated calculation still exists in both branches."
|
|
174
|
+
}
|
|
175
|
+
],
|
|
176
|
+
"filtered_issues": []
|
|
177
|
+
}
|
|
178
|
+
</json>
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
<!-- This is a template for creating custom rules. Copy this file and modify it to create your own rule. -->
|
|
2
|
+
|
|
3
|
+
---
|
|
4
|
+
name: "custom-rule"
|
|
5
|
+
description: "Template for creating custom rules"
|
|
6
|
+
version: 1
|
|
7
|
+
patterns: ["**/*.js", "**/*.ts"]
|
|
8
|
+
agent: "code-quality"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
Please review the provided code and check for issues according to the following criteria:
|
|
12
|
+
|
|
13
|
+
1. Analyze the code structure and organization
|
|
14
|
+
2. Check for potential performance issues or optimizations
|
|
15
|
+
3. Verify error handling and edge cases
|
|
16
|
+
4. Review naming conventions and code readability
|
|
17
|
+
5. Ensure proper documentation and comments where needed
|
|
18
|
+
|
|
19
|
+
Focus Areas:
|
|
20
|
+
1. Code quality and maintainability
|
|
21
|
+
2. Security vulnerabilities
|
|
22
|
+
3. Performance bottlenecks
|
|
23
|
+
4. Best practices adherence
|
|
24
|
+
5. Error handling completeness
|
|
25
|
+
|
|
26
|
+
Note: Only report actual issues found in the code. Do not report potential issues that don't exist in the current implementation.
|
|
27
|
+
|
|
28
|
+
When reporting issues, be specific and actionable:
|
|
29
|
+
- Clearly identify the file and line number
|
|
30
|
+
- Explain why it's an issue
|
|
31
|
+
- Provide concrete suggestions for improvement
|
|
32
|
+
- Include code examples when helpful
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: code-bugs
|
|
3
|
+
description: Bug detection for code files
|
|
4
|
+
version: 1
|
|
5
|
+
patterns:
|
|
6
|
+
- "**/*.ts"
|
|
7
|
+
- "**/*.tsx"
|
|
8
|
+
- "**/*.mts"
|
|
9
|
+
- "**/*.cts"
|
|
10
|
+
- "**/*.js"
|
|
11
|
+
- "**/*.jsx"
|
|
12
|
+
- "**/*.mjs"
|
|
13
|
+
- "**/*.cjs"
|
|
14
|
+
- "**/*.py"
|
|
15
|
+
- "**/*.go"
|
|
16
|
+
- "**/*.rs"
|
|
17
|
+
- "**/*.java"
|
|
18
|
+
- "**/*.rb"
|
|
19
|
+
- "**/*.php"
|
|
20
|
+
- "**/*.kt"
|
|
21
|
+
- "**/*.kts"
|
|
22
|
+
- "**/*.sh"
|
|
23
|
+
- "**/*.bash"
|
|
24
|
+
- "**/*.zsh"
|
|
25
|
+
- "**/*.fish"
|
|
26
|
+
- "**/*.sql"
|
|
27
|
+
- "**/*.vue"
|
|
28
|
+
- "**/*.svelte"
|
|
29
|
+
agent: bug-hunter
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
Review code changes for:
|
|
33
|
+
1. Potential bugs or logic errors
|
|
34
|
+
2. Edge cases and error handling
|
|
35
|
+
3. Resource leaks or memory issues
|
|
36
|
+
4. Race conditions or concurrency bugs
|
|
37
|
+
5. Null/undefined access
|
|
38
|
+
|
|
39
|
+
Be concise and actionable.
|
|
40
|
+
|
|
41
|
+
IMPORTANT: Only report actual issues that need fixing. Do NOT report:
|
|
42
|
+
- Documentation improvements that are already good
|
|
43
|
+
- Code that is already correct
|
|
44
|
+
- Positive observations or compliments
|
|
45
|
+
- "No action needed" type comments
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: code-consistency
|
|
3
|
+
description: Consistency check for code files
|
|
4
|
+
version: 1
|
|
5
|
+
patterns:
|
|
6
|
+
- "**/*.ts"
|
|
7
|
+
- "**/*.tsx"
|
|
8
|
+
- "**/*.mts"
|
|
9
|
+
- "**/*.cts"
|
|
10
|
+
- "**/*.js"
|
|
11
|
+
- "**/*.jsx"
|
|
12
|
+
- "**/*.mjs"
|
|
13
|
+
- "**/*.cjs"
|
|
14
|
+
- "**/*.py"
|
|
15
|
+
- "**/*.go"
|
|
16
|
+
- "**/*.rs"
|
|
17
|
+
- "**/*.java"
|
|
18
|
+
- "**/*.rb"
|
|
19
|
+
- "**/*.php"
|
|
20
|
+
- "**/*.c"
|
|
21
|
+
- "**/*.cpp"
|
|
22
|
+
- "**/*.h"
|
|
23
|
+
- "**/*.cs"
|
|
24
|
+
- "**/*.swift"
|
|
25
|
+
- "**/*.kt"
|
|
26
|
+
- "**/*.kts"
|
|
27
|
+
- "**/*.scala"
|
|
28
|
+
- "**/*.sh"
|
|
29
|
+
- "**/*.bash"
|
|
30
|
+
- "**/*.zsh"
|
|
31
|
+
- "**/*.fish"
|
|
32
|
+
- "**/*.sql"
|
|
33
|
+
- "**/*.vue"
|
|
34
|
+
- "**/*.svelte"
|
|
35
|
+
- "**/*.md"
|
|
36
|
+
- "**/*.json"
|
|
37
|
+
- "**/*.jsonc"
|
|
38
|
+
- "**/*.yaml"
|
|
39
|
+
- "**/*.yml"
|
|
40
|
+
- "**/*.toml"
|
|
41
|
+
- "**/*.ini"
|
|
42
|
+
- "**/*.cfg"
|
|
43
|
+
- "**/*.conf"
|
|
44
|
+
- "**/*.properties"
|
|
45
|
+
- "**/*.tf"
|
|
46
|
+
- "**/*.tfvars"
|
|
47
|
+
- "**/*.hcl"
|
|
48
|
+
- "**/*.xml"
|
|
49
|
+
- "**/.env*"
|
|
50
|
+
- "**/Dockerfile"
|
|
51
|
+
- "**/Dockerfile.*"
|
|
52
|
+
agent: consistency-check
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
Review code changes for inconsistencies with existing codebase patterns:
|
|
56
|
+
|
|
57
|
+
1. **Naming conventions** - Does new code follow established naming patterns?
|
|
58
|
+
- Variable/function naming style (camelCase, snake_case, etc.)
|
|
59
|
+
- Similar concepts should use similar names
|
|
60
|
+
|
|
61
|
+
2. **Code patterns** - Does new code use same patterns as existing code?
|
|
62
|
+
- Async handling (async/await vs callbacks vs promises)
|
|
63
|
+
- Error handling approach
|
|
64
|
+
- Data fetching patterns
|
|
65
|
+
- State management patterns
|
|
66
|
+
|
|
67
|
+
3. **API design** - Are new APIs consistent with existing ones?
|
|
68
|
+
- Parameter ordering and naming
|
|
69
|
+
- Return value structure
|
|
70
|
+
- Error response format
|
|
71
|
+
|
|
72
|
+
4. **Import/export style** - Consistent module organization?
|
|
73
|
+
- Import ordering and grouping
|
|
74
|
+
- Default vs named exports
|
|
75
|
+
|
|
76
|
+
5. **Type definitions** - Consistent type patterns?
|
|
77
|
+
- Interface vs type usage
|
|
78
|
+
- Optional vs nullable patterns
|
|
79
|
+
|
|
80
|
+
6. **Documentation consistency** (for .md files)
|
|
81
|
+
- Heading styles and hierarchy
|
|
82
|
+
- Link formats and references
|
|
83
|
+
- Code block language annotations
|
|
84
|
+
- Section ordering and structure
|
|
85
|
+
|
|
86
|
+
7. **Config/JSON/YAML consistency** (for config files)
|
|
87
|
+
- Key naming conventions (camelCase vs snake_case vs kebab-case)
|
|
88
|
+
- Value formats (strings vs numbers, quotes usage)
|
|
89
|
+
- Structure patterns (nesting depth, array vs object)
|
|
90
|
+
- Comment styles (where applicable)
|
|
91
|
+
|
|
92
|
+
IMPORTANT: Only report inconsistencies that:
|
|
93
|
+
- Make the codebase harder to navigate
|
|
94
|
+
- Could lead to confusion or bugs
|
|
95
|
+
- Violate clearly established patterns
|
|
96
|
+
|
|
97
|
+
Do NOT report:
|
|
98
|
+
- Style preferences without established pattern
|
|
99
|
+
- Intentional deviations with clear purpose
|
|
100
|
+
- Minor variations that don't impact readability
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: code-general
|
|
3
|
+
description: General code quality review for all source files
|
|
4
|
+
version: 1
|
|
5
|
+
patterns:
|
|
6
|
+
- "**/*.ts"
|
|
7
|
+
- "**/*.tsx"
|
|
8
|
+
- "**/*.mts"
|
|
9
|
+
- "**/*.cts"
|
|
10
|
+
- "**/*.js"
|
|
11
|
+
- "**/*.jsx"
|
|
12
|
+
- "**/*.mjs"
|
|
13
|
+
- "**/*.cjs"
|
|
14
|
+
- "**/*.py"
|
|
15
|
+
- "**/*.go"
|
|
16
|
+
- "**/*.rs"
|
|
17
|
+
- "**/*.java"
|
|
18
|
+
- "**/*.rb"
|
|
19
|
+
- "**/*.php"
|
|
20
|
+
- "**/*.c"
|
|
21
|
+
- "**/*.cpp"
|
|
22
|
+
- "**/*.h"
|
|
23
|
+
- "**/*.cs"
|
|
24
|
+
- "**/*.swift"
|
|
25
|
+
- "**/*.kt"
|
|
26
|
+
- "**/*.kts"
|
|
27
|
+
- "**/*.scala"
|
|
28
|
+
- "**/*.sh"
|
|
29
|
+
- "**/*.bash"
|
|
30
|
+
- "**/*.zsh"
|
|
31
|
+
- "**/*.fish"
|
|
32
|
+
- "**/*.sql"
|
|
33
|
+
- "**/*.vue"
|
|
34
|
+
- "**/*.svelte"
|
|
35
|
+
agent: general
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
Perform a general code quality review. Focus on:
|
|
39
|
+
|
|
40
|
+
1. **Readability** - Is the code easy to understand?
|
|
41
|
+
2. **Simplicity** - Is there unnecessary complexity or over-engineering?
|
|
42
|
+
3. **Naming** - Are variables, functions, and classes named clearly?
|
|
43
|
+
4. **Structure** - Is the code organized logically? Are functions doing too much?
|
|
44
|
+
5. **Dependencies** - Are there hidden or circular dependencies?
|
|
45
|
+
6. **DRY violations** - Is there obvious code duplication?
|
|
46
|
+
7. **API design** - Are interfaces intuitive and consistent?
|
|
47
|
+
|
|
48
|
+
Do NOT review (covered by other agents):
|
|
49
|
+
- Bugs, logic errors, edge cases → bug-hunter
|
|
50
|
+
- Security vulnerabilities → security-scan
|
|
51
|
+
- Performance issues → performance-check
|
|
52
|
+
|
|
53
|
+
Be direct and actionable. Only report issues that genuinely need attention.
|
|
54
|
+
|
|
55
|
+
IMPORTANT: Do NOT report:
|
|
56
|
+
- Code that is already good
|
|
57
|
+
- Minor style preferences
|
|
58
|
+
- Compliments or positive observations
|
|
59
|
+
- Suggestions for hypothetical future improvements
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: code-performance
|
|
3
|
+
description: Performance analysis for code files
|
|
4
|
+
version: 1
|
|
5
|
+
patterns:
|
|
6
|
+
- "**/*.ts"
|
|
7
|
+
- "**/*.tsx"
|
|
8
|
+
- "**/*.mts"
|
|
9
|
+
- "**/*.cts"
|
|
10
|
+
- "**/*.js"
|
|
11
|
+
- "**/*.jsx"
|
|
12
|
+
- "**/*.mjs"
|
|
13
|
+
- "**/*.cjs"
|
|
14
|
+
- "**/*.py"
|
|
15
|
+
- "**/*.go"
|
|
16
|
+
- "**/*.rs"
|
|
17
|
+
- "**/*.java"
|
|
18
|
+
- "**/*.rb"
|
|
19
|
+
- "**/*.php"
|
|
20
|
+
- "**/*.kt"
|
|
21
|
+
- "**/*.kts"
|
|
22
|
+
- "**/*.sh"
|
|
23
|
+
- "**/*.bash"
|
|
24
|
+
- "**/*.zsh"
|
|
25
|
+
- "**/*.fish"
|
|
26
|
+
- "**/*.sql"
|
|
27
|
+
- "**/*.vue"
|
|
28
|
+
- "**/*.svelte"
|
|
29
|
+
agent: performance-check
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
Review code changes for:
|
|
33
|
+
1. Algorithm complexity (O(n^2) or worse)
|
|
34
|
+
2. N+1 queries and database inefficiencies
|
|
35
|
+
3. Memory leaks and excessive allocations
|
|
36
|
+
4. Missing caching opportunities
|
|
37
|
+
5. Blocking operations and missing parallelization
|
|
38
|
+
|
|
39
|
+
Be concise and actionable.
|
|
40
|
+
|
|
41
|
+
IMPORTANT: Only report actual performance issues. Do NOT report:
|
|
42
|
+
- Micro-optimizations with negligible impact
|
|
43
|
+
- Theoretical issues without real-world consequences
|
|
44
|
+
- Code that is already performant
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: code-security
|
|
3
|
+
description: Security scan for code files
|
|
4
|
+
version: 1
|
|
5
|
+
patterns:
|
|
6
|
+
- "**/*.ts"
|
|
7
|
+
- "**/*.tsx"
|
|
8
|
+
- "**/*.mts"
|
|
9
|
+
- "**/*.cts"
|
|
10
|
+
- "**/*.js"
|
|
11
|
+
- "**/*.jsx"
|
|
12
|
+
- "**/*.mjs"
|
|
13
|
+
- "**/*.cjs"
|
|
14
|
+
- "**/*.py"
|
|
15
|
+
- "**/*.go"
|
|
16
|
+
- "**/*.rs"
|
|
17
|
+
- "**/*.java"
|
|
18
|
+
- "**/*.rb"
|
|
19
|
+
- "**/*.php"
|
|
20
|
+
- "**/*.kt"
|
|
21
|
+
- "**/*.kts"
|
|
22
|
+
- "**/*.sh"
|
|
23
|
+
- "**/*.bash"
|
|
24
|
+
- "**/*.zsh"
|
|
25
|
+
- "**/*.fish"
|
|
26
|
+
- "**/*.sql"
|
|
27
|
+
- "**/*.vue"
|
|
28
|
+
- "**/*.svelte"
|
|
29
|
+
agent: security-scan
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
Scan code for security vulnerabilities:
|
|
33
|
+
1. Authentication/authorization issues
|
|
34
|
+
2. Input validation problems
|
|
35
|
+
3. SQL injection risks
|
|
36
|
+
4. XSS vulnerabilities
|
|
37
|
+
5. Sensitive data exposure
|
|
38
|
+
|
|
39
|
+
Only report actual security concerns. Do NOT report positive observations or "no issues found" messages.
|