feat(errors): add dedicated build error detectors for CMake failures

GaspardKirira · GaspardKirira · commit 3d865b317d0e · 2026-04-07T11:36:43.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -39,7 +39,7 @@
 
 # debug information files
 *.dwo
-build/
+build-*/
 .vscode/
 vix.log
 cmd.md
diff --git a/include/vix/cli/errors/build/BuildErrorDetectors.hpp b/include/vix/cli/errors/build/BuildErrorDetectors.hpp
@@ -0,0 +1,24 @@
+/**
+ *
+ *  @file BuildErrorDetectors.hpp
+ *  @author Gaspard Kirira
+ *
+ *  Copyright 2025, Gaspard Kirira.  All rights reserved.
+ *  https://github.com/vixcpp/vix
+ *  Use of this source code is governed by a MIT license
+ *  that can be found in the License file.
+ *
+ *  Vix.cpp
+ *
+ */
+#ifndef VIX_BUILD_ERROR_DETECTORS_HPP
+#define VIX_BUILD_ERROR_DETECTORS_HPP
+
+#include <string_view>
+
+namespace vix::cli::errors::build
+{
+  bool handleBuildErrors(std::string_view log);
+}
+
+#endif
diff --git a/include/vix/cli/errors/build/CMakeBuildErrors.hpp b/include/vix/cli/errors/build/CMakeBuildErrors.hpp
@@ -0,0 +1,24 @@
+/**
+ *
+ *  @file CMakeBuildErrors.hpp
+ *  @author Gaspard Kirira
+ *
+ *  Copyright 2025, Gaspard Kirira.  All rights reserved.
+ *  https://github.com/vixcpp/vix
+ *  Use of this source code is governed by a MIT license
+ *  that can be found in the License file.
+ *
+ *  Vix.cpp
+ *
+ */
+#ifndef VIX_CMAKE_BUILD_ERRORS_HPP
+#define VIX_CMAKE_BUILD_ERRORS_HPP
+
+#include <string_view>
+
+namespace vix::cli::errors::build
+{
+  bool handleCMakeBuildError(std::string_view log);
+}
+
+#endif
diff --git a/src/ErrorHandler.cpp b/src/ErrorHandler.cpp
@@ -11,15 +11,17 @@
  *  Vix.cpp
  *
  */
-#include "vix/cli/ErrorHandler.hpp"
-
-#include "vix/cli/errors/ClangGccParser.hpp"
-#include "vix/cli/errors/CompilerError.hpp"
-#include "vix/cli/errors/ErrorContext.hpp"
-#include "vix/cli/errors/ErrorPipeline.hpp"
-#include "vix/cli/errors/RawLogDetectors.hpp"
-#include "vix/cli/errors/CodeFrame.hpp"
+#include <vix/cli/ErrorHandler.hpp>
+
+#include <vix/cli/errors/ClangGccParser.hpp>
+#include <vix/cli/errors/CompilerError.hpp>
+#include <vix/cli/errors/ErrorContext.hpp>
+#include <vix/cli/errors/ErrorPipeline.hpp>
+#include <vix/cli/errors/RawLogDetectors.hpp>
+#include <vix/cli/errors/CodeFrame.hpp>
+#include <vix/cli/errors/build/BuildErrorDetectors.hpp>
 #include <vix/utils/Env.hpp>
+
 #include <iostream>
 #include <sstream>
 #include <unordered_map>
@@ -218,6 +220,9 @@ namespace vix::cli
       if (RawLogDetectors::handleLinkerOrSanitizer(cleanedLog, sourceFile, contextMessage))
         return;
 
+      if (vix::cli::errors::build::handleBuildErrors(cleanedLog))
+        return;
+
       error(contextMessage + " (see compiler output below):");
       std::cerr << cleanedLog << "\n";
       return;
diff --git a/src/errors/build/BuildErrorDetectors.cpp b/src/errors/build/BuildErrorDetectors.cpp
@@ -0,0 +1,13 @@
+#include <vix/cli/errors/build/BuildErrorDetectors.hpp>
+#include <vix/cli/errors/build/CMakeBuildErrors.hpp>
+
+namespace vix::cli::errors::build
+{
+  bool handleBuildErrors(std::string_view log)
+  {
+    if (handleCMakeBuildError(log))
+      return true;
+
+    return false;
+  }
+}
diff --git a/src/errors/build/CMakeBuildErrors.cpp b/src/errors/build/CMakeBuildErrors.cpp
@@ -0,0 +1,45 @@
+/**
+ *
+ *  @file CMakeBuildErrors.hpp
+ *  @author Gaspard Kirira
+ *
+ *  Copyright 2025, Gaspard Kirira.  All rights reserved.
+ *  https://github.com/vixcpp/vix
+ *  Use of this source code is governed by a MIT license
+ *  that can be found in the License file.
+ *
+ *  Vix.cpp
+ *
+ */
+#include <vix/cli/errors/build/CMakeBuildErrors.hpp>
+
+#include <iostream>
+#include <string>
+
+#include <vix/cli/Style.hpp>
+
+using namespace vix::cli::style;
+
+namespace vix::cli::errors::build
+{
+  bool handleCMakeBuildError(std::string_view log)
+  {
+    const bool cacheDirMismatch =
+        log.find("The current CMakeCache.txt directory") != std::string_view::npos;
+
+    const bool sourceMismatch =
+        log.find("does not match the source") != std::string_view::npos &&
+        log.find("used to generate cache") != std::string_view::npos;
+
+    if (!cacheDirMismatch && !sourceMismatch)
+      return false;
+
+    error("CMake configure failed: stale build cache detected.");
+    hint("Your build directory was generated from another project location.");
+    hint("Remove the old build directory and reconfigure.");
+    hint("Recommended: vix build --clean");
+    hint("Manual fix: rm -rf build-ninja build-dev build-release");
+
+    return true;
+  }
+}
