Taskfile.yml

version: "3"

tasks:
    # Test
    # --------------------------------------------------------------------------------

    test:
        desc: Run all tests
        summary: |
            Run all tests (unit + integration).

            Options:
              filter=MyClass       Filter tests by class or method name
              coverage=true        Collect code coverage
              verbosity=detailed   Set verbosity (quiet|minimal|normal|detailed|diagnostic)
              configuration=Debug  Set build configuration
        cmd: >-
            python3 dev/scripts/test.py
            {{if (default "" .filter)}}--filter {{.filter}}{{end}}
            {{if eq (default "false" .coverage) "true"}}--coverage{{end}}
            {{if (default "" .verbosity)}}--verbosity {{.verbosity}}{{end}}
            {{if (default "" .configuration)}}--configuration {{.configuration}}{{end}}

    test:integration:
        desc: Run integration tests
        summary: |
            Run integration tests.

            Options:
              filter=MyClass       Filter tests by class or method name
              coverage=true        Collect code coverage
              verbosity=detailed   Set verbosity (quiet|minimal|normal|detailed|diagnostic)
              configuration=Debug  Set build configuration
        cmd: >-
            python3 dev/scripts/test.py --integration
            {{if (default "" .filter)}}--filter {{.filter}}{{end}}
            {{if eq (default "false" .coverage) "true"}}--coverage{{end}}
            {{if (default "" .verbosity)}}--verbosity {{.verbosity}}{{end}}
            {{if (default "" .configuration)}}--configuration {{.configuration}}{{end}}

    test:unit:
        desc: Run unit tests
        summary: |
            Run unit tests.

            Options:
              filter=MyClass       Filter tests by class or method name
              coverage=true        Collect code coverage
              verbosity=detailed   Set verbosity (quiet|minimal|normal|detailed|diagnostic)
              configuration=Debug  Set build configuration
        cmd: >-
            python3 dev/scripts/test.py --unit
            {{if (default "" .filter)}}--filter {{.filter}}{{end}}
            {{if eq (default "false" .coverage) "true"}}--coverage{{end}}
            {{if (default "" .verbosity)}}--verbosity {{.verbosity}}{{end}}
            {{if (default "" .configuration)}}--configuration {{.configuration}}{{end}}

    # Coverage
    # --------------------------------------------------------------------------------

    coverage:check:
        desc: Compare measured coverage against the baseline
        cmd: python3 dev/scripts/coverage.py check

    coverage:clean:
        desc: Remove coverage results and reports
        cmd: python3 dev/scripts/coverage.py clean

    coverage:install:
        desc: Install coverage reporting tools
        cmd: dotnet tool restore
        status:
            - dotnet reportgenerator --version

    coverage:report:
        desc: Generate coverage reports
        cmd: python3 dev/scripts/coverage.py report

    coverage:update:
        desc: Updates the coverage baseline
        cmd: python3 dev/scripts/coverage.py update

    # Build
    # --------------------------------------------------------------------------------

    build:
        desc: Build the solution
        summary: |
            Build the solution.

            Options:
              target=lib    Build only the Valkey.Glide library
        cmd: >-
            dotnet build
            {{if eq (default "" .target) "lib"}}sources/Valkey.Glide/{{end}}
            --configuration Release

    # Lint
    # --------------------------------------------------------------------------------

    lint:
        desc: "Run all linters"
        deps:
            - lint:actions
            - lint:csharp
            - lint:markdown
            - lint:python
            - lint:rust
            - lint:yaml

    lint:actions:
        desc: "Run GitHub Actions linting"
        cmd: actionlint

    lint:csharp:
        desc: "Run C# linting"
        env:
            Configuration: Lint
        cmds:
            - dotnet format --verify-no-changes
            # Shutdown build server to release file locks before lint build
            - dotnet build-server shutdown
            - dotnet build

    lint:markdown:
        desc: "Run Markdown linting"
        cmd: npx --yes markdownlint-cli2 "**/*.md"

    lint:python:
        desc: "Run Python linting"
        cmds:
            - uvx ruff@latest check --config dev/conf/ruff.toml .
            - uvx ruff@latest format --check --config dev/conf/ruff.toml .

    lint:rust:
        desc: "Run Rust linting"
        dir: rust
        cmds:
            - cargo fmt --all -- --check
            - cargo clippy --all-features --all-targets -- -D warnings
            - cargo deny check
            - RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps --document-private-items

    lint:yaml:
        desc: "Run YAML linting"
        cmd: npx --yes prettier --check "**/*.yml"

    # Format
    # --------------------------------------------------------------------------------

    format:
        desc: "Run all formatters"
        deps:
            - format:csharp
            - format:markdown
            - format:python
            - format:rust
            - format:yaml

    format:csharp:
        desc: "Run C# formatting"
        env:
            Configuration: Lint
        cmd: dotnet format

    format:markdown:
        desc: "Run Markdown formatting"
        cmd: npx --yes markdownlint-cli2 --fix "**/*.md"

    format:python:
        desc: "Run Python formatting"
        cmd: uvx ruff@latest format --config dev/conf/ruff.toml .

    format:rust:
        desc: "Run Rust formatting"
        dir: rust
        cmd: cargo fmt --all

    format:yaml:
        desc: "Run YAML formatting"
        cmd: npx --yes prettier --write --cache "**/*.yml"

    # Additional checks
    # --------------------------------------------------------------------------------

    check:
        desc: "Run all checks"
        deps:
            - check:examples
            - check:links
            - check:todos

    check:examples:
        desc: "Check C# examples in comments"
        cmd: python3 dev/scripts/check_examples.py

    check:links:
        desc: "Check for broken links"
        cmd: lychee --config dev/conf/lychee.toml .

    check:todos:
        desc: "Check that TODOs reference an open GitHub issue"
        summary: |
            Check that TODOs reference an open GitHub issue.

            Options
              --fail-issues ID [ID ...]
                When provided, the script fails if any TODOs reference the specified GitHub issues.

            Examples:
              task check:todos
              task check:todos -- --fail-issues 123 456
        cmd: python3 dev/scripts/check_todos.py {{.CLI_ARGS}}