build: Generate CMake settings file containing dependency installation directories to replace specification through CLI options. (#31)

Co-authored-by: davidlion <[email protected]>

Author: kirkrodrigues

CMakeLists.txt

@@ -16,6 +16,13 @@ option(BUILD_TESTING "If ON, unit tests will be built." ON)
 # Import CMake helper functions
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/CMake)
 
+if(PROJECT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+    # Include dependency settings if the project isn't being included as a subproject.
+    # NOTE: We mark the file optional because if the user happens to have the dependencies
+    # installed, this file is not necessary.
+    include(build/deps/settings.cmake OPTIONAL)
+endif()
+
 if(BUILD_TESTING)
     find_package(Catch2 3.8.0 REQUIRED)
     if(Catch2_FOUND)

README.md

@@ -27,6 +27,12 @@ Initialize and update submodules:
 git submodule update --init --recursive
 ```
 
+If you want to open the project in an IDE, run the following command to install any necessary
+dependencies from source:
+```shell
+task deps:install-all
+```
+
 ## Building
 To build all targets:
 ```shell

taskfile.yaml

@@ -10,6 +10,10 @@ vars:
   G_BUILD_DIR: "{{.ROOT_DIR}}/build"
   G_CPP_SRC_DIR: "{{.ROOT_DIR}}/src"
   G_DEPS_DIR: "{{.G_BUILD_DIR}}/deps"
+
+  # This should be kept in-sync with its usage in CMakeLists.txt
+  G_DEPS_CMAKE_SETTINGS_FILE: "{{.G_DEPS_DIR}}/settings.cmake"
+
   G_TEST_BIN_DIR: "{{.G_BUILD_DIR}}/testbin"
   G_TEST_TARGET_SUFFIXES:
     - "all"

taskfiles/build.yaml

@@ -2,8 +2,6 @@ version: "3"
 
 vars:
   G_CMAKE_CACHE: "{{.G_BUILD_DIR}}/CMakeCache.txt"
-  G_CMAKE_CONF_ARGS:
-    - "-DCatch2_ROOT={{.G_DEPS_DIR}}/Catch2/Catch2-install"
   G_COMPILE_COMMANDS_DB: "{{.G_BUILD_DIR}}/compile_commands.json"
 
 tasks:
@@ -64,6 +62,4 @@ tasks:
       - task: ":utils:cmake-generate"
         vars:
           BUILD_DIR: "{{.G_BUILD_DIR}}"
-          EXTRA_ARGS:
-            ref: ".G_CMAKE_CONF_ARGS"
           SOURCE_DIR: "{{.ROOT_DIR}}"

taskfiles/deps.yaml

@@ -1,21 +1,28 @@
 version: "3"
 
+vars:
+  G_CATCH2_LIB_NAME: "Catch2"
+  G_CATCH2_WORK_DIR: "{{.G_DEPS_DIR}}/{{.G_CATCH2_LIB_NAME}}"
+
 tasks:
   install-all:
     desc: "Install all dependencies required by ystdlib-cpp."
     deps:
       - "install-Catch2"
+    cmds:
+      - "rm -f '{{.G_DEPS_CMAKE_SETTINGS_FILE}}'"
+      - >-
+        echo "set(
+        {{.G_CATCH2_LIB_NAME}}_ROOT \"{{.G_CATCH2_WORK_DIR}}/{{.G_CATCH2_LIB_NAME}}-install\"
+        )" >> "{{.G_DEPS_CMAKE_SETTINGS_FILE}}"
 
   install-Catch2:
     internal: true
-    vars:
-      NAME: "Catch2"
-      WORK_DIR: "{{.G_DEPS_DIR}}/{{.NAME}}"
     run: "once"
     cmds:
       - task: ":utils:cmake-install-remote-tar"
         vars:
-          NAME: "{{.NAME}}"
-          WORK_DIR: "{{.WORK_DIR}}"
+          NAME: "{{.G_CATCH2_LIB_NAME}}"
+          WORK_DIR: "{{.G_CATCH2_WORK_DIR}}"
           FILE_SHA256: "1ab2de20460d4641553addfdfe6acd4109d871d5531f8f519a52ea4926303087"
           URL: "https://github.com/catchorg/Catch2/archive/refs/tags/v3.8.0.tar.gz"