lint-cmake.yaml

version: "3"

tasks:
  cmake-check:
    desc: "Runs the CMake linters."
    sources: &cmake_format_src_files
      - "{{.G_LINT_VENV_CHECKSUM_FILE}}"
      - "{{.ROOT_DIR}}/**/*.cmake"
      - "{{.ROOT_DIR}}/**/*.cmake.in"
      - "{{.ROOT_DIR}}/**/CMakeLists.txt"
      - "{{.ROOT_DIR}}/.gersemirc"
      - "{{.TASKFILE}}"
      - exclude: "{{.ROOT_DIR}}/**/build/*"
      - exclude: "{{.ROOT_DIR}}/**/cmake_install.cmake"
      - exclude: "{{.ROOT_DIR}}/**/CMakeFiles/*"
      - exclude: "{{.ROOT_DIR}}/**/submodules/*"
      - exclude: "{{.ROOT_DIR}}/**/tools/*"
    deps:
      - "venv"
    cmds:
      - task: "gersemi"
        vars:
          FLAGS: "--diff --color"
      - task: "gersemi"
        vars:
          FLAGS: "--check"

  cmake-fix:
    desc: "Runs the CMake linters and fixes all violations."
    sources: *cmake_format_src_files
    deps:
      - "venv"
    cmds:
      - task: "gersemi"
        vars:
          FLAGS: "--in-place"

  gersemi:
    internal: true
    requires:
      vars:
        - "FLAGS"
    dir: "{{.ROOT_DIR}}"
    deps:
      - ":deps:install-all"  # Allow Gersemi to parse 3rdparty CMake modules for linting
      - "venv"
    cmds:
      - |-
        . "{{.G_LINT_VENV_DIR}}/bin/activate"
        find . \
          \( -path '**/build' -o -path '**/cmake_install.cmake' -o -path '**/CMakeFiles' \
          -o -path '**/submodules' -o -path '**/tools' \) -prune -o \
          \( -iname "CMakeLists.txt" -o -iname "*.cmake" -o -iname "*.cmake.in" \) \
          -print0 | \
            xargs -0 gersemi {{.FLAGS}}