lint-tasks.yaml

version: "3"

vars:
  G_LINT_VENV_DIR: "{{.G_BUILD_DIR}}/lint-venv"
  G_LINT_VENV_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/lint#venv.md5"

tasks:
  check:
    cmds:
      - task: "cmake-check"
      - task: "cpp-check"
      - task: "py-check"
      - task: "yml-check"

  fix:
    cmds:
      - task: "cmake-fix"
      - task: "cpp-fix"
      - task: "yml-fix"

  cmake-check:
    deps: ["venv"]
    cmds:
      - task: "cmake"
        vars:
          FLAGS: "--check"

  cmake-fix:
    deps: ["venv"]
    cmds:
      - task: "cmake"
        vars:
          FLAGS: "--in-place"

  cpp-configs: "tools/yscope-dev-utils/lint-configs/symlink-cpp-lint-configs.sh"

  cpp-check:
    cmds:
      - task: "cpp-format-check"
      - task: "cpp-static-check"

  cpp-fix:
    cmds:
      - task: "cpp-format-fix"
      - task: "cpp-static-fix"

  cpp-format-check:
    sources: &cpp_format_src_files
      - "{{.G_LINT_VENV_CHECKSUM_FILE}}"
      - "{{.G_SRC_SPIDER_DIR}}/.clang-format"
      - "{{.G_SRC_SPIDER_DIR}}/**/*.cpp"
      - "{{.G_SRC_SPIDER_DIR}}/**/*.h"
      - "{{.G_SRC_SPIDER_DIR}}/**/*.hpp"
      - "{{.G_TEST_DIR}}/**/*.cpp"
      - "{{.G_TEST_DIR}}/**/*.h"
      - "{{.G_TEST_DIR}}/**/*.hpp"
      - "{{.TASKFILE}}"
      - "tools/yscope-dev-utils/lint-configs/.clang-format"
    deps: ["cpp-configs", "venv"]
    cmds:
      - task: "clang-format"
        vars:
          FLAGS: "--dry-run"
          SRC_DIR: "{{.G_SRC_SPIDER_DIR}}"

  cpp-format-fix:
    sources: *cpp_format_src_files
    deps: ["cpp-configs", "venv"]
    cmds:
      - task: "clang-format"
        vars:
          FLAGS: "-i"
          SRC_DIR: "{{.G_SRC_SPIDER_DIR}}"
      - task: "clang-format"
        vars:
          FLAGS: "-i"
          SRC_DIR: "{{.G_TEST_DIR}}"

  cpp-static-check:
    # Alias task to `cpp-static-fix` since we don't currently support automatic fixes.
    # NOTE: clang-tidy does have the ability to fix some errors, but the fixes can be inaccurate.
    # When we eventually determine which errors can be safely fixed, we'll allow clang-tidy to
    # fix them.
    aliases: ["cpp-static-fix"]
    sources:
      - "{{.G_LINT_VENV_CHECKSUM_FILE}}"
      - "{{.G_SRC_SPIDER_DIR}}/**/*.cpp"
      - "{{.G_SRC_SPIDER_DIR}}/**/*.h"
      - "{{.G_SRC_SPIDER_DIR}}/**/*.hpp"
      - "{{.G_TEST_DIR}}/**/*.cpp"
      - "{{.G_TEST_DIR}}/**/*.h"
      - "{{.G_TEST_DIR}}/**/*.hpp"
      - "{{.G_SPIDER_CMAKE_CACHE}}"
      - "{{.G_SPIDER_COMPILE_COMMANDS_DB}}"
      - "{{.TASKFILE}}"
      - "taskfile.yaml"
      - "tools/yscope-dev-utils/lint-configs/.clang-tidy"
    deps: [":config-cmake-project", "cpp-configs", "venv"]
    cmds:
      - task: "clang-tidy"
        vars:
          FLAGS: "--config-file=.clang-tidy -p {{.G_SPIDER_COMPILE_COMMANDS_DB}}"
          SRC_DIR: "{{.G_SRC_SPIDER_DIR}}"
          TEST_DIR: "{{.G_TEST_DIR}}"

  py-check:
    cmds:
      - task: "py"
        vars:
          BLACK_FLAGS: "--check"
          RUFF_FLAGS: ""

  py-fix:
    cmds:
      - task: "py"
        vars:
          BLACK_FLAGS: ""
          RUFF_FLAGS: "--fix"

  py:
    internal: true
    requires:
      vars: ["BLACK_FLAGS", "RUFF_FLAGS"]
    deps: ["venv"]
    cmds:
      - for:
          - "tests/integration"
        cmd: |-
          . "{{.G_LINT_VENV_DIR}}/bin/activate"
          cd "{{.ITEM}}"
          black --color --line-length 100 {{.BLACK_FLAGS}} .
          ruff check {{.RUFF_FLAGS}} .

  yml:
    aliases:
      - "yml-check"
      - "yml-fix"
    deps: ["venv"]
    cmds:
      - |-
        . "{{.G_LINT_VENV_DIR}}/bin/activate"
        yamllint \
          --config-file "tools/yscope-dev-utils/lint-configs/.yamllint.yml" \
          --strict \
          .gersemirc \
          .github/ \
          build-tasks.yaml \
          dep-tasks.yaml \
          lint-tasks.yaml \
          taskfile.yaml \
          test-tasks.yaml

  clang-format:
    internal: true
    requires:
      vars: ["FLAGS", "SRC_DIR"]
    cmd: |-
      . "{{.G_LINT_VENV_DIR}}/bin/activate"
      find "{{.SRC_DIR}}" \
        -type f \
        \( -iname "*.cpp" -o -iname "*.h" -o -iname "*.hpp" \) \
        -print0 | \
          xargs -0 --no-run-if-empty clang-format {{.FLAGS}} -Werror

  clang-tidy:
    internal: true
    requires:
      vars: ["FLAGS", "SRC_DIR", "TEST_DIR"]
    cmd: |-
      . "{{.G_LINT_VENV_DIR}}/bin/activate"
      find "{{.SRC_DIR}}" "{{.TEST_DIR}}" \
        -type f \
        \( -iname "*.cpp" -o -iname "*.h" -o -iname "*.hpp" \) \
        -print0 | \
          xargs -0 --no-run-if-empty clang-tidy {{.FLAGS}}

  cmake:
    internal: true
    requires:
      vars: ["FLAGS"]
    sources:
      - "CMakeLists.txt"
      - "src/spider/CMakeLists.txt"
      - "tests/CMakeLists.txt"
      - "cmake/Modules/*.cmake"
    cmds:
      - for: "sources"
        cmd: |-
          . "{{.G_LINT_VENV_DIR}}/bin/activate"
          gersemi {{.FLAGS}} {{.ITEM}}

  venv:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_LINT_VENV_CHECKSUM_FILE}}"
      OUTPUT_DIR: "{{.G_LINT_VENV_DIR}}"
    sources:
      - "{{.ROOT_DIR}}/taskfile.yaml"
      - "{{.TASKFILE}}"
      - "lint-requirements.txt"
    generates: ["{{.CHECKSUM_FILE}}"]
    run: "once"
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          DATA_DIR: "{{.OUTPUT_DIR}}"
    cmds:
      - task: ":utils:create-venv"
        vars:
          LABEL: "lint"
          OUTPUT_DIR: "{{.OUTPUT_DIR}}"
          REQUIREMENTS_FILE: "lint-requirements.txt"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          DATA_DIR: "{{.OUTPUT_DIR}}"
          OUTPUT_FILE: "{{.CHECKSUM_FILE}}"