Taskfile.yml

version: '3'

vars:
    # Define the directory for binaries
    BIN: "{{.ROOT_DIR}}/bin"

tasks:
    # Default task to run linting and testing
    default:
        cmds:
            - task: lint
            - task: test

    # Build tasks
    build:
        desc: Builds the Go project
        cmds:
            - go build -o {{.BIN}}/devex ./cmd/main.go

    build:local:
        desc: Builds the Go project for local development
        cmds:
            - go build -o ./bin/devex -v ./cmd/main.go

    # Installation task
    install:
        desc: Installs DevEx
        aliases: [i]
        sources:
            - './**/*.go'
        cmds:
            - go install -v ./cmd/main.go

    # Setup Python environment
    setup:python:
        desc: Sets up Python environment and installs requirements
        cmds:
            - pip install -r requirements.txt

    # Manage Go modules
    mod:
        desc: Downloads and tidies Go modules
        cmds:
            - go mod download
            - go mod tidy

    # Clean up temporary files
    clean:
        desc: Cleans temp files and folders
        aliases: [clear]
        cmds:
            - rm -rf bin/

    # Linting tasks
    lint:
        desc: Runs golangci-lint
        aliases: [l]
        sources:
            - './**/*.go'
            - .golangci.yml
        cmds:
            - golangci-lint run

    lint:fix:
        desc: Runs golangci-lint and fixes issues
        sources:
            - './**/*.go'
            - .golangci.yml
        cmds:
            - golangci-lint run --fix

    lint:staticcheck:
        desc: Runs staticcheck
        cmds:
            - staticcheck ./...

    # Vulnerability checks
    vulncheck:
        desc: Runs vulnerability checks
        cmds:
            - govulncheck ./...

    # Testing tasks
    test:
        desc: Runs test suite
        aliases: [t]
        deps: [install]
        cmds:
            - go test {{catLines .GO_PACKAGES}}
        vars:
            GO_PACKAGES:
                sh: go list ./...

    test:all:
        desc: Runs test suite with additional tags
        deps: [install]
        cmds:
            - go test {{catLines .GO_PACKAGES}} -tags 'signals watch'
        vars:
            GO_PACKAGES:
                sh: go list ./...

    test:testify:
        desc: Runs tests with testify
        cmds:
            - go test ./... {{.TESTIFY}}

    test:ginkgo:
        desc: Runs tests with Ginkgo
        cmds:
            - ginkgo run ./...

    # Mock generation
    mockgen:
        desc: Generates mocks for interfaces
        cmds:
            - mockgen -source=source_file.go -destination=destination_mock.go -package=mocks

    # Prettier formatting
    prettier:check:
        desc: Checks if files are formatted with Prettier
        cmds:
            - npx prettier --check .

    prettier:fix:
        desc: Formats files with Prettier
        cmds:
            - npx prettier --write .

    # Documentation tasks
    docs:build:
        desc: Builds the MkDocs site
        cmds:
            - mkdocs build

    docs:serve:
        desc: Serves MkDocs documentation locally
        cmds:
            - mkdocs serve

    # Code visualization
    callvis:
        desc: Generates a visualization of code
        cmds:
            - go-callvis ./... --nostd --group pkg

    # Static analysis
    gocritic:
        desc: Runs Go Critic for advanced analysis
        cmds:
            - gocritic check ./...

    # CLI tasks
    cli:generate:
        desc: Generates CLI commands
        cmds:
            - go run ./cmd/gencli

    # GoReleaser tasks
    goreleaser:test:
        desc: Tests the release process without publishing
        cmds:
            - goreleaser --snapshot --clean

    goreleaser:install:
        desc: Installs GoReleaser
        cmds:
            - go install github.com/goreleaser/goreleaser/v2@latest

    # Release management
    release:*:
        desc: Prepares the project for a new release
        summary: |
            This task updates the version and creates a new GitHub release:
            - Updates CHANGELOG.md
            - Commits changes
            - Creates and pushes a new tag
            - Creates a GitHub release
        vars:
            VERSION:
                sh: "go run ./cmd/release --version {{index .MATCH 0}}"
            COMPLETE_MESSAGE: |
                Release created. Please:
                - Publish the package to NPM
                - Update and push snapcraft manifest
        preconditions:
            - sh: test $(git rev-parse --abbrev-ref HEAD) = "main"
              msg: "You must be on the main branch to release."
            - sh: "[[ -z $(git diff --shortstat main) ]]"
              msg: "Your working tree must be clean to release."
        prompt: "Are you sure you want to release version {{.VERSION}}?"
        cmds:
            - cmd: echo "Releasing v{{.VERSION}}"
              silent: true
            - "go run ./cmd/release {{.VERSION}}"
            - "git add --all"
            - "git commit -m v{{.VERSION}}"
            - "git push"
            - "git tag v{{.VERSION}}"
            - "git push origin tag v{{.VERSION}}"
            - cmd: printf "%s" '{{.COMPLETE_MESSAGE}}'
              silent: true

    # Package listing
    packages:
        cmds:
            - echo '{{.GO_PACKAGES}}'
        vars:
            GO_PACKAGES:
                sh: go list ./...
        silent: true