GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — sim/scripts/generate-block-docs.ts at main · aesgitrep/sim Expand file tree/ Copy pathgenerate-block-docs.tsMore file actions executable file ·1299 lines (1090 loc) · 44.4 KB / Copy pathgenerate-block-docs.tsFile metadata and controlsexecutable file ·1299 lines (1090 loc) · 44.4 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 #!/usr/bin/env ts-node import fs from 'fs' import path from 'path' import { fileURLToPath } from 'url' import { glob } from 'glob' console.log('Starting documentation generator...') // Define directory paths const __filename = fileURLToPath(import.meta.url) const __dirname = path.dirname(__filename) const rootDir = path.resolve(__dirname, '..') // Paths configuration const BLOCKS_PATH = path.join(rootDir, 'apps/sim/blocks/blocks') const DOCS_OUTPUT_PATH = path.join(rootDir, 'apps/docs/content/docs/tools') const ICONS_PATH = path.join(rootDir, 'apps/sim/components/icons.tsx') // Make sure the output directory exists if (!fs.existsSync(DOCS_OUTPUT_PATH)) { fs.mkdirSync(DOCS_OUTPUT_PATH, { recursive: true }) } // Basic interface for BlockConfig to avoid import issues interface BlockConfig { type: string name: string description: string longDescription?: string category: string bgColor?: string outputs?: Record<string, any> tools?: { access?: string[] } [key: string]: any } // Function to extract SVG icons from icons.tsx file function extractIcons(): Record<string, string> { try { const iconsContent = fs.readFileSync(ICONS_PATH, 'utf-8') const icons: Record<string, string> = {} // Match both function declaration and arrow function export patterns const functionDeclarationRegex = /export\s+function\s+(\w+Icon)\s*\([^)]*\)\s*{[\s\S]*?return\s*\(\s*<svg[\s\S]*?<\/svg>\s*\)/g const arrowFunctionRegex = /export\s+const\s+(\w+Icon)\s*=\s*\([^)]*\)\s*=>\s*(\(?\s*<svg[\s\S]*?<\/svg>\s*\)?)/g // Extract function declaration style icons const functionMatches = Array.from(iconsContent.matchAll(functionDeclarationRegex)) for (const match of functionMatches) { const iconName = match[1] const svgMatch = match[0].match(/<svg[\s\S]*?<\/svg>/) if (iconName && svgMatch) { // Clean the SVG to remove {...props} and standardize size let svgContent = svgMatch[0] svgContent = svgContent.replace(/{\.\.\.props}/g, '') svgContent = svgContent.replace(/{\.\.\.(props|rest)}/g, '') // Remove any existing width/height attributes to let CSS handle sizing svgContent = svgContent.replace(/width=["'][^"']*["']/g, '') svgContent = svgContent.replace(/height=["'][^"']*["']/g, '') // Add className for styling svgContent = svgContent.replace(/<svg/, '<svg className="block-icon"') icons[iconName] = svgContent } } // Extract arrow function style icons const arrowMatches = Array.from(iconsContent.matchAll(arrowFunctionRegex)) for (const match of arrowMatches) { const iconName = match[1] const svgContent = match[2] const svgMatch = svgContent.match(/<svg[\s\S]*?<\/svg>/) if (iconName && svgMatch) { // Clean the SVG to remove {...props} and standardize size let cleanedSvg = svgMatch[0] cleanedSvg = cleanedSvg.replace(/{\.\.\.props}/g, '') cleanedSvg = cleanedSvg.replace(/{\.\.\.(props|rest)}/g, '') // Remove any existing width/height attributes to let CSS handle sizing cleanedSvg = cleanedSvg.replace(/width=["'][^"']*["']/g, '') cleanedSvg = cleanedSvg.replace(/height=["'][^"']*["']/g, '') // Add className for styling cleanedSvg = cleanedSvg.replace(/<svg/, '<svg className="block-icon"') icons[iconName] = cleanedSvg } } return icons } catch (error) { console.error('Error extracting icons:', error) return {} } } // Function to extract block configuration from file content function extractBlockConfig(fileContent: string): BlockConfig | null { try { // Extract the block name from export statement const exportMatch = fileContent.match(/export\s+const\s+(\w+)Block\s*:/) if (!exportMatch) { console.warn('No block export found in file') return null } const blockName = exportMatch[1] const blockType = findBlockType(fileContent, blockName) // Extract individual properties with more robust regex const name = extractStringProperty(fileContent, 'name') || `${blockName} Block` const description = extractStringProperty(fileContent, 'description') || '' const longDescription = extractStringProperty(fileContent, 'longDescription') || '' const category = extractStringProperty(fileContent, 'category') || 'misc' const bgColor = extractStringProperty(fileContent, 'bgColor') || '#F5F5F5' const iconName = extractIconName(fileContent) || '' // Extract outputs object with better handling const outputs = extractOutputs(fileContent) // Extract tools access array const toolsAccess = extractToolsAccess(fileContent) return { type: blockType || blockName.toLowerCase(), name, description, longDescription, category, bgColor, iconName, outputs, tools: { access: toolsAccess, }, } } catch (error) { console.error('Error extracting block configuration:', error) return null } } // Helper function to find the block type function findBlockType(content: string, blockName: string): string { // Try to find the type within the main block export // Look for the pattern: export const [BlockName]Block: BlockConfig = { ... type: 'value' ... } const blockExportRegex = new RegExp( `export\\s+const\\s+${blockName}Block\\s*:[^{]*{[\\s\\S]*?type\\s*:\\s*['"]([^'"]+)['"][\\s\\S]*?}`, 'i' ) const blockExportMatch = content.match(blockExportRegex) if (blockExportMatch) return blockExportMatch[1] // Fallback: try to find type within a block config object that comes after the export const exportMatch = content.match(new RegExp(`export\\s+const\\s+${blockName}Block\\s*:`)) if (exportMatch) { // Find the content after the export statement const afterExport = content.substring(exportMatch.index! + exportMatch[0].length) // Look for the first opening brace and then find type within that block const blockStartMatch = afterExport.match(/{/) if (blockStartMatch) { const blockStart = blockStartMatch.index! // Find the matching closing brace by counting braces let braceCount = 1 let blockEnd = blockStart + 1 while (blockEnd < afterExport.length && braceCount > 0) { if (afterExport[blockEnd] === '{') braceCount++ else if (afterExport[blockEnd] === '}') braceCount-- blockEnd++ } // Extract the block content and look for type const blockContent = afterExport.substring(blockStart, blockEnd) const typeMatch = blockContent.match(/type\s*:\s*['"]([^'"]+)['"]/) if (typeMatch) return typeMatch[1] } } // Convert CamelCase to snake_case as fallback return blockName .replace(/([A-Z])/g, '_$1') .toLowerCase() .replace(/^_/, '') } // Helper to extract a string property from content function extractStringProperty(content: string, propName: string): string | null { // Try single quotes first - more permissive approach const singleQuoteMatch = content.match(new RegExp(`${propName}\\s*:\\s*'(.*?)'`, 'm')) if (singleQuoteMatch) return singleQuoteMatch[1] // Try double quotes const doubleQuoteMatch = content.match(new RegExp(`${propName}\\s*:\\s*"(.*?)"`, 'm')) if (doubleQuoteMatch) return doubleQuoteMatch[1] // Try to match multi-line string with template literals const templateMatch = content.match(new RegExp(`${propName}\\s*:\\s*\`([^\`]+)\``, 's')) if (templateMatch) { let templateContent = templateMatch[1] // Handle template literals with expressions by replacing them with reasonable defaults // This is a simple approach - we'll replace common variable references with sensible defaults templateContent = templateContent.replace( /\$\{[^}]*shouldEnableURLInput[^}]*\?[^:]*:[^}]*\}/g, 'Upload files directly. ' ) templateContent = templateContent.replace(/\$\{[^}]*shouldEnableURLInput[^}]*\}/g, 'false') // Remove any remaining template expressions that we can't safely evaluate templateContent = templateContent.replace(/\$\{[^}]+\}/g, '') // Clean up any extra whitespace templateContent = templateContent.replace(/\s+/g, ' ').trim() return templateContent } return null } // Helper to extract icon name from content function extractIconName(content: string): string | null { const iconMatch = content.match(/icon\s*:\s*(\w+Icon)/) return iconMatch ? iconMatch[1] : null } // Updated function to extract outputs with a simpler and more reliable approach function extractOutputs(content: string): Record<string, any> { // Look for the outputs section using balanced brace matching const outputsStart = content.search(/outputs\s*:\s*{/) if (outputsStart === -1) return {} // Find the opening brace position const openBracePos = content.indexOf('{', outputsStart) if (openBracePos === -1) return {} // Use balanced brace counting to find the complete outputs section let braceCount = 1 let pos = openBracePos + 1 while (pos < content.length && braceCount > 0) { if (content[pos] === '{') { braceCount++ } else if (content[pos] === '}') { braceCount-- } pos++ } if (braceCount === 0) { const outputsContent = content.substring(openBracePos + 1, pos - 1).trim() const outputs: Record<string, any> = {} // First try to handle the new object format: fieldName: { type: 'type', description: 'desc' } // Use a more robust approach to extract field definitions const fieldRegex = /(\w+)\s*:\s*{/g let match const fieldPositions: Array<{ name: string; start: number }> = [] // Find all field starting positions while ((match = fieldRegex.exec(outputsContent)) !== null) { fieldPositions.push({ name: match[1], start: match.index + match[0].length - 1, // Position of the opening brace }) } // Extract each field's content by finding balanced braces fieldPositions.forEach((field) => { const startPos = field.start let braceCount = 1 let endPos = startPos + 1 // Find the matching closing brace while (endPos < outputsContent.length && braceCount > 0) { if (outputsContent[endPos] === '{') { braceCount++ } else if (outputsContent[endPos] === '}') { braceCount-- } endPos++ } if (braceCount === 0) { // Extract the content between braces const fieldContent = outputsContent.substring(startPos + 1, endPos - 1).trim() // Extract type and description from the object const typeMatch = fieldContent.match(/type\s*:\s*['"](.*?)['"]/) const descriptionMatch = fieldContent.match(/description\s*:\s*['"](.*?)['"]/) if (typeMatch) { outputs[field.name] = { type: typeMatch[1], description: descriptionMatch ? descriptionMatch[1] : `${field.name} output from the block`, } } } }) // If we found object fields, return them if (Object.keys(outputs).length > 0) { return outputs } // Fallback: try to handle the old flat format: fieldName: 'type' const flatFieldMatches = outputsContent.match(/(\w+)\s*:\s*['"](.*?)['"]/g) if (flatFieldMatches && flatFieldMatches.length > 0) { flatFieldMatches.forEach((fieldMatch) => { const fieldParts = fieldMatch.match(/(\w+)\s*:\s*['"](.*?)['"]/) if (fieldParts) { const fieldName = fieldParts[1] const fieldType = fieldParts[2] outputs[fieldName] = { type: fieldType, description: `${fieldName} output from the block`, } } }) // If we found flat fields, return them if (Object.keys(outputs).length > 0) { return outputs } } } return {} } // Helper to extract tools access array function extractToolsAccess(content: string): string[] { const accessMatch = content.match(/access\s*:\s*\[\s*((?:['"][^'"]+['"](?:\s*,\s*)?)+)\s*\]/) if (!accessMatch) return [] const accessContent = accessMatch[1] const tools: string[] = [] const toolMatches = accessContent.match(/['"]([^'"]+)['"]/g) if (toolMatches) { toolMatches.forEach((toolText) => { const match = toolText.match(/['"]([^'"]+)['"]/) if (match) { tools.push(match[1]) } }) } return tools } // Function to extract tool information from file content function extractToolInfo( toolName: string, fileContent: string ): { description: string params: Array<{ name: string; type: string; required: boolean; description: string }> outputs: Record<string, any> } | null { try { // Extract tool config section - Match params until the next top-level property const toolConfigRegex = /params\s*:\s*{([\s\S]*?)},?\s*(?:outputs|oauth|request|directExecution|postProcess|transformResponse)/ const toolConfigMatch = fileContent.match(toolConfigRegex) // Extract description const descriptionRegex = /description\s*:\s*['"](.*?)['"].*/ const descriptionMatch = fileContent.match(descriptionRegex) const description = descriptionMatch ? descriptionMatch[1] : 'No description available' // Parse parameters const params: Array<{ name: string; type: string; required: boolean; description: string }> = [] if (toolConfigMatch) { const paramsContent = toolConfigMatch[1] // More robust approach to extract parameters with balanced brace matching // Extract each parameter block completely const paramBlocksRegex = /(\w+)\s*:\s*{/g let paramMatch const paramPositions: Array<{ name: string; start: number; content: string }> = [] while ((paramMatch = paramBlocksRegex.exec(paramsContent)) !== null) { const paramName = paramMatch[1] const startPos = paramMatch.index + paramMatch[0].length - 1 // Position of opening brace // Find matching closing brace using balanced counting let braceCount = 1 let endPos = startPos + 1 while (endPos < paramsContent.length && braceCount > 0) { if (paramsContent[endPos] === '{') { braceCount++ } else if (paramsContent[endPos] === '}') { braceCount-- } endPos++ } if (braceCount === 0) { const paramBlock = paramsContent.substring(startPos + 1, endPos - 1).trim() paramPositions.push({ name: paramName, start: startPos, content: paramBlock }) } } for (const param of paramPositions) { const paramName = param.name const paramBlock = param.content // Skip the accessToken parameter as it's handled automatically by the OAuth flow // Also skip any params parameter which isn't a real input if (paramName === 'accessToken' || paramName === 'params' || paramName === 'tools') { continue } // Extract param details with more robust patterns const typeMatch = paramBlock.match(/type\s*:\s*['"]([^'"]+)['"]/) const requiredMatch = paramBlock.match(/required\s*:\s*(true|false)/) // More careful extraction of description with handling for multiline descriptions let descriptionMatch = paramBlock.match(/description\s*:\s*'(.*?)'(?=\s*[,}])/s) if (!descriptionMatch) { descriptionMatch = paramBlock.match(/description\s*:\s*"(.*?)"(?=\s*[,}])/s) } if (!descriptionMatch) { // Try for template literals if the description uses backticks descriptionMatch = paramBlock.match(/description\s*:\s*`([^`]+)`/s) } if (!descriptionMatch) { // Handle multi-line descriptions without ending quote on same line descriptionMatch = paramBlock.match( /description\s*:\s*['"]([^'"]*(?:\n[^'"]*)*?)['"](?=\s*[,}])/s ) } params.push({ name: paramName, type: typeMatch ? typeMatch[1] : 'string', required: requiredMatch ? requiredMatch[1] === 'true' : false, description: descriptionMatch ? descriptionMatch[1] : 'No description', }) } } // First priority: Extract outputs from the new outputs field in ToolConfig let outputs: Record<string, any> = {} const outputsFieldRegex = /outputs\s*:\s*{([\s\S]*?)}\s*,?\s*(?:oauth|params|request|directExecution|postProcess|transformResponse|$|\})/ const outputsFieldMatch = fileContent.match(outputsFieldRegex) if (outputsFieldMatch) { const outputsContent = outputsFieldMatch[1] outputs = parseToolOutputsField(outputsContent) console.log(`Found tool outputs field for ${toolName}:`, Object.keys(outputs)) } return { description, params, outputs, } } catch (error) { console.error(`Error extracting info for tool ${toolName}:`, error) return null } } // Helper function to recursively format output structure for documentation function formatOutputStructure(outputs: Record<string, any>, indentLevel = 0): string { let result = '' for (const [key, output] of Object.entries(outputs)) { let type = 'unknown' let description = `${key} output from the tool` if (typeof output === 'object' && output !== null) { if (output.type) { type = output.type } if (output.description) { description = output.description } } // Escape special characters in the description const escapedDescription = description .replace(/\|/g, '\\|') .replace(/\{/g, '\\{') .replace(/\}/g, '\\}') .replace(/\(/g, '\\(') .replace(/\)/g, '\\)') .replace(/\[/g, '\\[') .replace(/\]/g, '\\]') .replace(/</g, '<') .replace(/>/g, '>') // Create prefix based on nesting level with visual hierarchy let prefix = '' if (indentLevel === 1) { prefix = '↳ ' } else if (indentLevel >= 2) { // For deeper nesting (like array items), use indented arrows prefix = ' ↳ ' } // For arrays, expand nested items if (typeof output === 'object' && output !== null && output.type === 'array') { result += `| ${prefix}\`${key}\` | ${type} | ${escapedDescription} |\n` // Handle array items with properties (nested TWO more levels to show it's inside the array) if (output.items?.properties) { // Create a visual separator to show these are array item properties const arrayItemsResult = formatOutputStructure(output.items.properties, indentLevel + 2) result += arrayItemsResult } } // For objects, expand properties else if ( typeof output === 'object' && output !== null && output.properties && (output.type === 'object' || output.type === 'json') ) { result += `| ${prefix}\`${key}\` | ${type} | ${escapedDescription} |\n` const nestedResult = formatOutputStructure(output.properties, indentLevel + 1) result += nestedResult } // For simple types, show with prefix if nested else { result += `| ${prefix}\`${key}\` | ${type} | ${escapedDescription} |\n` } } return result } // New function to parse the structured outputs field from ToolConfig function parseToolOutputsField(outputsContent: string): Record<string, any> { const outputs: Record<string, any> = {} // Calculate nesting levels for all braces first const braces: Array<{ type: 'open' | 'close'; pos: number; level: number }> = [] for (let i = 0; i < outputsContent.length; i++) { if (outputsContent[i] === '{') { braces.push({ type: 'open', pos: i, level: 0 }) } else if (outputsContent[i] === '}') { braces.push({ type: 'close', pos: i, level: 0 }) } } // Calculate actual nesting levels let currentLevel = 0 for (const brace of braces) { if (brace.type === 'open') { brace.level = currentLevel currentLevel++ } else { currentLevel-- brace.level = currentLevel } } // Find field definitions and their nesting levels const fieldStartRegex = /(\w+)\s*:\s*{/g let match const fieldPositions: Array<{ name: string; start: number; end: number; level: number }> = [] while ((match = fieldStartRegex.exec(outputsContent)) !== null) { const fieldName = match[1] const bracePos = match.index + match[0].length - 1 // Find the corresponding opening brace to determine nesting level const openBrace = braces.find((b) => b.type === 'open' && b.pos === bracePos) if (openBrace) { // Find the matching closing brace let braceCount = 1 let endPos = bracePos + 1 while (endPos < outputsContent.length && braceCount > 0) { if (outputsContent[endPos] === '{') { braceCount++ } else if (outputsContent[endPos] === '}') { braceCount-- } endPos++ } fieldPositions.push({ name: fieldName, start: bracePos, end: endPos, level: openBrace.level, }) } } // Only process level 0 fields (top-level outputs) const topLevelFields = fieldPositions.filter((f) => f.level === 0) topLevelFields.forEach((field) => { const fieldContent = outputsContent.substring(field.start + 1, field.end - 1).trim() // Parse the field content const parsedField = parseFieldContent(fieldContent) if (parsedField) { outputs[field.name] = parsedField } }) return outputs } // Helper function to parse individual field content with support for nested structures function parseFieldContent(fieldContent: string): any { // Extract type and description const typeMatch = fieldContent.match(/type\s*:\s*['"]([^'"]+)['"]/) const descMatch = fieldContent.match(/description\s*:\s*['"`]([^'"`\n]+)['"`]/) if (!typeMatch) return null const fieldType = typeMatch[1] const description = descMatch ? descMatch[1] : '' const result: any = { type: fieldType, description: description, } // Check for properties (nested objects) - only for object types, not arrays if (fieldType === 'object' || fieldType === 'json') { const propertiesRegex = /properties\s*:\s*{/ const propertiesStart = fieldContent.search(propertiesRegex) if (propertiesStart !== -1) { const braceStart = fieldContent.indexOf('{', propertiesStart) let braceCount = 1 let braceEnd = braceStart + 1 // Find matching closing brace while (braceEnd < fieldContent.length && braceCount > 0) { if (fieldContent[braceEnd] === '{') braceCount++ else if (fieldContent[braceEnd] === '}') braceCount-- braceEnd++ } if (braceCount === 0) { const propertiesContent = fieldContent.substring(braceStart + 1, braceEnd - 1).trim() result.properties = parsePropertiesContent(propertiesContent) } } } // Check for items (array items) - ensure balanced brace matching const itemsRegex = /items\s*:\s*{/ const itemsStart = fieldContent.search(itemsRegex) if (itemsStart !== -1) { const braceStart = fieldContent.indexOf('{', itemsStart) let braceCount = 1 let braceEnd = braceStart + 1 // Find matching closing brace while (braceEnd < fieldContent.length && braceCount > 0) { if (fieldContent[braceEnd] === '{') braceCount++ else if (fieldContent[braceEnd] === '}') braceCount-- braceEnd++ } if (braceCount === 0) { const itemsContent = fieldContent.substring(braceStart + 1, braceEnd - 1).trim() const itemsType = itemsContent.match(/type\s*:\s*['"]([^'"]+)['"]/) // Only look for description before any properties block to avoid picking up nested property descriptions const propertiesStart = itemsContent.search(/properties\s*:\s*{/) const searchContent = propertiesStart >= 0 ? itemsContent.substring(0, propertiesStart) : itemsContent const itemsDesc = searchContent.match(/description\s*:\s*['"`]([^'"`\n]+)['"`]/) result.items = { type: itemsType ? itemsType[1] : 'object', description: itemsDesc ? itemsDesc[1] : '', } // Check if items have properties const itemsPropertiesRegex = /properties\s*:\s*{/ const itemsPropsStart = itemsContent.search(itemsPropertiesRegex) if (itemsPropsStart !== -1) { const propsBraceStart = itemsContent.indexOf('{', itemsPropsStart) let propsBraceCount = 1 let propsBraceEnd = propsBraceStart + 1 while (propsBraceEnd < itemsContent.length && propsBraceCount > 0) { if (itemsContent[propsBraceEnd] === '{') propsBraceCount++ else if (itemsContent[propsBraceEnd] === '}') propsBraceCount-- propsBraceEnd++ } if (propsBraceCount === 0) { const itemsPropsContent = itemsContent .substring(propsBraceStart + 1, propsBraceEnd - 1) .trim() result.items.properties = parsePropertiesContent(itemsPropsContent) } } } } return result } // Helper function to parse properties content recursively function parsePropertiesContent(propertiesContent: string): Record<string, any> { const properties: Record<string, any> = {} // Find property definitions using balanced brace matching, but exclude type-only definitions const propStartRegex = /(\w+)\s*:\s*{/g let match const propPositions: Array<{ name: string; start: number; content: string }> = [] while ((match = propStartRegex.exec(propertiesContent)) !== null) { const propName = match[1] // Skip structural keywords that should never be treated as property names if (propName === 'items' || propName === 'properties') { continue } const startPos = match.index + match[0].length - 1 // Position of opening brace // Find the matching closing brace let braceCount = 1 let endPos = startPos + 1 while (endPos < propertiesContent.length && braceCount > 0) { if (propertiesContent[endPos] === '{') { braceCount++ } else if (propertiesContent[endPos] === '}') { braceCount-- } endPos++ } if (braceCount === 0) { const propContent = propertiesContent.substring(startPos + 1, endPos - 1).trim() // Skip if this is just a type definition (contains only 'type' field) rather than a real property // This happens with array items definitions like: items: { type: 'string' } // More precise check: only skip if it ONLY has 'type' and nothing else meaningful const hasDescription = /description\s*:\s*/.test(propContent) const hasProperties = /properties\s*:\s*{/.test(propContent) const hasItems = /items\s*:\s*{/.test(propContent) const isTypeOnly = !hasDescription && !hasProperties && !hasItems && /^type\s*:\s*['"].*?['"]\s*,?\s*$/.test(propContent) if (!isTypeOnly) { propPositions.push({ name: propName, start: startPos, content: propContent, }) } } } // Process the actual property definitions propPositions.forEach((prop) => { const parsedProp = parseFieldContent(prop.content) if (parsedProp) { properties[prop.name] = parsedProp } }) return properties } // Find and extract information about a tool async function getToolInfo(toolName: string): Promise<{ description: string params: Array<{ name: string; type: string; required: boolean; description: string }> outputs: Record<string, any> } | null> { try { // Split the tool name into parts const parts = toolName.split('_') // Try to find the correct split point by checking if directories exist let toolPrefix = '' let toolSuffix = '' // Start from the longest possible prefix and work backwards for (let i = parts.length - 1; i >= 1; i--) { const possiblePrefix = parts.slice(0, i).join('_') const possibleSuffix = parts.slice(i).join('_') // Check if a directory exists for this prefix const toolDirPath = path.join(rootDir, `apps/sim/tools/${possiblePrefix}`) if (fs.existsSync(toolDirPath) && fs.statSync(toolDirPath).isDirectory()) { toolPrefix = possiblePrefix toolSuffix = possibleSuffix break } } // If no directory was found, fall back to single-part prefix if (!toolPrefix) { toolPrefix = parts[0] toolSuffix = parts.slice(1).join('_') } // Simplify the file search strategy const possibleLocations = [] // Most common pattern: suffix.ts file in the prefix directory possibleLocations.push(path.join(rootDir, `apps/sim/tools/${toolPrefix}/${toolSuffix}.ts`)) // Try camelCase version of suffix const camelCaseSuffix = toolSuffix .split('_') .map((part, i) => (i === 0 ? part : part.charAt(0).toUpperCase() + part.slice(1))) .join('') possibleLocations.push(path.join(rootDir, `apps/sim/tools/${toolPrefix}/${camelCaseSuffix}.ts`)) // Also check the index.ts file in the tool directory possibleLocations.push(path.join(rootDir, `apps/sim/tools/${toolPrefix}/index.ts`)) // Try to find the tool definition file let toolFileContent = '' for (const location of possibleLocations) { if (fs.existsSync(location)) { toolFileContent = fs.readFileSync(location, 'utf-8') break } } if (!toolFileContent) { console.warn(`Could not find definition for tool: ${toolName}`) return null } // Extract tool information from the file return extractToolInfo(toolName, toolFileContent) } catch (error) { console.error(`Error getting info for tool ${toolName}:`, error) return null } } // Function to extract content between manual content markers function extractManualContent(existingContent: string): Record<string, string> { const manualSections: Record<string, string> = {} // Improved regex to better handle MDX comments const manualContentRegex = /\{\/\*\s*MANUAL-CONTENT-START:(\w+)\s*\*\/\}([\s\S]*?)\{\/\*\s*MANUAL-CONTENT-END\s*\*\/\}/g let match while ((match = manualContentRegex.exec(existingContent)) !== null) { const sectionName = match[1] const content = match[2].trim() manualSections[sectionName] = content console.log(`Found manual content for section: ${sectionName}`) } return manualSections } // Function to merge generated markdown with manual content function mergeWithManualContent( generatedMarkdown: string, existingContent: string | null, manualSections: Record<string, string> ): string { if (!existingContent || Object.keys(manualSections).length === 0) { return generatedMarkdown } console.log('Merging manual content with generated markdown') // Log what we found for debugging console.log(`Found ${Object.keys(manualSections).length} manual sections`) Object.keys(manualSections).forEach((section) => { console.log(` - ${section}: ${manualSections[section].substring(0, 20)}...`) }) // Replace placeholders in generated markdown with manual content let mergedContent = generatedMarkdown // Add manual content for each section we found Object.entries(manualSections).forEach(([sectionName, content]) => { // Define insertion points for different section types with improved patterns const insertionPoints: Record<string, { regex: RegExp }> = { intro: { regex: /<BlockInfoCard[\s\S]*?<\/svg>`}\s*\/>/, }, usage: { regex: /## Usage Instructions/, }, outputs: { regex: /## Outputs/, }, notes: { regex: /## Notes/, }, } // Find the appropriate insertion point const insertionPoint = insertionPoints[sectionName] if (insertionPoint) { // Use regex to find the insertion point const match = mergedContent.match(insertionPoint.regex) if (match && match.index !== undefined) { // Insert after the matched content const insertPosition = match.index + match[0].length console.log(`Inserting ${sectionName} content after position ${insertPosition}`) mergedContent = `${mergedContent.slice(0, insertPosition)}\n\n{/* MANUAL-CONTENT-START:${sectionName} */}\n${content}\n{/* MANUAL-CONTENT-END */}\n${mergedContent.slice(insertPosition)}` } else { console.log( `Could not find insertion point for ${sectionName}, regex pattern: ${insertionPoint.regex}` ) } } else { console.log(`No insertion point defined for section ${sectionName}`) } }) return mergedContent } // Function to generate documentation for a block async function generateBlockDoc(blockPath: string, icons: Record<string, string>) { try { // Extract the block name from the file path const blockFileName = path.basename(blockPath, '.ts') if (blockFileName.endsWith('.test')) { return // Skip test files } // Read the file content const fileContent = fs.readFileSync(blockPath, 'utf-8') // Extract block configuration from the file content const blockConfig = extractBlockConfig(fileContent) if (!blockConfig || !blockConfig.type) { console.warn(`Skipping ${blockFileName} - not a valid block config`) return } // Skip blocks with category 'blocks' (except memory type), and skip specific blocks if ( (blockConfig.category === 'blocks' && blockConfig.type !== 'memory' && blockConfig.type !== 'knowledge') || blockConfig.type === 'evaluator' || blockConfig.type === 'number' ) { return } // Output file path const outputFilePath = path.join(DOCS_OUTPUT_PATH, `${blockConfig.type}.mdx`) // IMPORTANT: Check if file already exists and read its content FIRST let existingContent: string | null = null if (fs.existsSync(outputFilePath)) { existingContent = fs.readFileSync(outputFilePath, 'utf-8') console.log(`Existing file found for ${blockConfig.type}.mdx, checking for manual content...`) } // Extract manual content from existing file before generating new content const manualSections = existingContent ? extractManualContent(existingContent) : {} // Create the markdown content - now async const markdown = await generateMarkdownForBlock(blockConfig, icons) // Merge with manual content if we found any let finalContent = markdown if (Object.keys(manualSections).length > 0) { console.log(`Found manual content in ${blockConfig.type}.mdx, merging...`) finalContent = mergeWithManualContent(markdown, existingContent, manualSections) } else { |
| You are visitor 01402520 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |