Update and refactor taskfiles.

davidlion · davidlion · commit 7c6298268c4b · 2025-06-11T04:11:31.000-04:00
diff --git a/taskfile.yaml b/taskfile.yaml
@@ -39,51 +39,3 @@ tasks:
     run: "once"
     cmds:
       - "mkdir -p '{{.G_BUILD_DIR}}'"
-
-  validate-all-args:
-    internal: true
-    requires:
-      vars: ["BUILD_TYPE", "TARGET"]
-    cmds:
-      - task: "validate-build-type"
-        vars:
-          BUILD_TYPE: "{{.BUILD_TYPE}}"
-      - task: "validate-target"
-        vars:
-          TARGET: "{{.TARGET}}"
-
-  validate-arg:
-    internal: true
-    requires:
-      vars: ["ARG", "VALID_ARGS"]
-    preconditions:
-      - sh: >-
-          {{has .ARG .VALID_ARGS}}
-        msg: |-
-          {{- if not (has .ARG .VALID_ARGS)}}
-            {{.ERR_MSG}}
-            "{{.ARG}} is not a valid argument. List of valid arguments:"
-            {{- range .VALID_ARGS}}
-              {{.}}
-            {{- end}}
-          {{- end}}
-
-  validate-build-type:
-    internal: true
-    requires:
-      vars: ["BUILD_TYPE"]
-    cmds:
-      - task: "validate-arg"
-        vars:
-          ARG: "{{.BUILD_TYPE}}"
-          VALID_ARGS: "{{.G_VALID_BUILD_TYPES}}"
-
-  validate-target:
-    internal: true
-    requires:
-      vars: ["TARGET"]
-    cmds:
-      - task: "validate-arg"
-        vars:
-          ARG: "{{.TARGET}}"
-          VALID_ARGS: "{{.G_VALID_TARGETS}}"
diff --git a/taskfiles/build.yaml b/taskfiles/build.yaml
@@ -4,9 +4,12 @@ includes:
   deps:
     internal: true
     taskfile: "deps.yaml"
-  utils:
+  dev-utils:
     internal: true
     taskfile: "../tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
+  utils:
+    internal: true
+    taskfile: "utils.yaml"
 
 tasks:
   build-*-*:
@@ -15,7 +18,7 @@ tasks:
       BUILD_TYPE: "{{index .MATCH 1}}"
       TARGET: "{{index .MATCH 0}}"
     deps:
-      - task: ":validate-all-args"
+      - task: "utils:validate-all-args"
         vars:
           BUILD_TYPE: "{{.BUILD_TYPE}}"
           TARGET: "{{.TARGET}}"
@@ -30,11 +33,11 @@ tasks:
     vars:
       BUILD_TYPE: "{{index .MATCH 0}}"
     deps:
-      - task: ":validate-build-type"
+      - task: "utils:validate-build-type"
         vars:
           BUILD_TYPE: "{{.BUILD_TYPE}}"
     cmds:
-      - task: "utils:cmake:clean"
+      - task: "dev-utils:cmake:clean"
         vars:
           BUILD_DIR: "{{.G_YSTDLIB_BUILD_DIR}}/{{.BUILD_TYPE}}"
 
@@ -48,7 +51,7 @@ tasks:
     requires:
       vars: ["INSTALL_PREFIX"]
     deps:
-      - task: ":validate-all-args"
+      - task: "utils:validate-all-args"
         vars:
           BUILD_TYPE: "{{.BUILD_TYPE}}"
           TARGET: "{{.TARGET}}"
@@ -60,23 +63,34 @@ tasks:
           TARGET: "{{.TARGET}}"
 
   build:
+    internal: true
+    requires:
+      vars: ["BUILD_TYPE", "TARGET"]
+    deps:
+      - task: "generate"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          TARGET: "{{.TARGET}}"
+    cmds:
+      - task: "dev-utils:cmake:build"
+        vars:
+          BUILD_DIR: "{{.G_YSTDLIB_BUILD_DIR}}/{{.BUILD_TYPE}}"
+          TARGETS:
+            - "{{.TARGET}}"
+
+  generate:
     internal: true
     requires:
       vars: ["BUILD_TYPE", "TARGET"]
     deps:
       - "deps:all"
     cmds:
