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

language: 'en-US'
early_access: false
tone_instructions: 'You are an expert code reviewer in TypeScript, JavaScript, NodeJS, and ElectronJS. You work in an enterprise software developer team, providing concise and clear code review advice. You only elaborate or provide detailed explanations when requested.'

knowledge_base:
  opt_out: false
  code_guidelines:
    enabled: true
    filePatterns:
      - '**/CODING_STANDARDS.md'

reviews:
  profile: 'chill'
  request_changes_workflow: false
  high_level_summary: true
  poem: true
  review_status: true
  collapse_walkthrough: false
  auto_review:
    enabled: true
    drafts: false
    base_branches: ['main', 'release/*']
  path_instructions:
    - path: '**/*'
      instructions: |
        Bruno is a cross-platform Electron desktop app that runs on macOS, Windows, and Linux. Ensure that all code is OS-agnostic:
        - File paths must use `path.join()` or `path.resolve()` instead of hardcoded `/` or `\\` separators
        - Never assume case-sensitive or case-insensitive filesystems
        - Use `os.homedir()`, `app.getPath()`, or environment-appropriate APIs instead of hardcoded paths like `/home/`, `C:\\Users\\`, or `~/`
        - Line endings should be handled consistently (be aware of CRLF vs LF issues)
        - Use `path.sep` or `path.posix`/`path.win32` when platform-specific separators are needed
        - Shell commands or child_process calls must account for platform differences (e.g., `which` vs `where`, `/bin/sh` vs `cmd.exe`)
        - File permissions (e.g., `fs.chmod`, `fs.access`) should account for Windows not supporting Unix-style permission bits
        - Avoid relying on Unix-only signals (e.g., `SIGKILL`) without Windows fallbacks
        - Use `os.tmpdir()` instead of hardcoding `/tmp`
        - Environment variable access should handle platform differences (e.g., `HOME` vs `USERPROFILE`)
    - path: 'tests/**/**.*'
      instructions: |
        Review the following e2e test code written using the Playwright test library. Ensure that:
        - Follow best practices for Playwright code and e2e automation
        - Try to reduce usage of `page.waitForTimeout();` in code unless absolutely necessary and the locator cannot be found using existing `expect()` playwright calls
        - Avoid using `page.pause()` in code
        - Use locator variables for locators
        - Avoid using test.only
        - Use multiple assertions
        - Promote the use of `test.step` as much as possible so the generated reports are easier to read
        - Ensure that the `fixtures` like the collections are nested inside the `fixtures` folder


          **Fixture Example***: Here's an example of possible fixture and test pair
          ```
          .
          ├── fixtures
          │   └── collection
          │       ├── base.bru
          │       ├── bruno.json
          │       ├── collection.bru
          │       ├── ws-test-request-with-headers.bru
          │       ├── ws-test-request-with-subproto.bru
          │       └── ws-test-request.bru
          ├── connection.spec.ts # <- Depends on the collection in ./fixtures/collection
          ├── headers.spec.ts
          ├── persistence.spec.ts
          ├── variable-interpolation
          │   ├── fixtures
          │   │   └── collection
          │   │       ├── environments
          │   │       ├── bruno.json
          │   │       └── ws-interpolation-test.bru
          │   ├── init-user-data
          │   └── variable-interpolation.spec.ts # <- Depends on the collection in ./variable-interpolation/fixtures/collection
          └── subproto.spec.ts
          ```

chat:
  auto_reply: true