feat: Auto-link parameter types to external documentation

- Add type-links.json configuration file mapping PHP types to doc URLs
- Add linkParameterTypes() function to generate-hooks.mjs
- Types like GF_Field_Address, WP_Post, etc. now link to their docs
- Supports both `TypeName` and `\TypeName` formats in parameter tables

Example: `\GF_Field_Address` becomes a link to
https://docs.gravityforms.com/gf_field_address/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Author: zackkatz

scripts/generate-hooks.mjs

@@ -254,6 +254,75 @@ function addTagsToHooks(outputDir) {
   }
 }
 
+/**
+ * Load type links configuration
+ */
+function loadTypeLinks() {
+  const typeLinksPath = path.join(PROJECT_ROOT, 'type-links.json');
+  if (!fs.existsSync(typeLinksPath)) {
+    return {};
+  }
+  try {
+    const config = JSON.parse(fs.readFileSync(typeLinksPath, 'utf8'));
+    return config.types || {};
+  } catch (err) {
+    console.warn('Warning: Could not parse type-links.json:', err.message);
+    return {};
+  }
+}
+
+/**
+ * Link parameter types in hook markdown files to their documentation
+ * Converts `GF_Field_Address` or `\GF_Field_Address` to linked versions
+ */
+function linkParameterTypes(outputDir) {
+  const typeLinks = loadTypeLinks();
+  if (Object.keys(typeLinks).length === 0) return;
+
+  const dirs = ['actions', 'filters'];
+
+  for (const subdir of dirs) {
+    const dirPath = path.join(outputDir, subdir);
+    if (!fs.existsSync(dirPath)) continue;
+
+    const files = fs.readdirSync(dirPath).filter(f => f.endsWith('.md') && f !== 'index.md');
+
+    for (const file of files) {
+      const filePath = path.join(dirPath, file);
+      let content = fs.readFileSync(filePath, 'utf8');
+      let modified = false;
+
+      // Process each type in the configuration
+      for (const [typeName, url] of Object.entries(typeLinks)) {
+        // Match `TypeName` or `\TypeName` in parameter tables
+        // The backticks indicate it's a type in the markdown table
+        const patterns = [
+          new RegExp('`\\\\?' + escapeRegExp(typeName) + '`', 'g'),
+        ];
+
+        for (const pattern of patterns) {
+          if (pattern.test(content)) {
+            // Replace with linked version, preserving the backticks around the link
+            content = content.replace(pattern, `[\`${typeName}\`](${url})`);
+            modified = true;
+          }
+        }
+      }
+
+      if (modified) {
+        fs.writeFileSync(filePath, content);
+      }
+    }
+  }
+}
+
+/**
+ * Escape special regex characters in a string
+ */
+function escapeRegExp(string) {
+  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
 /**
  * Run wp-hooks-documentor for a product
  */
@@ -396,6 +465,9 @@ function generateHooksDocs(product, config, options) {
     // Add tags to hook files based on @since versions
     addTagsToHooks(finalOutputDir);
 
+    // Link parameter types to their documentation
+    linkParameterTypes(finalOutputDir);
+
     // Generate index.md for the product and subdirectories
     generateProductIndex(product, finalOutputDir);
     generateActionsIndex(product, finalOutputDir);

type-links.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$comment": "Maps PHP class/type names to their documentation URLs. Types can include leading backslash or not - both will be matched.",
+  "types": {
+    "GF_Field": "https://docs.gravityforms.com/gf_field/",
+    "GF_Field_Address": "https://docs.gravityforms.com/gf_field_address/",
+    "GF_Field_Calculation": "https://docs.gravityforms.com/gf_field_calculation/",
+    "GF_Field_Captcha": "https://docs.gravityforms.com/gf_field_captcha/",
+    "GF_Field_Checkbox": "https://docs.gravityforms.com/gf_field_checkbox/",
+    "GF_Field_Consent": "https://docs.gravityforms.com/gf_field_consent/",
+    "GF_Field_Date": "https://docs.gravityforms.com/gf_field_date/",
+    "GF_Field_Email": "https://docs.gravityforms.com/gf_field_email/",
+    "GF_Field_FileUpload": "https://docs.gravityforms.com/gf_field_fileupload/",
+    "GF_Field_Hidden": "https://docs.gravityforms.com/gf_field_hidden/",
+    "GF_Field_HTML": "https://docs.gravityforms.com/gf_field_html/",
+    "GF_Field_List": "https://docs.gravityforms.com/gf_field_list/",
+    "GF_Field_MultiSelect": "https://docs.gravityforms.com/gf_field_multiselect/",
+    "GF_Field_Name": "https://docs.gravityforms.com/gf_field_name/",
+    "GF_Field_Number": "https://docs.gravityforms.com/gf_field_number/",
+    "GF_Field_Page": "https://docs.gravityforms.com/gf_field_page/",
+    "GF_Field_Password": "https://docs.gravityforms.com/gf_field_password/",
+    "GF_Field_Phone": "https://docs.gravityforms.com/gf_field_phone/",
+    "GF_Field_Post_Category": "https://docs.gravityforms.com/gf_field_post_category/",
+    "GF_Field_Post_Content": "https://docs.gravityforms.com/gf_field_post_content/",
+    "GF_Field_Post_Custom_Field": "https://docs.gravityforms.com/gf_field_post_custom_field/",
+    "GF_Field_Post_Excerpt": "https://docs.gravityforms.com/gf_field_post_excerpt/",
+    "GF_Field_Post_Image": "https://docs.gravityforms.com/gf_field_post_image/",
+    "GF_Field_Post_Tags": "https://docs.gravityforms.com/gf_field_post_tags/",
+    "GF_Field_Post_Title": "https://docs.gravityforms.com/gf_field_post_title/",
+    "GF_Field_Product": "https://docs.gravityforms.com/gf_field_product/",
+    "GF_Field_Quantity": "https://docs.gravityforms.com/gf_field_quantity/",
+    "GF_Field_Radio": "https://docs.gravityforms.com/gf_field_radio/",
+    "GF_Field_Section": "https://docs.gravityforms.com/gf_field_section/",
+    "GF_Field_Select": "https://docs.gravityforms.com/gf_field_select/",
+    "GF_Field_Shipping": "https://docs.gravityforms.com/gf_field_shipping/",
+    "GF_Field_Signature": "https://docs.gravityforms.com/gf_field_signature/",
+    "GF_Field_Text": "https://docs.gravityforms.com/gf_field_text/",
+    "GF_Field_Textarea": "https://docs.gravityforms.com/gf_field_textarea/",
+    "GF_Field_Time": "https://docs.gravityforms.com/gf_field_time/",
+    "GF_Field_Total": "https://docs.gravityforms.com/gf_field_total/",
+    "GF_Field_Website": "https://docs.gravityforms.com/gf_field_website/",
+    "GF_Entry": "https://docs.gravityforms.com/entry-object/",
+    "GF_Form": "https://docs.gravityforms.com/form-object/",
+    "GFAPI": "https://docs.gravityforms.com/api-functions/",
+    "GFFormsModel": "https://docs.gravityforms.com/gfformsmodel/",
+    "GFCommon": "https://docs.gravityforms.com/gfcommon/",
+    "WP_Post": "https://developer.wordpress.org/reference/classes/wp_post/",
+    "WP_User": "https://developer.wordpress.org/reference/classes/wp_user/",
+    "WP_Query": "https://developer.wordpress.org/reference/classes/wp_query/",
+    "WP_Error": "https://developer.wordpress.org/reference/classes/wp_error/",
+    "WP_REST_Request": "https://developer.wordpress.org/reference/classes/wp_rest_request/",
+    "WP_REST_Response": "https://developer.wordpress.org/reference/classes/wp_rest_response/",
+    "wpdb": "https://developer.wordpress.org/reference/classes/wpdb/"
+  }
+}