-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy path.coderabbit.yaml
More file actions
171 lines (156 loc) · 4.28 KB
/
.coderabbit.yaml
File metadata and controls
171 lines (156 loc) · 4.28 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
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
# CodeRabbit config for selftune — TypeScript + Bun + oxc CLI tool
language: "en-US"
tone_instructions: >
Be direct and technical. Focus on correctness, type safety, and
Bun/TypeScript best practices. Flag actionable issues only.
early_access: false
enable_free_tier: true
reviews:
profile: "assertive"
request_changes_workflow: false
high_level_summary: true
high_level_summary_in_walkthrough: true
review_status: true
commit_status: true
collapse_walkthrough: true
changed_files_summary: true
sequence_diagrams: true
estimate_code_review_effort: true
assess_linked_issues: true
related_issues: true
related_prs: true
suggested_labels: true
suggested_reviewers: true
poem: false
in_progress_fortune: false
abort_on_close: true
auto_title_instructions: >
Use conventional commits: feat|fix|docs|chore|refactor|test|perf|ci.
Keep under 72 characters.
path_filters:
- "!bun.lockb"
- "!**/*.snap"
# fixtures are intentional test data — don't exclude from review
- "!coverage/**"
path_instructions:
- path: "cli/**/*.ts"
instructions: |
CLI source code. Review for:
- Strict typing (no `any`, prefer `unknown` with type guards)
- Bun-compatible APIs only
- Proper process.exit() with correct codes (0=success, 1=error)
- Actionable error messages, not raw stack traces
- No hard-coded absolute paths; use path.resolve() or import.meta.dir
- oxfmt enforces formatting; do not comment on style
- path: "tests/**/*.ts"
instructions: |
Uses bun:test. Review for:
- Import from 'bun:test' only (not Jest/Vitest globals)
- Isolated tests with proper setup/teardown
- Coverage of error paths, not just happy paths
- Optional chaining (result?.) not non-null assertions (result!.)
- path: "skill/**/*.md"
instructions: |
Skill workflow documents for AI agents. Review for:
- Clear step-by-step instructions
- Valid code examples
- Consistent heading hierarchy
- No ambiguous references
- path: "dashboard/**"
instructions: |
Standalone HTML dashboard. Review for:
- No external dependencies beyond CDN (Chart.js)
- Proper embedded data handling from JSON script tag
- Accessible markup
auto_review:
enabled: true
auto_incremental_review: true
auto_pause_after_reviewed_commits: 0
drafts: false
base_branches:
- "main"
ignore_usernames:
- "dependabot[bot]"
- "renovate[bot]"
- "github-actions[bot]"
ignore_title_keywords:
- "WIP"
- "[skip review]"
finishing_touches:
docstrings:
enabled: true
unit_tests:
enabled: true
pre_merge_checks:
title:
mode: "warning"
requirements: >
Must use conventional commits format:
feat|fix|docs|chore|refactor|test|perf|ci
description:
mode: "warning"
tools:
biome:
enabled: false
eslint:
enabled: false
oxc:
enabled: true
github-checks:
enabled: true
ast-grep:
essential_rules: true
gitleaks:
enabled: true
trufflehog:
enabled: true
shellcheck:
enabled: true
markdownlint:
enabled: true
yamllint:
enabled: true
trivy:
enabled: true
semgrep:
enabled: false
checkov:
enabled: false
hadolint:
enabled: false
languagetool:
enabled: false
ruff:
enabled: false
clippy:
enabled: false
knowledge_base:
opt_out: false
web_search:
enabled: true
code_guidelines:
enabled: true
learnings:
scope: "local"
issues:
scope: "local"
pull_requests:
scope: "local"
chat:
auto_reply: true
code_generation:
docstrings:
language: "en-US"
path_instructions:
- path: "**/*.ts"
instructions: |
Generate JSDoc with @param, @returns, @throws.
For CLI commands include @example with usage.
unit_tests:
path_instructions:
- path: "**/*.ts"
instructions: |
Use bun:test exclusively:
import { describe, test, expect } from 'bun:test'
Place in tests/ mirroring source structure.