.coderabbit.yaml

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

language: en-US
tone_instructions: >-
    Prioritize actionable correctness, security, accessibility, performance, and lifecycle
    regressions. Explain concrete failure paths, avoid speculation, and skip findings covered by
    Trunk/CI. Follow project patterns and preserve the public API.
early_access: false
enable_free_tier: true
reviews:
    profile: assertive
    request_changes_workflow: false
    high_level_summary: false
    high_level_summary_placeholder: '@coderabbitai summary'
    high_level_summary_in_walkthrough: false
    auto_title_placeholder: '@coderabbitai'
    auto_title_instructions: ''
    review_status: true
    commit_status: true
    fail_commit_status: false
    collapse_walkthrough: false
    changed_files_summary: true
    sequence_diagrams: true
    assess_linked_issues: true
    related_issues: true
    related_prs: true
    suggested_labels: true
    auto_apply_labels: true
    suggested_reviewers: true
    auto_assign_reviewers: false
    poem: false
    labeling_instructions:
        - label: bug
          instructions: Apply to changes that fix incorrect behavior or errors.
        - label: enhancement
          instructions: Apply to new features or improvements to existing features.
        - label: docs
          instructions: Apply to documentation updates or improvements.
        - label: test
          instructions: Apply to test additions or improvements.
        - label: refactor
          instructions: Apply to code restructuring without behavior changes.
        - label: performance
          instructions: Apply to performance improvements or optimizations.
        - label: security
          instructions: Apply to security fixes or improvements.
        - label: accessibility
          instructions: Apply to accessibility improvements for keyboard, screen-reader, or other assistive-technology users.
        - label: breaking-change
          instructions: Apply to changes that break backward compatibility in the published package.
    path_filters:
        # Generated by `wrangler types`; review the Wrangler configuration rather than generated bindings.
        - '!docs/src/worker-configuration.d.ts'
        # Agent plans and guard logs are internal working notes rather than shipped code.
        - '!.agents/.plans/**'
    path_instructions:
        - path: '**/*.{ts,svelte}'
          instructions: |
              - Use arrow-function syntax for functions. Exported functions and non-trivial helpers should have useful JSDoc with @param, @returns, @throws, and @example tags where applicable.
              - Preserve strict TypeScript types. Do not use `any`, unsafe assertions, or non-null assertions to bypass type errors without a demonstrated invariant.
              - Do not flag formatting or lint findings already enforced by Trunk, ESLint, Prettier, or svelte-check.
        - path: src/lib/**/*.ts
          instructions: |
              - Treat exports as public package API. Flag accidental breaking changes to exported names, types, props, defaults, or behavior.
              - Review pattern parsing and RegExp construction for ReDoS, incorrect escaping, capture-range errors, and malformed-input behavior.
        - path: src/lib/**/*.svelte
          instructions: |
              - Review Svelte 5 runes usage (`$state`, `$derived`, and `$effect`), including effect cleanup, stale derived state, unnecessary reruns, memory leaks, and SSR compatibility.
              - Verify diff segments, expected-pattern captures, snippets, fallback renderers, class overrides, and line breaks remain correct for empty, multiline, and Unicode input.
              - Preserve accessibility and valid HTML when changing built-in rendering.
        - path: '{src,tests}/**/*.{test,spec}.ts'
          instructions: |
              - Tests should cover behavior rather than implementation details, including boundary values, malformed patterns, multiline and Unicode input, error paths, and public API compatibility where relevant.
              - Keep tests deterministic and name them for the behavior they prove.
        - path: docs/**/*
          instructions: |
              - Verify examples are runnable and match the current public API. Check internal links, metadata, SSR behavior, and accessibility.
              - Keep browser tests deterministic, use user-visible assertions, and avoid arbitrary waits.
        - path: .github/workflows/**
          instructions: |
              - Keep permissions least-privileged, pin actions appropriately, scope secrets to the smallest step that consumes them, and preserve trusted publishing safeguards.
    abort_on_close: true
    disable_cache: false
    auto_review:
        # Enable the label gate: automatic reviews run only on PRs carrying `coderabbit`.
        enabled: true
        auto_incremental_review: false
        ignore_title_keywords: []
        labels: [coderabbit]
        drafts: false
        base_branches: [main]
    finishing_touches:
        docstrings:
            enabled: true
    # Trunk is the repository's lint/static-analysis runner. CodeRabbit consumes
    # its GitHub checks instead of running a second set of overlapping analyzers.
    tools:
        github-checks:
            enabled: true
            timeout_ms: 90000
chat:
    auto_reply: true
    integrations:
        jira:
            usage: auto
        linear:
            usage: auto
knowledge_base:
    opt_out: false
    web_search:
        enabled: true
    learnings:
        scope: auto
    issues:
        scope: auto
    jira:
        usage: auto
        project_keys: []
    linear:
        usage: auto
        team_keys: []
    pull_requests:
        scope: auto
code_generation:
    docstrings:
        language: en-US
        path_instructions:
            - path: '**/*.{js,mjs,ts,svelte}'
              instructions: |
                  Use project-style JSDoc with @param, @returns, @throws, and @example tags where applicable. Use arrow-function syntax only.