-      - task: "utils:cmake:generate"
+      - task: "dev-utils:cmake:generate"
         vars:
           BUILD_DIR: "{{.G_YSTDLIB_BUILD_DIR}}/{{.BUILD_TYPE}}"
           EXTRA_ARGS:
             - "-DCMAKE_BUILD_TYPE={{.BUILD_TYPE}}"
           SOURCE_DIR: "{{.ROOT_DIR}}"
-      - task: "utils:cmake:build"
-        vars:
-          BUILD_DIR: "{{.G_YSTDLIB_BUILD_DIR}}/{{.BUILD_TYPE}}"
-          TARGETS:
-            - "{{.TARGET}}"
 
   install:
     internal: true
@@ -88,7 +102,7 @@ tasks:
           BUILD_TYPE: "{{.BUILD_TYPE}}"
           TARGET: "{{.TARGET}}"
     cmds:
-      - task: "utils:cmake:install"
+      - task: "dev-utils:cmake:install"
         vars:
           BUILD_DIR: "{{.G_YSTDLIB_BUILD_DIR}}/{{.BUILD_TYPE}}"
           INSTALL_PREFIX: "{{.INSTALL_PREFIX}}"
diff --git a/taskfiles/deps.yaml b/taskfiles/deps.yaml
@@ -1,7 +1,7 @@
 version: "3"
 
 includes:
-  utils:
+  dev-utils:
     internal: true
     taskfile: "../tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
 
@@ -17,7 +17,7 @@ tasks:
     desc: "Install all dependencies required by ystdlib."
     run: "once"
     cmds:
-      - task: "utils:cmake:install-deps-and-generate-settings"
+      - task: "dev-utils:cmake:install-deps-and-generate-settings"
         vars:
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
           DEP_TASK: "all-parallel"
@@ -33,7 +33,7 @@ tasks:
     internal: true
     run: "once"
     cmds:
-      - task: "utils:cmake:install-remote-tar"
+      - task: "dev-utils:cmake:install-remote-tar"
         vars:
           CMAKE_PACKAGE_NAME: "{{.G_CATCH2_LIB_NAME}}"
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
@@ -45,7 +45,7 @@ tasks:
     internal: true
     run: "once"
     cmds:
-      - task: "utils:boost:download-and-install"
+      - task: "dev-utils:boost:download-and-install"
         vars:
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
           FILE_SHA256: "d6c69e4459eb5d6ec208250291221e7ff4a2affde9af6e49c9303b89c687461f"
diff --git a/taskfiles/examples.yaml b/taskfiles/examples.yaml
@@ -7,17 +7,20 @@ includes:
   deps:
     internal: true
     taskfile: "deps.yaml"
-  utils:
+  dev-utils:
     internal: true
     taskfile: "../tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
+  utils:
+    internal: true
+    taskfile: "utils.yaml"
 
 tasks:
   build-*:
     desc: "build-<build type>: Builds the examples with build type."
     vars:
       BUILD_TYPE: "{{index .MATCH 0}}"
     deps:
-      - task: ":validate-build-type"
+      - task: "utils:validate-build-type"
         vars:
           BUILD_TYPE: "{{.BUILD_TYPE}}"
     cmds:
@@ -30,15 +33,28 @@ tasks:
     vars:
       BUILD_TYPE: "{{index .MATCH 0}}"
     deps:
-      - task: ":validate-build-type"
+      - task: "utils:validate-build-type"
         vars:
           BUILD_TYPE: "{{.BUILD_TYPE}}"
     cmds:
-      - task: "utils:cmake:clean"
+      - task: "dev-utils:cmake:clean"
         vars:
           BUILD_DIR: "{{.G_EXAMPLES_BUILD_DIR}}/{{.BUILD_TYPE}}"
 
   build:
+    internal: true
+    requires:
+      vars: ["BUILD_TYPE"]
+    deps:
+      - task: "generate"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+    cmds:
+      - task: "dev-utils:cmake:build"
+        vars:
+          BUILD_DIR: "{{.G_EXAMPLES_BUILD_DIR}}/{{.BUILD_TYPE}}"
+
+  generate:
     internal: true
     requires:
       vars: ["BUILD_TYPE"]
@@ -51,13 +67,10 @@ tasks:
           INSTALL_PREFIX: "{{.INSTALL_PREFIX}}"
           TARGET: "all"
     cmds:
