@eagleoutice/flowr 2.2.11 → 2.2.13

package/documentation/doc-util/doc-types.js

@@ -10,6 +10,7 @@ exports.getTypePathLink = getTypePathLink;
 exports.getTypesFromFolderAsMermaid = getTypesFromFolderAsMermaid;
 exports.implSnippet = implSnippet;
 exports.printHierarchy = printHierarchy;
+exports.printCodeOfElement = printCodeOfElement;
 exports.shortLink = shortLink;
 exports.getDocumentationForType = getDocumentationForType;
 const typescript_1 = __importDefault(require("typescript"));
@@ -21,6 +22,7 @@ const mermaid_1 = require("../../util/mermaid/mermaid");
 const doc_code_1 = require("./doc-code");
 const doc_structure_1 = require("./doc-structure");
 const html_hover_over_1 = require("../../util/html-hover-over");
+const doc_general_1 = require("./doc-general");
 function getSourceFiles(fileNames) {
     try {
         const program = typescript_1.default.createProgram(fileNames, { target: typescript_1.default.ScriptTarget.ESNext });
@@ -345,6 +347,15 @@ function printHierarchy({ program, info, root, collapseFromNesting = 1, initialN
         return thisLine + (out ? '\n' + out : '');
     }
 }
+function printCodeOfElement({ program, info }, name) {
+    const node = info.find(e => e.name === name);
+    if (!node) {
+        console.error(`Could not find node ${name} when resolving function!`);
+        return '';
+    }
+    const code = node.node.getFullText(program.getSourceFile(node.node.getSourceFile().fileName));
+    return `${(0, doc_code_1.codeBlock)('ts', code)}\n<i>Defined at <a href="${getTypePathLink(node)}">${getTypePathLink(node, '.')}</a></i>\n`;
+}
 function retrieveNode(name, hierarchy) {
     let container = undefined;
     if (name.includes('::')) {
@@ -385,12 +396,12 @@ function shortLink(name, hierarchy, codeStyle = true, realNameWrapper = 'b') {
     return `[${codeStyle ? '<code>' : ''}${(node.comments?.length ?? 0) > 0 ?
         (0, html_hover_over_1.textWithTooltip)(pkg ? `${pkg}::<${realNameWrapper}>${mainName}</${realNameWrapper}>` : mainName, comments.length > 400 ? comments.slice(0, 400) + '...' : comments) : node.name}${codeStyle ? '</code>' : ''}](${getTypePathLink(node)})`;
 }
-function getDocumentationForType(name, hierarchy) {
+function getDocumentationForType(name, hierarchy, prefix = '') {
     const res = retrieveNode(name, hierarchy);
     if (!res) {
         return '';
     }
     const [, , node] = res;
-    return node.comments?.join('\n') ?? '';
+    return (0, doc_general_1.prefixLines)(node.comments?.join('\n') ?? '', prefix);
 }
 //# sourceMappingURL=doc-types.js.map

package/documentation/print-capabilities-markdown.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const data_1 = require("../r-bridge/data/data");
 const log_1 = require("../../test/functionality/_helper/log");
 const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
-const strings_1 = require("../util/strings");
+const strings_1 = require("../util/text/strings");
 const doc_general_1 = require("./doc-util/doc-general");
 const tree_sitter_executor_1 = require("../r-bridge/lang-4.x/tree-sitter/tree-sitter-executor");
 const fs_1 = __importDefault(require("fs"));
@@ -86,19 +86,45 @@ async function printSingleCapability(info, depth, index, capability) {
     if (capability.url) {
         nextLine += '\\\nSee ' + (0, strings_1.joinWithLast)(capability.url.map(({ name, href }) => `[${name}](${href})`)) + ' for more info.';
     }
-    nextLine += ' Internal ID: `' + capability.id + '`';
+    nextLine += ' (internal ID: `' + capability.id + '`)';
     if (capability.example) {
         nextLine += `\n${(0, doc_general_1.prefixLines)(typeof capability.example === 'string' ? capability.example : await capability.example(info.parser), nextLineIndent + '> ')}`;
     }
     return nextLine ? `${mainLine}\\\n${nextLineIndent}${nextLine}` : mainLine;
 }
+function summarizeChildren(capabilities) {
+    const summary = { total: 0, fully: 0, partially: 0, not: 0 };
+    for (const capability of capabilities) {
+        if (capability.capabilities) {
+            const childSummary = summarizeChildren(capability.capabilities);
+            summary.fully += childSummary.fully;
+            summary.partially += childSummary.partially;
+            summary.not += childSummary.not;
+            summary.total += childSummary.total;
+        }
+        if (capability.supported) {
+            summary[capability.supported]++;
+            summary.total++;
+        }
+    }
+    return summary;
+}
+function printSummary(sum) {
+    return `${sum.fully} fully, ${sum.partially} partially, ${sum.not} not supported`;
+}
 async function printAsMarkdown(info, capabilities, depth = 0, lines = []) {
     for (let i = 0; i < capabilities.length; i++) {
         const capability = capabilities[i];
         const result = await printSingleCapability(info, depth, i + 1, capability);
         lines.push(result);
         if (capability.capabilities) {
+            const summary = summarizeChildren(capability.capabilities);
+            lines.push(`\n\n${'    '.repeat(depth + 1)}<details open><summary>${summary.total} child${summary.total === 1 ? '' : 'ren'} (${printSummary(summary)})</summary>\n\n`);
             await printAsMarkdown(info, capability.capabilities, depth + 1, lines);
+            lines.push(`\n\n${'    '.repeat(depth + 1)}</details>\n\n`);
+            if (depth === 0) {
+                lines.push('\n\n' + '    '.repeat(depth + 1) + '-'.repeat(42) + '\n\n');
+            }
         }
     }
     return lines.join('\n');

package/documentation/print-cfg-wiki.d.ts

@@ -0,0 +1 @@
+export {};