Use dedicated binary dirs for presets

Using dedicated directories allows the developer to have multiple builds
existing at the same time in the `build` directory, so normal builds,
coverage and sanitizer builds can all coexist by default.

Author: friendlyanon

cmake-init/__main__.py

@@ -211,9 +211,9 @@ def print_tips(d):
 in that order:
 
     cmake --preset=dev
-    cmake --build build{config} -j {cpus}
-    cmake --install build{config} --prefix prefix
-    ctest --test-dir build{test_cfg} -j {cpus} --output-on-failure
+    cmake --build build/dev{config} -j {cpus}
+    cmake --install build/dev{config} --prefix prefix
+    ctest --test-dir build/dev{test_cfg} -j {cpus} --output-on-failure
 """)
     extra = ["    docs - build the documentation using Doxygen and m.css"]
     if d["examples"]:
@@ -231,7 +231,7 @@ def print_tips(d):
 These targets are only available in developer mode, because they are generally
 not useful for consumers. You can run these targets with the following command:
 
-    cmake --build build{config} -t <target>
+    cmake --build build/dev{config} -t <target>
 """)
 
 

cmake-init/templates/common/.github/workflows/ci.yml

@@ -31,17 +31,18 @@ jobs:
       run: cmake --preset=ci-coverage
 
     - name: Build
-      run: cmake --build build -j 2
+      run: cmake --build build/coverage -j 2
 
     - name: Test
-      working-directory: build
+      working-directory: build/coverage
       env:
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         PS4: "\e[36m+++\e[0m "
       run: |
         set -x
         ctest --output-on-failure -j 2
-        lcov -c -d .. -o coverage.info --include '${{ github.workspace }}/*'
+        lcov -c -d '${{ github.workspace }}' -o coverage.info \
+          --include '${{ github.workspace }}/*'
         lcov --list coverage.info
         bash <(curl -s https://codecov.io/bash) -f coverage.info
 
@@ -56,7 +57,7 @@ jobs:
       run: cmake --preset=ci-sanitize
 
     - name: Build
-      run: cmake --build build -j 2
+      run: cmake --build build/sanitize -j 2
 
     - name: Test
       env:
@@ -66,7 +67,7 @@ jobs:
           strict_init_order=1:\
           detect_leaks=1"
         UBSAN_OPTIONS: print_stacktrace=1
-      run: ctest --test-dir build --output-on-failure -j 2
+      run: ctest --test-dir build/sanitize --output-on-failure -j 2
 
   test:
     strategy:

cmake-init/templates/common/CMakePresets.json

@@ -42,29 +42,25 @@
         "CMAKE_CXX_FLAGS": "/W4 /permissive- /EHsc /volatile:iso /Zc:__cplusplus /Zc:throwingNew"
       }
     },
-    {
-      "name": "ci-build",
-      "binaryDir": "${sourceDir}/build",
-      "hidden": true
-    },
     {
       "name": "ci-unix",
       "generator": "Unix Makefiles",
       "hidden": true,
-      "inherits": ["flags-unix", "ci-build"],
+      "inherits": "flags-unix",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Release"
       }
     },
     {
       "name": "ci-win64",
-      "inherits": ["flags-windows", "ci-build"],
+      "inherits": "flags-windows",
       "generator": "Visual Studio 16 2019",
       "architecture": "x64",
       "hidden": true
     },
     {
       "name": "ci-coverage",
+      "binaryDir": "${sourceDir}/build/coverage",
       "inherits": ["ci-unix", "dev-mode"],
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Coverage",
@@ -75,23 +71,29 @@
     },
     {
       "name": "ci-sanitize",
+      "binaryDir": "${sourceDir}/build/sanitize",
       "inherits": ["ci-unix", "dev-mode"],
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Sanitize",
         "CMAKE_CXX_FLAGS_SANITIZE": "-O2 -g -fsanitize=address,undefined -fno-omit-frame-pointer -fno-common"
       }
     },
+    {
+      "name": "ci-build",
+      "binaryDir": "${sourceDir}/build",
+      "hidden": true
+    },
     {
       "name": "ci-macos",
-      "inherits": ["ci-unix", "dev-mode"]
+      "inherits": ["ci-build", "ci-unix", "dev-mode"]
     },
     {
       "name": "ci-ubuntu",
-      "inherits": ["ci-unix", "clang-tidy", "cppcheck", "dev-mode"]
+      "inherits": ["ci-build", "ci-unix", "clang-tidy", "cppcheck", "dev-mode"]
     },
     {
       "name": "ci-windows",
-      "inherits": ["ci-win64", "dev-mode"]
+      "inherits": ["ci-build", "ci-win64", "dev-mode"]
     }
   ]
 }

cmake-init/templates/common/CMakeUserPresets.json

@@ -8,6 +8,7 @@
   "configurePresets": [
     {
       "name": "dev",
+      "binaryDir": "${sourceDir}/build/dev",
       "inherits": ["dev-mode", "ci-%(os)s"{if use_clang_tidy}, "clang-tidy"{end}{if use_cppcheck}, "cppcheck"{end}],
       "cacheVariables": {
         "BUILD_DOCUMENTATION": "ON"

cmake-init/templates/common/HACKING.md

@@ -40,6 +40,7 @@ the project:
   "configurePresets": [
     {
       "name": "dev",
+      "binaryDir": "${sourceDir}/build/dev",
       "inherits": ["dev-mode", "ci-<os>"]
     }
   ]
@@ -62,16 +63,16 @@ Windows:
 
 ```sh
 cmake --preset=dev
-cmake --build build --config Release
-ctest --test-dir build -C Release
+cmake --build build/dev --config Release
+ctest --test-dir build/dev -C Release
 ```
 
 And here is the same on a Unix based system (Linux, macOS):
 
 ```sh
 cmake --preset=dev
-cmake --build build
-ctest --test-dir build
+cmake --build build/dev
+ctest --test-dir build/dev
 ```
 
 [1]: https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html