ls-plugin/.coderabbit.yml at develop · lightspeedwp/ls-plugin · 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
version: 2

# Reviews are enabled and set to a draft-aware, plugin-focused review profile.
reviews:
  request_changes_workflow: false
  high_level_summary: true
  poem: false
  review_status: true
  collapse_walkthrough: false

# Language and tone
language: en-US
tone_instructions: "Be direct and professional. Focus on practical WordPress plugin quality."

# Path-level review instructions
path_instructions:
  - path: "ls-plugin.php"
    instructions: |
      Review the main plugin bootstrap file.
      Check for: valid plugin header with all required fields, direct access protection (ABSPATH check),
      correct version constant, safe loading of includes, no business logic in the bootstrap.
      Confirm text domain matches the plugin slug.

  - path: "inc/**/*.php"
    instructions: |
      Review PHP include files.
      Check for: correct escaping (esc_html__, esc_attr__, wp_kses_post, etc.),
      sanitisation and validation of input, translation function usage, no direct database queries without $wpdb,
      correct use of WordPress hooks and filters.

  - path: "src/**/*.js"
    instructions: |
      Review JavaScript source files.
      Check for: correct use of wp.element or vanilla JS, no jQuery dependency unless justified,
      no hardcoded strings (use wp.i18n), accessibility-aware DOM interactions.

  - path: "src/**/*.css"
    instructions: |
      Review CSS source files.
      Check for: no use of !important unless justified, responsive-first approach,
      use of CSS custom properties where appropriate, accessible colour contrast considerations.

  - path: "blocks/**/block.json"
    instructions: |
      Review block registration JSON files.
      Check for: valid schema reference, correct category and icon, editorScript/style/viewScript paths,
      meaningful attributes, supports declarations, correct textdomain in titles and descriptions.

  - path: "patterns/*.php"
    instructions: |
      Review block pattern PHP files.
      Check for: correct escaping of any dynamic output, translation function usage,
      pattern header comments (Title, Slug, Categories), clean markup.

  - path: "AGENTS.md"
    instructions: |
      Review the AI agent guidance document.
      Check for: clarity, completeness, placeholder consistency, accurate command references,
      correct folder references for prompts, reports, tasks, docs, skills, and agents.

  - path: "README.md"
    instructions: |
      Review the root README.
      Check for: clear quick start, accurate command table, correct placeholder references,
      sensible repo map, correct folder descriptions.

# What CodeRabbit should focus on for this repo
chat:
  auto_reply: true