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

  • Path filtering

Example file -

# TypoApp Code Review Configuration File
language: "english"

custom_instructions: ""

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

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

Last updated