@redpanda-data/docs-extensions-and-macros 4.8.0 → 4.9.0

package/tools/property-extractor/helpers/renderPropertyExample.js

@@ -0,0 +1,42 @@
+const handlebars = require('handlebars');
+
+/**
+ * Renders an example for a property based on its format
+ * @param {Object} property - The property object containing example data
+ * @returns {handlebars.SafeString} Formatted example block
+ */
+module.exports = function renderPropertyExample(property) {
+  if (!property.example) {
+    return new handlebars.SafeString('');
+  }
+
+  let exampleContent = '';
+
+  // Handle different example formats
+  if (typeof property.example === 'string') {
+    // Check if it's already a complete AsciiDoc example
+    if (property.example.includes('.Example') || property.example.includes('[,yaml]')) {
+      exampleContent = property.example;
+    } else {
+      // Simple string example - wrap it
+      exampleContent = `.Example\n[,yaml]\n----\n${property.name}: ${property.example}\n----`;
+    }
+  } else if (Array.isArray(property.example)) {
+    // Multiline array example
+    exampleContent = property.example.join('\n');
+  } else if (typeof property.example === 'object' && property.example.title) {
+    // Structured example with title and content
+    exampleContent = `.${property.example.title}\n`;
+    if (property.example.description) {
+      exampleContent += `${property.example.description}\n\n`;
+    }
+    if (property.example.config) {
+      exampleContent += `[,yaml]\n----\n${JSON.stringify(property.example.config, null, 2)}\n----`;
+    }
+  } else {
+    // Fallback: JSON stringify the example
+    exampleContent = `.Example\n[,yaml]\n----\n${property.name}: ${JSON.stringify(property.example, null, 2)}\n----`;
+  }
+
+  return new handlebars.SafeString('\n' + exampleContent + '\n');
+};

package/tools/property-extractor/package-lock.json

@@ -0,0 +1,77 @@
+{
+  "name": "property-extractor",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "dependencies": {
+        "handlebars": "^4.7.8"
+      }
+    },
+    "node_modules/handlebars": {
+      "version": "4.7.8",
+      "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz",
+      "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==",
+      "license": "MIT",
+      "dependencies": {
+        "minimist": "^1.2.5",
+        "neo-async": "^2.6.2",
+        "source-map": "^0.6.1",
+        "wordwrap": "^1.0.0"
+      },
+      "bin": {
+        "handlebars": "bin/handlebars"
+      },
+      "engines": {
+        "node": ">=0.4.7"
+      },
+      "optionalDependencies": {
+        "uglify-js": "^3.1.4"
+      }
+    },
+    "node_modules/minimist": {
+      "version": "1.2.8",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+      "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
+      "license": "MIT",
+      "funding": {
+        "url": "https://github.com/sponsors/ljharb"
+      }
+    },
+    "node_modules/neo-async": {
+      "version": "2.6.2",
+      "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz",
+      "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==",
+      "license": "MIT"
+    },
+    "node_modules/source-map": {
+      "version": "0.6.1",
+      "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+      "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
+      "license": "BSD-3-Clause",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/uglify-js": {
+      "version": "3.19.3",
+      "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.19.3.tgz",
+      "integrity": "sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==",
+      "license": "BSD-2-Clause",
+      "optional": true,
+      "bin": {
+        "uglifyjs": "bin/uglifyjs"
+      },
+      "engines": {
+        "node": ">=0.8.0"
+      }
+    },
+    "node_modules/wordwrap": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
+      "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==",
+      "license": "MIT"
+    }
+  }
+}

package/tools/property-extractor/package.json

@@ -0,0 +1,6 @@
+{
+  "private": true,
+  "dependencies": {
+    "handlebars": "^4.7.8"
+  }
+}

package/tools/property-extractor/parser.py

@@ -14,11 +14,37 @@ HEADER_QUERY = """
 ) @declaration
 """
 
+# Tree-sitter query for extracting C++ property constructor arguments and enterprise values
+#
+# - Enhanced to capture all expression types including:
+#   * call_expression: Handles function calls like model::kafka_audit_logging_topic()
+#   * template_instantiation: Handles template syntax like std::vector<ss::sstring>{...}
+#   * concatenated_string: Handles C++ string concatenation with +
+#   * qualified_identifier: Handles namespaced identifiers like model::partition_autobalancing_mode::continuous
+#   * (_) @argument: Fallback to capture any other expression types
+#
+# This ensures enterprise values are captured in their complete form for proper
+# processing by the process_enterprise_value function.
 SOURCE_QUERY = """
 (field_initializer_list
     (field_initializer
         (field_identifier) @field
-        (argument_list (_) @argument)? @arguments
+        (argument_list 
+            [
+                (call_expression) @argument
+                (initializer_list) @argument
+                (template_instantiation) @argument
+                (concatenated_string) @argument
+                (string_literal) @argument
+                (raw_string_literal) @argument
+                (identifier) @argument
+                (qualified_identifier) @argument
+                (number_literal) @argument
+                (true) @argument
+                (false) @argument
+                (_) @argument
+            ]
+        )? @arguments
     ) @field
 )
 """