Taskfile.yaml

# https://taskfile.dev
#
# This is a generated file. We do not suggest to edit it.
# Instead, create a file `TaskfileCustom.yaml` and add your additions there.
---
version: '3'

dotenv: ['.copier-answers.env', '.env']

vars:
  # $package_dir is expanded by the shell, from the .copier-answers.env entry
  # that `dotenv` above loads. An exported package_dir of your own outranks that
  # entry, which the `package:exists` task below turns into a loud failure
  # instead of a check that quietly looks at nothing.
  PACKAGE: $package_dir
  DIST_DIR: dist

includes:
  custom:
    taskfile: ./TaskfileCustom.yaml
    optional: true
    flatten: true
  plugin:
    taskfile: .tasks-plugin.yml
    optional: true
    flatten: true

tasks:

  default:
    summary: |
      Just a list of documented tasks
    silent: true
    cmds:
      - task --list

  # {{{ preparation tasks
  # These are plain internal tasks rather than a YAML anchor on purpose. A merge
  # key only supplies keys the mapping does not already have, so a task with any
  # `deps` of its own silently loses everything the anchor meant to add - which
  # is what `build` used to do. Naming them in a `deps` list composes instead.
  package:exists:
    internal: true
    summary: |
      fail loudly when PACKAGE does not name a directory
    run: once
    preconditions:
      - sh: '[ -d "$package_dir" ]'
        msg: >
          The package directory does not exist. Its name comes from the
          package_dir entry of .copier-answers.env, and an exported package_dir
          of your own silently outranks that entry - unset it. Without this
          check, an empty value dropped the package from every command line and
          the checks passed having looked at nothing but tests.

  prepare:
    internal: true
    summary: |
      everything a check or format task needs first: the virtualenv, a package
      directory that exists, and the directory the reports are written to
    run: once
    deps:
      - poetry:install
      - package:exists
    cmds:
      - mkdir -p {{.DIST_DIR}}/coverage

  poetry:install:
    desc: Install dependencies managed by Poetry
    run: once
    cmds:
      - poetry install

  # Neither format task depends on `poetry:install`, unlike the check tasks.
  # `format:fix` is what the Claude Code PostToolUse hook runs after every edit,
  # and `poetry install` refuses to run while pyproject.toml has been changed
  # without the lock file being regenerated - exactly what a dependency bump or
  # a template update looks like. Formatting would then quietly stop for the
  # rest of the session. On a clone with no virtualenv yet, run `task check` or
  # `task poetry:install` first.
  format:fix:
    desc: Format Python files and fix obvious issues
    deps:
      - package:exists
    cmds:
      - poetry run ruff format tests {{.PACKAGE}}
      - poetry run ruff check tests {{.PACKAGE}} --fix-only

  format:fix-unsafe:
    desc: Format Python files and fix 'unsafe' issues
    deps:
      - package:exists
    cmds:
      - poetry run ruff format tests {{.PACKAGE}}
      - poetry run ruff check tests {{.PACKAGE}} --fix-only --unsafe-fixes

  clean:
    desc: Removes dist, *.pyc and some caches
    cmds:
      - rm -rf {{.DIST_DIR}} .mypy_cache .pytest_cache
      - find . -name "*.pyc" -print0 | xargs -0 rm || echo ""

  # }}}
  # {{{ check tasks

  check:
    desc: Run whole test suite incl. unit and integration tests
    cmds:
      - task: check:linters
      - task: check:pytest

  check:linters:
    desc: Run all linter and static code analysis tests
    cmds:
      - task: check:ruff
      - task: check:mypy
      - task: check:deptry
      - task: check:trivy

  check:pytest:
    desc: Run unit and integration tests
    platforms: [darwin, linux, windows]
    deps:
      - prepare
    cmds:
      # --memray is not used on windows
      - platforms: [windows]
        cmd: >
          poetry run pytest --junitxml={{.JUNIT_FILE}}
          --cov-report term  --cov-report xml:{{.COVERAGE_FILE}}
          --cov-report html:{{.COVERAGE_DIR}} --cov={{.PACKAGE}}
          --html={{.HTML_FILE}} --self-contained-html
      - platforms: [darwin, linux]
        cmd: >
          poetry run pytest --memray --junitxml={{.JUNIT_FILE}}
          --cov-report term --cov-report xml:{{.COVERAGE_FILE}}
          --cov-report html:{{.COVERAGE_DIR}} --cov={{.PACKAGE}}
          --html={{.HTML_FILE}} --self-contained-html
      - cmd: >
          poetry run genbadge coverage -l
          -i {{.COVERAGE_FILE}} -o {{.BADGE_COVERAGE}}
      - cmd: >
          poetry run genbadge tests -l
          -i {{.JUNIT_FILE}} -o {{.BADGE_TESTS}}
    vars:
      BADGE_COVERAGE: ./{{.DIST_DIR}}/badge-coverage.svg
      BADGE_TESTS: ./{{.DIST_DIR}}/badge-tests.svg
      COVERAGE_DIR: ./{{.DIST_DIR}}/coverage
      COVERAGE_FILE: ./{{.DIST_DIR}}/coverage.xml
      HTML_FILE: ./{{.DIST_DIR}}/pytest.html
      JUNIT_FILE: ./{{.DIST_DIR}}/junit-pytest.xml

  check:mypy:
    desc: Complain about typing errors
    deps:
      - prepare
    cmds:
      - poetry run mypy -p tests -p {{.PACKAGE}} --junit-xml {{.JUNIT_FILE}}
    vars:
      JUNIT_FILE: ./{{.DIST_DIR}}/junit-mypy.xml

  check:trivy:
    desc: Scan for vulnerabilities using Trivy
    deps:
      - prepare
    cmds:
      - >
        poetry run trivy fs
        --include-dev-deps
        --scanners vuln
        --skip-files .poetry/plugins/poetry.lock
        --exit-code 1
        .

  check:deptry:
    desc: Complain about unused or missing dependencies
    deps:
      - prepare
    cmds:
      - poetry run deptry .

  check:ruff:
    desc: Complain about everything else
    deps:
      - prepare
    cmds:
      - poetry run ruff check --exit-zero tests {{.PACKAGE}} {{.XML_PARAMS}}
      - poetry run ruff check --output-format=concise tests {{.PACKAGE}}
      - poetry run ruff format --check tests {{.PACKAGE}}
    vars:
      JUNIT_FILE: ./{{.DIST_DIR}}/junit-ruff.xml
      XML_PARAMS: --output-format junit --output-file {{.JUNIT_FILE}}

  # }}}

  build:
    desc: Build a tarball and a wheel package
    # `prepare` is deliberately not among these: `build` does not write into
    # dist/coverage, and it would race with `clean`, since Task runs deps in
    # parallel.
    deps:
      - poetry:install
      - clean
    cmds:
      - poetry build
      - poetry export --without=dev -f requirements.txt >dist/requirements.txt