architect/.coderabbit.yaml at main · libar-dev/architect · GitHub

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
# CodeRabbit Configuration for architect
# Documentation: https://docs.coderabbit.ai/guides/configure-coderabbit

language: en-US
early_access: true

reviews:
  profile: assertive # More thorough feedback for a documentation tool
  high_level_summary: true
  poem: true

  # Exclude build artifacts and generated content from reviews
  path_filters:
    - '!dist/**'
    - '!node_modules/**'
    - '!*.tsbuildinfo'
    - '!pnpm-lock.yaml'
    - '!docs-generated/**'
    - '!catalogue/artefact-sets/**'
    - '!**/*.md'
    - 'src/**'
    - 'tests/**'
    - '.github/**'
    - 'architect/**/*.feature'

  # Path-specific review guidance
  path_instructions:
    - path: 'src/**/*.ts'
      instructions: |
        Focus on TypeScript best practices, type safety, and maintainability.
        Check for proper JSDoc annotations, especially `@architect` markers and pattern tags.
        Verify Result monad usage for error handling.
        Ensure Zod schemas are used for validation.
        Check that annotations follow the opt-in system with `@architect` marker.

    - path: 'tests/**/*.ts'
      instructions: |
        Verify test coverage and quality.
        Ensure tests use Vitest best practices.
        Check that step definitions properly map to feature files.
        Validate fixture usage and test data setup.

    - path: 'tests/features/**/*.feature'
      instructions: |
        Validate Gherkin syntax and best practices.
        Ensure scenarios are clear and follow BDD patterns.
        Check that feature files align with implemented step definitions.

    - path: 'architect/**/*.feature'
      instructions: |
        Validate Gherkin syntax and best practices.
        These are specification files for roadmap patterns and decisions.
        Ensure scenarios define clear acceptance criteria.
        Check that @architect tags are properly set (status, phase, etc.).

    - path: 'docs/**/*.md'
      instructions: |
        Ensure documentation is clear, accurate, and up-to-date.
        Check for proper formatting and consistency.
        Validate that code examples are correct.

    - path: '.github/workflows/*.yml'
      instructions: |
        Verify GitHub Actions best practices.
        Ensure proper Node.js version matrix.
        Check that CI steps match npm scripts in package.json.
        Validate caching strategies.

  # Enable automatic incremental reviews
  auto_review:
    enabled: true
    auto_incremental_review: true
    drafts: false

  # Tools configuration - disable irrelevant language tools
  tools:
    # Keep JavaScript/TypeScript tools
    eslint:
      enabled: true
    biome:
      enabled: true
    oxc:
      enabled: true

    # Keep general tools
    markdownlint:
      enabled: true
    shellcheck:
      enabled: true
    actionlint:
      enabled: true
    yamllint:
      enabled: true
    gitleaks:
      enabled: true
    github-checks:
      enabled: true
      timeout_ms: 120000 # 2 minutes for comprehensive test suite

    # Disable irrelevant language-specific tools
    ruff:
      enabled: false
    flake8:
      enabled: false
    pylint:
      enabled: false
    phpstan:
      enabled: false
    phpmd:
      enabled: false
    phpcs:
      enabled: false
    golangci-lint:
      enabled: false
    rubocop:
      enabled: false
    brakeman:
      enabled: false
    swiftlint:
      enabled: false
    detekt:
      enabled: false
    pmd:
      enabled: false
    clang:
      enabled: false
    cppcheck:
      enabled: false
    clippy:
      enabled: false
    fortitudeLint:
      enabled: false
    sqlfluff:
      enabled: false
    prismaLint:
      enabled: false
    shopifyThemeCheck:
      enabled: false
    luacheck:
      enabled: false
    dotenvLint:
      enabled: false
    htmlhint:
      enabled: false
    checkmake:
      enabled: false
    buf:
      enabled: false
    regal:
      enabled: false
    circleci:
      enabled: false

# Knowledge base configuration
knowledge_base:
  opt_out: false

  # Use repository coding guidelines
  code_guidelines:
    enabled: true
    filePatterns:
      - '**/CLAUDE.md'

  learnings:
    scope: local # Keep learnings repository-specific

  issues:
    scope: local

  pull_requests:
    scope: local

# Chat configuration
chat:
  auto_reply: true

# Code generation settings
code_generation:
  docstrings:
    language: en-US
    path_instructions:
      - path: 'src/**/*.ts'
        instructions: |
          Generate JSDoc comments following the repository's annotation system.
          Include `@architect` marker when documenting public APIs.
          Document pattern, status, uses, and other relevant tags.