How to add a configuration file for Code Health

Using a YAML File to Configure Typo

You can add a configuration file named ".typoapp.yaml" or ".typoapp.yml" to the root of your repository to customize how Typo works. This file is a simple way to define settings for your projects directly in your code.

The ".typoapp.yaml" or ".typoapp.yml" file must be present in your base/target branch for Typo to apply the configuration to its analysis and reports

TypoApp Code Review Configuration File

What this includes:

• Language setting

  • English

  • Portuguese

For additional language support, please contact [e-mail]

• Path filtering

  • Include: Specify paths to include in the review.

  • Exclude: Specify paths to exclude from the review.

• Custom Instruction -

  • Enter any specific instructions related to the review (up to 200 characters).

Example file -

# TypoApp Code Review Configuration File
language: "english"

# Custom instructions for the code review.  
# Default: ""  
# Max length: 200 characters  
custom_instructions: "Summaries must be concise and highlight only critical and major issues. Ignore minor or cosmetic problems."

reviews:
  path_filters:
    # Include these paths
     - "src/**"

    # Exclude these paths (prefix with !)
    - "!*/constants.py"
    - "!*/test.py"