feat(taskfile): Add more build tasks and rename others according to latest conventions:

.gersemirc

@@ -3,6 +3,6 @@
 
 definitions:
   - "cmake/ystdlib-helpers.cmake"
-  - "build/deps/Catch2/Catch2-src/extras/Catch.cmake"
+  - "build/deps/Catch2-src/extras/Catch.cmake"
 line_length: 100
 list_expansion: "favour-expansion"

.github/workflows/code-linting-checks.yaml

@@ -37,6 +37,10 @@ jobs:
         shell: "bash"
         run: "npm install -g @go-task/cli"
 
+      - name: "Install uv"
+        shell: "bash"
+        run: "curl --fail --location --silent --show-error https://astral.sh/uv/install.sh | sh"
+
       - name: "Run lint task"
         shell: "bash"
         run: "task lint:check"

.github/workflows/unit-tests.yaml

@@ -25,6 +25,9 @@ jobs:
           - "macos-15"
           - "ubuntu-22.04"
           - "ubuntu-24.04"
+        build_type:
+          - "debug"
+          - "release"
     runs-on: "${{matrix.os}}"
     steps:
       - uses: "actions/checkout@v4"
@@ -45,7 +48,7 @@ jobs:
           brew install coreutils
           brew install llvm@16
 
-      - name: "Run unit tests"
+      - name: "Run unit tests and examples"
         env: >-
           ${{
           'macos-14' == matrix.os
@@ -55,4 +58,8 @@ jobs:
           }')
           || fromJson('{}')
           }}
-        run: "task test-all"
+        # Currently unit tests rely on cassert and fail to compile in release mode.
+        run: |-
+          task test:run-debug
+          task examples:build-${{matrix.build_type}}
+          ./build/examples/${{matrix.build_type}}/linking-tests

README.md

@@ -43,6 +43,7 @@ Follow the steps below to develop and contribute to the project.
 * CMake 3.23 or higher
 * Python 3.10 or higher
 * [Task] 3.40.0 or higher
+* [uv] 0.7.10 or higher
 
 ## Set up
 Initialize and update submodules:
@@ -52,6 +53,7 @@ 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
 ```
@@ -61,23 +63,26 @@ task deps:install-all
 The library can be built directly using [CMake](#using-cmake) or indirectly using
 [Task](#using-task).
 
-### Using Task
+### Using Task {#build-task}
 
-To build all targets:
+To build all libraries:
 ```shell
-task build:all
+task ystdlib:build-release
 ```
 
-To build an executable containing all unit tests:
-```shell
-task build:unit-test-all
-```
+To build a subset of libraries, set the parameter `ystdlib_LIBRARIES` to a semicolon-separated (`;`)
+list of library names. The library names match their [directory name in src/](./src/ystdlib). For
+example:
 
-To build an executable containing a single library's unit tests:
 ```shell
-task build:unit-test-<lib_name>
+task ystdlib:build-release ystdlib_LIBRARIES="containers;io_interface"
 ```
 
+> [!NOTE]
+> Internal dependencies of the libraries you choose will be automatically built, even if you don't
+> explicitly specify them. In the example, specifying `io_interface` automatically adds
+> `wrapped_facade_headers` to the build.
+
 ### Using CMake
 
 To build all libraries, run:
@@ -103,21 +108,44 @@ cmake --build ./build
 
 ## Installing
 
-After [building](#building), install with:
+### Using Task
+
+To build and install all libraries, run:
+
+```shell
+task ystdlib:install-release INSTALL_PREFIX="$HOME/.local"
+```
+
+To build and install a subset of libraries, set the variable `ystdlib_LIBRARIES` the same as in the
+section, [Building: Using Task](build-task). For example:
+
+```shell
+task ystdlib:install-release \
+    INSTALL_PREFIX="$HOME/.local" \
+    ystdlib_LIBRARIES="containers;io_interface"
+```
+
+### Using CMake
+
+After [building](#building), to install all built libraries run:
 
 ```shell
 cmake --install "./build" --prefix "$HOME/.local"
 ```
 
 ## Testing
+
 To build and run all unit tests:
+
 ```shell
-task test-all
+task test:run-debug
 ```
 
-To build and run unit tests for a specific library:
+To build and run unit tests for a subset of libraries, set the variable `ystdlib_LIBRARIES` the same
+as in the section, [Building: Using Task](build-task). For example:
+
 ```shell
-task test-<lib_name>
+task test:run-debug ystdlib_LIBRARIES="containers;io_interface"
 ```
 
 When generating a testing target, the CMake variable `BUILD_TESTING` is followed (unless overruled
@@ -145,3 +173,4 @@ task -a
 Look for all tasks under the `lint` namespace (identified by the `lint:` prefix).
 
 [Task]: https://taskfile.dev
+[uv]: https://docs.astral.sh/uv

examples/README.md

@@ -5,13 +5,33 @@ This directory contains example programs that demonstrate how to use the ystdlib
 The example program `linking-tests` references all of ystdlib's library targets to ensure they can
 be installed and linked correctly.
 
-## Requirements
+## Building
+
+### Using Task
+
+#### Requirements
+
+See the [ystdlib Requirements section](../README.md#requirements).
+
+#### Commands
+
+```shell
+# debug build
+task examples:build-debug
+
+# release build
+task examples:build-release
+```
+
+### Using CMake
+
+#### Requirements
 
 [Build](../README.md#building) and [install](../README.md#installing) ystdlib. The commands below
 assume you've built and installed ystdlib to `./build/examples/ystdlib`. If you installed it to a
 different location, adjust the paths accordingly.
 
-## Building
+#### Commands
 
 ```shell
 cmake -S "./examples" -B "./build/examples" -Dystdlib_ROOT="./build/examples/ystdlib"

taskfile.yaml

@@ -4,26 +4,21 @@ set: ["u", "pipefail"]
 shopt: ["globstar"]
 
 includes:
-  build: "./taskfiles/build.yaml"
   deps: "./taskfiles/deps.yaml"
+  examples: "./taskfiles/examples.yaml"
   lint: "./taskfiles/lint.yaml"
-  utils: "tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
+  test: "./taskfiles/test.yaml"
+  ystdlib: "./taskfiles/ystdlib.yaml"
 
 vars:
-  G_BUILD_DIR: "{{.ROOT_DIR}}/build"
-  G_CPP_SRC_DIR: "{{.ROOT_DIR}}/src"
-  G_DEPS_DIR: "{{.G_BUILD_DIR}}/deps"
-
-  # These should be kept in-sync with its usage in CMakeLists.txt
-  G_DEPS_CMAKE_SETTINGS_DIR: "{{.G_DEPS_DIR}}/cmake-settings"
-  G_DEPS_CMAKE_SETTINGS_FILE: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}/all.cmake"
+  # General variables
+  # This must match the package name in CMakeLists.txt.
+  G_CMAKE_PACKAGE_NAME: "ystdlib"
 
-  G_TEST_BIN_DIR: "{{.G_BUILD_DIR}}/testbin"
-  G_TEST_TARGET_SUFFIXES:
-    - "all"
-    - "containers"
-    - "error_handling"
-    - "wrapped_facade_headers"
+  # Build variables
+  G_BUILD_DIR: "{{.ROOT_DIR}}/build"
+  G_EXAMPLES_BUILD_DIR: "{{.G_BUILD_DIR}}/examples"
+  G_YSTDLIB_BUILD_DIR: "{{.G_BUILD_DIR}}/{{.G_CMAKE_PACKAGE_NAME}}"
 
 tasks:
   clean:
@@ -37,13 +32,3 @@ tasks:
     run: "once"
     cmds:
       - "mkdir -p '{{.G_BUILD_DIR}}'"
-
-  test-*:
-    desc: "Runs unit tests for the specified test target."
-    vars:
-      TEST_TARGET: >-
-        {{printf "unit-test-%s" (index .MATCH 0)}}
-    deps:
-      - "build:{{.TEST_TARGET}}"
-    cmds:
-      - "{{.G_TEST_BIN_DIR}}/{{.TEST_TARGET}}"

taskfiles/deps.yaml

@@ -1,49 +1,55 @@
 version: "3"
 
+includes:
+  utils:
+    internal: true
+    taskfile: "../tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
+
 vars:
-  G_CATCH2_LIB_NAME: "Catch2"
-  G_CATCH2_WORK_DIR: "{{.G_DEPS_DIR}}/{{.G_CATCH2_LIB_NAME}}"
+  # General variables
+  G_DEPS_DIR: "{{.G_BUILD_DIR}}/deps"
+
+  # This path must be kept in-sync with its usage in CMakeLists.txt and examples/CMakeLists.txt.
+  G_DEPS_CMAKE_SETTINGS_DIR: "{{.G_DEPS_DIR}}/cmake-settings"
 
 tasks:
   install-all:
-    desc: "Install all dependencies required by ystdlib-cpp."
+    desc: "Install all dependencies required by ystdlib."
     run: "once"
     cmds:
-      - "rm -rf '{{.G_DEPS_CMAKE_SETTINGS_DIR}}'"
-      - "mkdir -p '{{.G_DEPS_CMAKE_SETTINGS_DIR}}'"
-      - task: ":utils:cmake:install-deps-and-generate-settings"
+      - task: "utils:cmake:install-deps-and-generate-settings"
         vars:
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
-          CMAKE_SETTINGS_FILE: "{{.G_DEPS_CMAKE_SETTINGS_FILE}}"
-          DEP_TASK: "deps:install-all-parallel"
+          DEP_TASK: "install-all-parallel"
 
   install-all-parallel:
     internal: true
+    run: "once"
     deps:
       - "install-boost"
-      - "install-Catch2"
+      - "install-catch2"
 
-  install-Catch2:
+  install-boost:
     internal: true
     run: "once"
     cmds:
-      - task: ":utils:cmake:install-remote-tar"
+      - task: "utils:boost:download-and-install"
         vars:
-          CMAKE_PACKAGE_NAME: "{{.G_CATCH2_LIB_NAME}}"
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
-          TAR_SHA256: "1ab2de20460d4641553addfdfe6acd4109d871d5531f8f519a52ea4926303087"
-          TAR_URL: "https://github.com/catchorg/Catch2/archive/refs/tags/v3.8.0.tar.gz"
-          WORK_DIR: "{{.G_CATCH2_WORK_DIR}}"
+          FILE_SHA256: "d6c69e4459eb5d6ec208250291221e7ff4a2affde9af6e49c9303b89c687461f"
+          URL: "https://github.com/boostorg/boost/releases/download/boost-1.87.0\
+            /boost-1.87.0-b2-nodocs.tar.gz"
+          TARGETS: ["headers"]
+          WORK_DIR: "{{.G_DEPS_DIR}}"
 
-  install-boost:
+  install-catch2:
     internal: true
     run: "once"
     cmds:
-      - task: ":utils:boost:download-and-install"
+      - task: "utils:cmake:install-remote-tar"
         vars:
+          CMAKE_PACKAGE_NAME: "Catch2"
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
-          FILE_SHA256: "d6c69e4459eb5d6ec208250291221e7ff4a2affde9af6e49c9303b89c687461f"
-          URL: "https://github.com/boostorg/boost/releases/download/boost-1.87.0\
-            /boost-1.87.0-b2-nodocs.tar.gz"
-          TARGETS: ["headers"]
-          WORK_DIR: "{{.G_DEPS_DIR}}/boost"
+          TAR_SHA256: "1ab2de20460d4641553addfdfe6acd4109d871d5531f8f519a52ea4926303087"
+          TAR_URL: "https://github.com/catchorg/Catch2/archive/refs/tags/v3.8.0.tar.gz"
+          WORK_DIR: "{{.G_DEPS_DIR}}"