Taskfile.yml

# Taskfile.yml for yini-parser-python.

# Setup new file on Windows:
# winget install Task.Task
# task --init

version: '3'

vars:
  GRAMMAR_BASE: ./grammar/v1.0.0-rc.5xxxx

  PARSER_FILE:  "{{.GRAMMAR_BASE}}/YiniParser.g4"
  LEXER_FILE:   "{{.GRAMMAR_BASE}}/YiniLexer.g4"
  ANTLR_JAR:    ./libs/antlr4/antlr4-4.13.2-complete.jar
  DIR_OUTPUT:   ./src/yini_parser/grammar/generated
  START_RULE:   yini

tasks:
  default:
    cmds:
      - task --list

  antlr-help:
    desc: Show ANTLR help
    cmds:
      - java -jar {{.ANTLR_JAR}} -help

  run-sample:
    desc: Start the project.
    cmds:
       - python src/main.py sample/basic.yini

  dev:
    desc: Run development entrypoint
    cmds:
        - python src/dev.py 

  install:
    desc: Install yini-parser-python in editable mode
    cmds:
      - python -m pip install -e .

  install-dev:
    desc: Install yini-parser-python with development dependencies
    cmds:
      - python -m pip install -e ".[dev]"

  antlr:
    desc: Generate sources for the grammar (Windows only)
    platforms: [windows]
    cmds:
      - echo Generate sources for the grammar...
#      - mkdir {{.DIR_OUTPUT}}/base
#      - cp {{.GRAMMAR_BASE}}/base/{{.BASE_FILE}} {{.DIR_OUTPUT}}/base
      - >
        java -jar {{.ANTLR_JAR}}
        -Dlanguage=Python3
        -no-listener -visitor
        -o {{.DIR_OUTPUT}}
        {{.LEXER_FILE}}
        {{.PARSER_FILE}}
      - echo Done.

  check:
    desc: Run tests, linting, formatting checks, and type checks.
    cmds:
      - task test
      - task lint
      - task format-check
      - task typecheck

  test-relaxed:
    desc: Run tests without promoting warnings to errors.
    cmds:
      - python -m pytest -v

  test:
    desc: Run tests
    cmds:
      - python -m pytest -v -W error

  test-adapter:
    desc: Run the yini-test adapter against the sample basic YINI file
    cmds:
      - python tools/yini_parser_adapter.py --input sample/basic.yini

  test-adapter-strict:
    desc: Run the yini-test adapter in strict mode against a strict sample file
    cmds:
      - python tools/yini_parser_adapter.py --input sample/basic.strict.yini --mode strict
      
  lint:
    desc: Run Ruff lint checks.
    cmds:
      - python -m ruff check .

  format-check:
    desc: Check code formatting with Ruff.
    cmds:
      - python -m ruff format --check .

  format:
    desc: Format code with Ruff.
    cmds:
      - python -m ruff format .

  typecheck:
    desc: Run mypy type checks.
    cmds:
      - python -m mypy

  build:
    desc: Build source distribution and wheel
    cmds:
      - python -m build

  release-check:
    desc: Run full checks before publishing
    cmds:
      - task check
      - task clean-build
      - task build
      - task check-dist
 
  check-dist:
    desc: Check built distribution metadata
    cmds:
      - python -m twine check dist/*

  clean-gen:
    desc: Delete generated ANTLR output directory contents (Windows only)
    platforms: [windows]
    cmds:
      #- rmdir /s /q "{{.DIR_OUTPUT}}"
      #- cmd /c rmdir /s /q "{{.DIR_OUTPUT}}"
      - powershell -NoProfile -Command "if (Test-Path '{{.DIR_OUTPUT}}') { Remove-Item -Recurse -Force '{{.DIR_OUTPUT}}' }"

  # Deletes Python caches under src:
  #   - __pycache__ directories
  #   - .pyc files
  #   - .pyo files, if any
  clean-cache:
    desc: Delete Python cache files and __pycache__ directories under src and tests
    platforms: [windows]
    cmds:
      - powershell -NoProfile -Command "Get-ChildItem 'src','tests' -Recurse -Directory -Filter '__pycache__' -ErrorAction SilentlyContinue | Remove-Item -Recurse -Force"
      - powershell -NoProfile -Command "Get-ChildItem 'src','tests' -Recurse -File -Include *.pyc,*.pyo -ErrorAction SilentlyContinue | Remove-Item -Force"
      - powershell -NoProfile -Command "if (Test-Path '.pytest_cache') { Remove-Item -Recurse -Force '.pytest_cache' }"
      - powershell -NoProfile -Command "if (Test-Path '.mypy_cache') { Remove-Item -Recurse -Force '.mypy_cache' }"
      - powershell -NoProfile -Command "if (Test-Path '.ruff_cache') { Remove-Item -Recurse -Force '.ruff_cache' }"

  clean-build:
    desc: Delete Python build artifacts
    platforms: [windows]
    cmds:
      - powershell -NoProfile -Command "if (Test-Path 'build') { Remove-Item -Recurse -Force 'build' }"
      - powershell -NoProfile -Command "if (Test-Path 'dist') { Remove-Item -Recurse -Force 'dist' }"
      - powershell -NoProfile -Command "Get-ChildItem 'src' -Directory -Filter '*.egg-info' -ErrorAction SilentlyContinue | Remove-Item -Recurse -Force"

  clean:
    desc: Delete caches only
    deps:
      - clean-cache

  clean-all:
    desc: Delete caches, build artifacts, and generated ANTLR output
    deps:
      - clean-cache
      - clean-build
      - clean-gen