Taskfile.yml

# Notes
# - install task from: https://taskfile.dev/#/installation or use `setup-cpp --task true`
# - If using Visual Studio, either run the following commands inside the Visual Studio command prompt (vcvarsall) or set CMAKE_GENERATOR to "Visual Studio 17 2022"

version: 3

tasks:
  # The templates called in the other tasks. The variables can be set using the `vars` parameter or by environment variables. To create global variables that are passed to the internally called templates, use `env`
  # This template accepts the generator, build type and feature flags defined by the vars. Other flags can be passed by `CONFIGURE_FLAGS` and `BUILD_FLAGS`. For example, a specific target can be built by setting BUILD_FLAGS to "--target <NAME>"
  build_template:
    - cmake -S ./ -B ./build -G '{{.CMAKE_GENERATOR | default "Ninja Multi-Config"}}' -DCMAKE_BUILD_TYPE:STRING={{.CMAKE_BUILD_TYPE}} -DCMAKE_TOOLCHAIN_FILE=~/vcpkg/scripts/buildsystems/vcpkg.cmake {{.CONFIGURE_FLAGS}}
    - cmake --build ./build --config {{.CMAKE_BUILD_TYPE}} {{.BUILD_FLAGS}}

  # Execute the app or the tests
  run_template:
    - cd build/tests/approval_tests && ctest -C {{.CMAKE_BUILD_TYPE}} --output-on-failure
    - cd build/tests/unit_tests && ctest -C {{.CMAKE_BUILD_TYPE}} --output-on-failure

  # Run with coverage analysis
  coverage_template:
    cmds:
      # Set --sources "your_source_folder\*" and --filter "your_source_folder/" to have a clean coverage report
      - |
        {{if eq OS "windows"}}

          OpenCppCoverage.exe --export_type html:./build/coverage --export_type cobertura:./build/coverage.xml --cover_children --sources "my_exe\*" --sources "my_lib\*" --sources "my_header_lib\*" --modules "build\*" -- task run_template

          powershell -c "if (!\$env:CI) { echo '[info] Opening ./build/coverage/index.html...'; start ./build/coverage/index.html }"
        {{else}}
          task run_template
          mkdir -p ./build/coverage/

          gcovr -j {{.nproc | default 1}} --delete --filter "my_exe/" --filter "my_lib/" --filter "my_header_lib/" --root ./ --print-summary --html-details ./build/coverage/index.html --xml-pretty --xml ./build/coverage.xml --gcov-ignore-errors=no_working_dir_found ./build

          echo "Open ./build/coverage/index.html in a browser for a visual coverage report"
        {{end}}
    env:
      CMAKE_BUILD_TYPE: "{{.CMAKE_BUILD_TYPE}}"

  build:
    - task: build_template
      vars:
        CMAKE_BUILD_TYPE: Release

  build_debug:
    - task: build_template
      vars:
        CMAKE_BUILD_TYPE: Debug

  install:
    - task: build
    - cmake --install ./build --prefix {{.INSTALL_PREFIX | default "./install"}}

  test:
    - task: build_template
      vars:
        CMAKE_BUILD_TYPE: Debug
    - task: run_template
      vars:
        CMAKE_BUILD_TYPE: Debug

  test_release_debug:
    - task: build_template
      vars:
        CMAKE_BUILD_TYPE: RelWithDebInfo
    - task: run_template
      vars:
        CMAKE_BUILD_TYPE: RelWithDebInfo

  test_release:
    - task: build_template
      vars:
        CMAKE_BUILD_TYPE: Release
    - task: run_template
      vars:
        CMAKE_BUILD_TYPE: Release

  coverage:
    - task: build_template
      vars:
        CMAKE_BUILD_TYPE: Debug
    - task: coverage_template
      vars:
        CMAKE_BUILD_TYPE: Debug

  coverage_release_debug:
    - task: build_template
      vars:
        CMAKE_BUILD_TYPE: RelWithDebInfo
    - task: coverage_template
      vars:
        CMAKE_BUILD_TYPE: RelWithDebInfo

  coverage_release:
    - task: build_template
      vars:
        CMAKE_BUILD_TYPE: Release
    - task: coverage_template
      vars:
        TEST_COMMAND: task run_template
        CMAKE_BUILD_TYPE: Release

  docs:
    - task: build_template
      vars:
        CMAKE_BUILD_TYPE: Debug
        BUILD_FLAGS: --target doxygen-docs

  lint:
    - |
      {{if eq OS "windows"}}
        powershell -c '$files=(git ls-files --exclude-standard); foreach ($file in $files) { if ((get-item $file).Extension -in ".cpp", ".hpp", ".c", ".cc", ".cxx", ".hxx", ".ixx") { clang-format -i -style=file $file } }'
      {{else}}
        git ls-files --exclude-standard | grep -E '\.(cpp|hpp|c|cc|cxx|hxx|ixx)$' | xargs clang-format -i -style=file
      {{end}}
    - |
      {{if eq OS "windows"}}
      powershell -c '$files=(git ls-files --exclude-standard); foreach ($file in $files) { $item=(get-item $file); if (($item.Name -eq "CMakeLists.txt") -or ($item.Extension -in ".cmake")) { cmake-format --in-place $file; cmake-lint $file --disabled-codes C0103 C0301 R0912 R0915 R0913 --suppress-decorations } }'
      {{else}}
        git ls-files --exclude-standard | grep -E '(CMakeLists\.txt)|(\.(cmake))$' | xargs cmake-format --in-place | xargs cmake-lint --disabled-codes C0103 C0301 R0912 R0915 R0913 --suppress-decorations
      {{end}}

    - ~/vcpkg/vcpkg format-manifest ./vcpkg.json
    - npx -y cspell lint --no-progress --show-suggestions

  clean: |
    {{if eq OS "windows"}}
      powershell -c 'function rmrf($file) { if (test-path $file) { rm -r -force $file }}; rmrf ./build; rmrf ./install'
    {{else}}
      rm -rf ./build ./install
    {{end}}