rules.yml

rules:
  - id: require_include_in_schema
    languages:
      - python
    severity: ERROR
    message: Found a route that doesn't explicitly set include_in_schema.
    patterns:
      - pattern-inside: |
          $ROUTER = ninja.Router(...)
          ...
      - pattern: $ROUTER.$OPERATION(...)
      - pattern-not: $ROUTER.$OPERATION(..., include_in_schema=..., ...)
      - metavariable-regex:
          metavariable: $OPERATION
          regex: ^(get|post|delete|put|patch)$

  - id: require-delay-on-commit
    languages:
      - python
    severity: ERROR
    message: Found a call to a celery task that runs before transaction commit.
    pattern: $TASK.delay($...ARGS)
    fix: $TASK.delay_on_commit($...ARGS)

  - id: require-celery-timeouts
    languages:
      - python
    severity: ERROR
    message: Found a celery task definition that doesn't set timeouts.
    patterns:
      - pattern: shared_task(...)
      - pattern-not: shared_task(..., soft_time_limit=..., time_limit=..., ...)