-      - task: "utils:cmake:generate"
+      - task: "dev-utils:cmake:generate"
         vars:
           BUILD_DIR: "{{.G_EXAMPLES_BUILD_DIR}}/{{.BUILD_TYPE}}"
           EXTRA_ARGS:
             - "-DCMAKE_BUILD_TYPE={{.BUILD_TYPE}}"
             - "-Dystdlib_ROOT={{.INSTALL_PREFIX}}"
           SOURCE_DIR: "{{.ROOT_DIR}}/examples"
-      - task: "utils:cmake:build"
-        vars:
-          BUILD_DIR: "{{.G_EXAMPLES_BUILD_DIR}}/{{.BUILD_TYPE}}"
diff --git a/taskfiles/lint-cpp.yaml b/taskfiles/lint-cpp.yaml
@@ -1,7 +1,14 @@
 version: "3"
 
+includes:
+  build:
+    internal: true
+    taskfile: "build.yaml"
+  examples:
+    internal: true
+    taskfile: "examples.yaml"
+
 vars:
-  G_COMPILE_COMMANDS_DB: "{{.G_BUILD_DIR}}/compile_commands.json"
   G_LINT_CLANG_TIDY_DIR: "{{.G_BUILD_DIR}}/lint-clang-tidy"
 
 tasks:
@@ -10,12 +17,14 @@ tasks:
     cmds:
       - task: "cpp-format-check"
       - task: "cpp-static-check"
+      - task: "cpp-static-check-examples"
 
   cpp-fix:
     desc: "Runs the C++ linters to fix all formatting issues and perform static code analysis. "
     cmds:
       - task: "cpp-format-fix"
       - task: "cpp-static-fix"
+      - task: "cpp-static-fix-examples"
 
   cpp-format-check:
     desc: "Runs the C++ linters that identify formatting issues."
@@ -64,17 +73,47 @@ tasks:
     desc: "Runs the C++ static analyzers. Only checks for warnings and violations."
     deps:
       - "cpp-configs"
+      - task: "build:generate"
+        vars:
+          BUILD_TYPE: "debug"
+          TARGET: "all"
       - ":init"
       - "venv"
     cmds:
       - task: ":utils:cpp-lint:clang-tidy-find"
         vars:
           FLAGS:
             - "--config-file '{{.ROOT_DIR}}/.clang-tidy'"
-            - "-p '{{.G_COMPILE_COMMANDS_DB}}'"
+            - "-p '{{.G_YSTDLIB_BUILD_DIR}}/debug/compile_commands.json'"
           OUTPUT_DIR: "{{.G_LINT_CLANG_TIDY_DIR}}"
           ROOT_PATHS:
-            ref: ".G_LINT_CPP_ROOT_DIRS"
+            - "{{.G_YSTDLIB_SRC_DIR}}"
+          VENV_DIR: "{{.G_LINT_VENV_DIR}}"
+
+  cpp-static-check-examples:
+    # Alias task to `cpp-static-fix-examples` 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-examples"
+    desc: "Runs the C++ static analyzers. Only checks for warnings and violations."
+    deps:
+      - "cpp-configs"
+      - task: "examples:generate"
+        vars:
+          BUILD_TYPE: "debug"
+      - ":init"
+      - "venv"
+    cmds:
+      - task: ":utils:cpp-lint:clang-tidy-find"
+        vars:
+          FLAGS:
+            - "--config-file '{{.ROOT_DIR}}/.clang-tidy'"
+            - "-p '{{.G_EXAMPLES_BUILD_DIR}}/debug/compile_commands.json'"
+          OUTPUT_DIR: "{{.G_LINT_CLANG_TIDY_DIR}}"
+          ROOT_PATHS:
+            - "{{.G_EXAMPLES_SRC_DIR}}"
           VENV_DIR: "{{.G_LINT_VENV_DIR}}"
 
   cpp-configs:
diff --git a/taskfiles/test.yaml b/taskfiles/test.yaml
@@ -4,6 +4,9 @@ includes:
   build:
     internal: true
     taskfile: "build.yaml"
+  utils:
+    internal: true
+    taskfile: "utils.yaml"
 
 tasks:
   test-*-*:
@@ -14,7 +17,7 @@ tasks:
       TARGET: "{{index .MATCH 0}}"
       TEST_TARGET: "unit-test-{{.TARGET}}"
     deps:
-      - task: ":validate-all-args"
+      - task: "utils:validate-all-args"
         vars:
           BUILD_TYPE: "{{.BUILD_TYPE}}"
           TARGET: "{{.TARGET}}"
diff --git a/taskfiles/utils.yaml b/taskfiles/utils.yaml
