A rule defines a custom check that will run against changes. These enables identifying behaviours that are buggy within the context of a given codebase as well as style violations.

For example, a user might prefer namespace imports and would like to receive comments whenever this convention is violated:

• Step 1: Create a .recurse.yaml file in the root of the project
• Step 2: Populate with the following

custom_rules:
  - name: "avoid-relative-imports"
    applicable_files:
      - ".ts"
      - ".tsx"
    description: "Avoid relative imports using '../' pattern. Use absolute imports or module aliases instead."
 - name: "another-rule"
   applicable_files:
     - "src/"
     - "tests/"
   description: "Another description"
 ...

• name → Name of the rule
• applicable_files → list of glob patterns. If a change are made on files that match any of the patterns, the custom localizer will scan those files against the rule
  • Supported patterns:
  • File extensions (e.g., "*.py" or ".py")
  • Directories (e.g., "src/*" or "src/")
  • Nested directories (e.g., "src/utils/*" or "src/utils/")
  • Multiple wildcards (e.g., "src//utils/.py")
  • Double wildcards (e.g., "src/**/utils/*.py")
  • Exact filenames (e.g. utils.py)
• description → This is the actual description of the rule that will be passed to the localizer.