Add clang-tidy tasks and task descriptions

Author: Bill-hbrhbr

lint-requirements.txt

@@ -1,4 +1,5 @@
 clang-format>=19.1.6
+clang-tidy>=19.1.0
 colorama>=0.4.6
 gersemi>=0.16.2
 yamllint>=1.35.1

taskfile.yaml

@@ -6,6 +6,9 @@ includes:
 
 vars:
   G_BUILD_DIR: "{{.ROOT_DIR}}/build"
+  G_CMAKE_CACHE: "{{.G_BUILD_DIR}}/CMakeCache.txt"
+  G_COMPILE_COMMANDS_DB: "{{.G_BUILD_DIR}}/compile_commands.json"
+  # Project-specific variables
   G_YSTDLIB_CPP_SRC_DIR: "{{.ROOT_DIR}}/ystdlib"
 
 tasks:
@@ -14,6 +17,17 @@ tasks:
     cmds:
       - "rm -rf '{{.G_BUILD_DIR}}'"
 
+  config-cmake-project:
+    internal: true
+    sources:
+      - "CMakeLists.txt"
+      - "{{.TASKFILE}}"
+    generates:
+      - "{{.G_CMAKE_CACHE}}"
+      - "{{.G_COMPILE_COMMANDS_DB}}"
+    cmds:
+      - "cmake -S '{{.ROOT_DIR}}' -B '{{.G_BUILD_DIR}}'"
+
   init:
     internal: true
     silent: true

taskfiles/lint-cpp.yaml

@@ -2,14 +2,19 @@ version: "3"
 
 tasks:
   cpp-check:
+    desc: "Runs the C++ linters."
     cmds:
       - task: "cpp-format-check"
+      - task: "cpp-static-check"
 
   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"
 
   cpp-format-check:
+    desc: "Runs the C++ linters that identify formatting issues."
     sources: &cpp_format_src_files
       - "{{.ROOT_DIR}}/**/*.cpp"
       - "{{.ROOT_DIR}}/**/*.h"
@@ -30,6 +35,8 @@ tasks:
           VENV_DIR: "{{.G_LINT_VENV_DIR}}"
 
   cpp-format-fix:
+    desc: "Runs the C++ linters and fixes all formatting issues."
+    sources: *cpp_format_src_files
     dir: "{{.ROOT_DIR}}"
     deps:
       - "cpp-configs"
@@ -42,6 +49,37 @@ tasks:
             ref: ".G_LINT_CPP_DIRS"
           VENV_DIR: "{{.G_LINT_VENV_DIR}}"
 
+  cpp-static-check:
+    # Alias task to `cpp-static-fix` 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.
+    desc: "Runs the C++ static analyzers. Only checks for warnings and violations."
+    aliases:
+      - "cpp-static-fix"
+    sources:
+      - "{{.G_CMAKE_CACHE}}"
+      - "{{.G_COMPILE_COMMANDS_DB}}"
+      - "{{.ROOT_DIR}}/**/*.cpp"
+      - "{{.ROOT_DIR}}/**/*.h"
+      - "{{.ROOT_DIR}}/**/*.hpp"
+      - "{{.ROOT_DIR}}/**/*.inc"
+      - "{{.ROOT_DIR}}/.clang-tidy"
+      - "{{.TASKFILE}}"
+    deps:
+      - ":config-cmake-project"
+      - "cpp-configs"
+      - "venv"
+    cmds:
+      - task: ":utils:clang-tidy"
+        vars:
+          FLAGS: >-
+            --config-file "{{.ROOT_DIR}}/.clang-tidy"
+            -p "{{.G_COMPILE_COMMANDS_DB}}"
+          SRC_PATHS:
+            ref: ".G_LINT_CPP_DIRS"
+          VENV_DIR: "{{.G_LINT_VENV_DIR}}"
+
   cpp-configs:
     internal: true
     sources: