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=..., ...)

  - id: require-elidable-arg-in-migration-operations
    languages:
      - python
    severity: ERROR
    message: Found a migration operation that doesn't set elidable.
    pattern-either:
      - patterns:
          - pattern: django.db.migrations.RunPython(...)
          - pattern-not: django.db.migrations.RunPython(..., elidable=..., ...)
      - patterns:
          - pattern: django.db.migrations.RunSQL(...)
          - pattern-not: django.db.migrations.RunSQL(..., elidable=..., ...)

  - id: require-csv-dict-writer
    languages:
      - python
    severity: ERROR
    message: Found a call to a regular csv writer, use EscapingDictWriter instead.
    pattern: csv.writer(...)

  - id: require-escaping-csv-dict-writer
    languages:
      - python
    severity: ERROR
    message: Found a call to a csv writer that doesn't escape values, use EscapingDictWriter instead.
    pattern: csv.DictWriter($...ARGS)
    fix: EscapingDictWriter($...ARGS)

  - id: use-image-blob-where-possible
    languages:
      - python
      - html
    severity: ERROR
    message: Use image.blob where possible, as it points to the correct accession blob
    # this is a bit of a janky regex to try to catch image.accession.*blob usage
    pattern-either:
      - pattern-regex: image\.accession\.blob[.\s,\)]
      - pattern-regex: image\.accession\.sponsored_blob[.\s,\)]

  - id: use-image-thumbnail-256-where-possible
    languages:
      - python
      - html
    severity: ERROR
    message: Use image.thumbnail_256 where possible, as it points to the correct accession thumbnail_256
    pattern-either:
      - pattern-regex: image\.accession\.thumbnail_256[.\s,\)]
      - pattern-regex: image\.accession\.sponsored_thumbnail_256_blob[.\s,\)]