sweep.yaml

# Sweep AI turns bugs & feature requests into code changes (https://sweep.dev)
# For details on our config file, check out our docs at https://docs.sweep.dev/usage/config

# This setting contains a list of rules that Sweep will check for. If any of these rules are broken in a new commit, Sweep will create an pull request to fix the broken rule.
rules:
  - "All docstrings and comments should be up to date."
  - "There should be no trailing whitespace in the code."
  - "There should be no commented-out code in the codebase."
  - "Variable names should be descriptive and follow a consistent naming convention."
  - "There should be no unnecessary blank lines in the code."
  - "There should be no unused imports in the code."

# This is the branch that Sweep will develop from and make pull requests to. Most people use 'main' or 'master' but some users also use 'dev' or 'staging'.
branch: 'develop'

# By default Sweep will read the logs and outputs from your existing Github Actions. To disable this, set this to false.
gha_enabled: True

# This is the description of your project. It will be used by sweep when creating PRs. You can tell Sweep what's unique about your project, what frameworks you use, or anything else you want.
#
# Example:
#
# description: sweepai/sweep is a python project. The main api endpoints are in sweepai/api.py. Write code that adheres to PEP8.
description: 'This is a C++ PlatformIO/Arduino project. Sources are in firmware/ and include/ directories. Component libraries are in lib/ directory.'

# This sets whether to create pull requests as drafts. If this is set to True, then all pull requests will be created as drafts and GitHub Actions will not be triggered.
draft: False

# This is a list of directories that Sweep will not be able to edit.
blocked_dirs: []

docs:
  - PlatformIO: ["https://docs.platformio.org/en/latest/", "We use PlatformIO to build and upload firmware to the device"]
  - Arduino Framework: ["https://www.arduino.cc/reference/en/", "We use Arduino for HAL"]
  - ESP-IDF: ["https://docs.espressif.com/projects/esp-idf/en/stable/esp32/", "We use ESP-IDF for concrete ESP components"]

# Sandbox executes commands in a sandboxed environment to validate code changes after every edit to guarantee pristine code. For more details, see the [Sandbox](./sandbox) page.
sandbox:
  install:
    - trunk init
  check:
    - trunk fmt {file_path}
    - trunk check --fix --print-failures {file_path}