coderabbit/.coderabbit.yaml at develop · lightspeedwp/coderabbit · 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
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

language: "en-US"

early_access: false

# Configuration inheritance
# This central configuration is designed to be inherited by repositories
# that do not have their own .coderabbit.yml or .coderabbit.yaml file.
#
# To enable inheritance in a child repository, create a .coderabbit.yml with:
#   inheritance: true
#   [any local overrides]
#
# Repositories can override any setting, including:
# - language (e.g., en-GB)
# - reviews.profile (e.g., chill, balanced)
# - path_instructions (add repository-specific guidance)
# - tools (enable/disable specific checks)
#
# For more information, see:
# https://docs.coderabbit.ai/configuration/configuration-inheritance

reviews:
  profile: "assertive"
  request_changes_workflow: false
  high_level_summary: true
  poem: false
  review_status: true
  auto_review:
    enabled: true
    drafts: false
    auto_incremental_review: true
    auto_pause_after_reviewed_commits: 5
    base_branches:
      - "main"
      - "develop"
      - "feature/.*"
      - "fix/.*"
    ignore_title_keywords:
      - "WIP"
      - "[skip review]"
      - "DO NOT MERGE"
    ignore_usernames:
      - "dependabot[bot]"
      - "renovate[bot]"
      - "github-actions[bot]"
  path_instructions:
    - path: "guidelines/**/*.md"
      instructions: "Review documentation for clarity, completeness and alignment with the codebase. Check for broken links, correct code examples and current references."
    - path: "**/*.php"
      instructions: "Enforce WordPress Coding Standards (WPCS) and PHPDoc rules. In render callbacks/render.php, verify attribute sanitization and escaping (esc_html, esc_attr, wp_kses_post). Ensure REST API endpoints define permission_callback."
    - path: "**/block.json"
      instructions: "Validate block.json schema version 3 ($schema). Ensure all block attributes declare explicit types. Verify script and style asset paths."
    - path: "src/**/*.{js,jsx,ts,tsx}"
      instructions: "For WordPress Gutenberg projects (containing @wordpress dependencies or block.json): Enforce Block API v3, verify useBlockProps() on edit component root, use @wordpress/components, ensure translatable strings use __() from @wordpress/i18n with proper text domain. For standalone JavaScript/React projects: Follow the project's own guidelines and framework conventions."
  tools:
    phpcs:
      enabled: false
    phpstan:
      enabled: false
    phpmd:
      enabled: false
    gitleaks:
      enabled: true
    trufflehog:
      enabled: true
  finishing_touches:
    autofix:
      enabled: true
    fix_ci:
      enabled: true
    resolve_merge_conflict:
      enabled: true
    unit_tests:
      enabled: true
    simplify:
      enabled: true
    docstrings:
      enabled: true

knowledge_base:
  opt_out: false
  automatic_linking_mode: auto
  web_search:
    enabled: true
  code_guidelines:
    enabled: true
    filePatterns:
      - "lightspeedwp/coderabbit:guidelines/block-plugin.md"
      - "lightspeedwp/coderabbit:guidelines/block-theme.md"