@redpanda-data/docs-extensions-and-macros 4.6.7 → 4.6.9

package/bin/doc-tools.js

@@ -234,20 +234,83 @@ For more details, visit: https://github.com/norwoodj/helm-docs
 /**
  * Ensures all dependencies required for generating property documentation are installed.
  *
- * Checks for the presence of `make`, Python 3.10 or newer, and at least one C++ compiler (`gcc` or `clang`). Exits the process with an error message if any dependency is missing.
+ * Checks for the presence of `make`, Python 3.10 or newer, C++ compiler, and C++ standard library headers.
+ * Exits the process with an error message if any dependency is missing.
  */
 function verifyPropertyDependencies() {
   requireCmd('make', 'Your OS package manager');
   requirePython();
+
+  // Check for C++ compiler
+  let cppCompiler = null;
   try {
     execSync('gcc --version', { stdio: 'ignore' });
+    cppCompiler = 'gcc';
   } catch {
     try {
       execSync('clang --version', { stdio: 'ignore' });
+      cppCompiler = 'clang';
     } catch {
-      fail('A C++ compiler (gcc or clang) is required.');
+      fail(`A C++ compiler (gcc or clang) is required for tree-sitter compilation.
+
+On macOS, install Xcode Command Line Tools:
+  xcode-select --install
+
+On Linux (Ubuntu/Debian):
+  sudo apt update && sudo apt install build-essential
+
+On Linux (CentOS/RHEL/Fedora):
+  sudo yum groupinstall "Development Tools"
+  # or on newer versions:
+  sudo dnf groupinstall "Development Tools"
+
+After installation, verify with:
+  gcc --version
+  # or
+  clang --version`);
     }
   }
+
+  // Check for C++ standard library headers (critical for tree-sitter compilation)
+  let tempDir = null;
+  try {
+    const testProgram = '#include <functional>\nint main() { return 0; }';
+    tempDir = require('fs').mkdtempSync(require('path').join(require('os').tmpdir(), 'cpp-test-'));
+    const tempFile = require('path').join(tempDir, 'test.cpp');
+    require('fs').writeFileSync(tempFile, testProgram);
+
+    const compileCmd = cppCompiler === 'gcc' ? 'gcc' : 'clang++';
+    execSync(`${compileCmd} -x c++ -fsyntax-only "${tempFile}"`, { stdio: 'ignore' });
+    require('fs').rmSync(tempDir, { recursive: true, force: true });
+  } catch {
+    // Clean up temp directory if it was created
+    if (tempDir) {
+      try {
+        require('fs').rmSync(tempDir, { recursive: true, force: true });
+      } catch {
+        // Ignore cleanup errors
+      }
+    }
+    fail(`C++ standard library headers are missing or incomplete.
+
+This error typically means:
+1. No C++ compiler is installed, OR
+2. Xcode Command Line Tools are missing/incomplete
+
+To fix this on macOS:
+1. Install Xcode Command Line Tools:
+   xcode-select --install
+
+2. If already installed, reset the developer path:
+   sudo xcode-select --reset
+
+3. For Xcode users, ensure correct path:
+   sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
+
+4. Verify the fix:
+   echo '#include <functional>' | \${cppCompiler || 'clang++'} -x c++ -fsyntax-only -
+`);
+  }
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "4.6.7",
+  "version": "4.6.9",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",

package/tools/property-extractor/Makefile

@@ -77,6 +77,10 @@ treesitter:
 	@if [ ! -d "$(TREESITTER_DIR)" ]; then \
 	  git clone https://github.com/tree-sitter/tree-sitter-cpp.git "$(TREESITTER_DIR)"; \
 	fi
+	@echo "🔄 Ensuring tree-sitter-cpp is at compatible version v0.20.5…"
+	@cd "$(TREESITTER_DIR)" && \
+	  git fetch --tags -q && \
+	  git checkout -q v0.20.5
 	@echo "🔧 Generating parser in $(TREESITTER_DIR)…"
 	@cd "$(TREESITTER_DIR)" && npm install --silent && $(TREE_SITTER) generate