@eagleoutice/flowr 2.0.25 → 2.1.0

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

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printDfGraph = printDfGraph;
+exports.printDfGraphForCode = printDfGraphForCode;
+exports.verifyExpectedSubgraph = verifyExpectedSubgraph;
+const dfg_1 = require("../../util/mermaid/dfg");
+const pipeline_executor_1 = require("../../core/pipeline-executor");
+const default_pipelines_1 = require("../../core/steps/pipeline/default-pipelines");
+const retriever_1 = require("../../r-bridge/retriever");
+const decorate_1 = require("../../r-bridge/lang-4.x/ast/model/processing/decorate");
+const resolve_graph_1 = require("../../dataflow/graph/resolve-graph");
+const diff_1 = require("../../dataflow/graph/diff");
+const assert_1 = require("../../util/assert");
+const doc_ms_1 = require("./doc-ms");
+const json_1 = require("../../util/json");
+function printDfGraph(graph, mark) {
+    return `
+\`\`\`mermaid
+${(0, dfg_1.graphToMermaid)({
+        graph,
+        prefix: 'flowchart LR',
+        mark
+    }).string}
+\`\`\`
+	`;
+}
+async function printDfGraphForCode(shell, code, { mark, showCode = true, codeOpen = false, exposeResult, switchCodeAndGraph = false } = {}) {
+    const now = performance.now();
+    const result = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
+        shell,
+        request: (0, retriever_1.requestFromInput)(code)
+    }).allRemainingSteps();
+    const duration = performance.now() - now;
+    if (switchCodeAndGraph) {
+        (0, assert_1.guard)(showCode, 'can not switch code and graph if code is not shown');
+    }
+    const metaInfo = `The analysis required _${(0, doc_ms_1.printAsMs)(duration)}_ (including parsing and normalization) within the generation environment.`;
+    const dfGraph = printDfGraph(result.dataflow.graph, mark);
+    let resultText = '\n\n';
+    if (showCode) {
+        const codeText = `\`\`\`r
+${code}
+\`\`\``;
+        resultText += switchCodeAndGraph ? codeText : dfGraph;
+        resultText += `
+<details${codeOpen ? ' open' : ''}>
+
+<summary style="color:gray">${switchCodeAndGraph ? 'Dataflow Graph of the R Code' : 'R Code of the Dataflow Graph'}</summary>
+
+${metaInfo} ${mark ? `The following marks are used in the graph to highlight sub-parts (uses ids): {${[...mark].join(', ')}}.` : ''}
+We encountered ${result.dataflow.graph.unknownSideEffects.size > 0 ? 'unknown side effects (with ids: ' + JSON.stringify(result.dataflow.graph.unknownSideEffects, json_1.jsonReplacer) + ')' : 'no unknown side effects'} during the analysis.
+
+${switchCodeAndGraph ? dfGraph : codeText}
+
+<details>
+
+<summary style="color:gray">Mermaid Code ${(mark?.size ?? 0) > 0 ? '(without markings)' : ''}</summary>
+
+\`\`\`
+${(0, dfg_1.graphToMermaid)({
+            graph: result.dataflow.graph,
+            prefix: 'flowchart LR'
+        }).string}
+\`\`\`
+
+</details>
+
+</details>
+
+`;
+    }
+    else {
+        resultText += dfGraph + '\n(' + metaInfo + ')\n\n';
+    }
+    return exposeResult ? [resultText, result] : resultText;
+}
+/** returns resolved expected df graph */
+async function verifyExpectedSubgraph(shell, code, expectedSubgraph) {
+    /* we verify that we get what we want first! */
+    const info = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
+        shell,
+        request: (0, retriever_1.requestFromInput)(code),
+        getId: (0, decorate_1.deterministicCountingIdGenerator)(0)
+    }).allRemainingSteps();
+    expectedSubgraph.setIdMap(info.normalize.idMap);
+    expectedSubgraph = (0, resolve_graph_1.resolveDataflowGraph)(expectedSubgraph);
+    const report = (0, diff_1.diffOfDataflowGraphs)({ name: 'expected', graph: expectedSubgraph }, { name: 'got', graph: info.dataflow.graph }, {
+        leftIsSubgraph: true
+    });
+    (0, assert_1.guard)(report.isEqual(), () => `report:\n * ${report.comments()?.join('\n * ') ?? ''}`);
+    return expectedSubgraph;
+}
+//# sourceMappingURL=doc-dfg.js.map

package/documentation/doc-util/doc-docker.d.ts

@@ -0,0 +1 @@
+export declare const DockerName = "eagleoutice/flowr";

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DockerName = void 0;
+exports.DockerName = 'eagleoutice/flowr';
+//# sourceMappingURL=doc-docker.js.map

package/documentation/doc-util/doc-env.d.ts

@@ -0,0 +1,2 @@
+import type { IEnvironment } from '../../dataflow/environments/environment';
+export declare function printEnvironmentToMarkdown(env: IEnvironment | undefined): string;

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printEnvironmentToMarkdown = printEnvironmentToMarkdown;
+const environment_1 = require("../../dataflow/environments/environment");
+const dfg_1 = require("../../util/mermaid/dfg");
+function printEnvironmentToMarkdown(env) {
+    if (env === undefined) {
+        return '?? (error)';
+    }
+    else if (env.id === environment_1.BuiltInEnvironment.id) {
+        return `_Built-in Environment (${env.memory.size} entries)_`;
+    }
+    const lines = ['| Name | Definitions |', '|------|-------------|'];
+    for (const [name, defs] of env.memory.entries()) {
+        const printName = `\`${name}\``;
+        lines.push(`| ${printName} | {${defs.map(dfg_1.printIdentifier).join(', ')}} |`);
+    }
+    return lines.join('\n') + '\n\n<details><summary style="color:gray"> Parent Environment</summary>\n\n' + printEnvironmentToMarkdown(env.parent) + '\n\n</details>';
+}
+//# sourceMappingURL=doc-env.js.map

package/documentation/doc-util/doc-files.d.ts

@@ -0,0 +1,6 @@
+export declare const FlowrGithubBaseRef = "https://github.com/flowr-analysis";
+export declare const RemoteFlowrFilePathBaseRef = "https://github.com/flowr-analysis/flowr/tree/main/";
+export declare const FlowrWikiBaseRef = "https://github.com/flowr-analysis/flowr/wiki/";
+export declare const FlowrNpmRef = "https://www.npmjs.com/package/@eagleoutice/flowr";
+export declare function getFilePathMd(path: string): string;
+export declare function getFileContentFromRoot(path: string): string;

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

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowrNpmRef = exports.FlowrWikiBaseRef = exports.RemoteFlowrFilePathBaseRef = exports.FlowrGithubBaseRef = void 0;
+exports.getFilePathMd = getFilePathMd;
+exports.getFileContentFromRoot = getFileContentFromRoot;
+const fs_1 = __importDefault(require("fs"));
+exports.FlowrGithubBaseRef = 'https://github.com/flowr-analysis';
+exports.RemoteFlowrFilePathBaseRef = `${exports.FlowrGithubBaseRef}/flowr/tree/main/`;
+exports.FlowrWikiBaseRef = `${exports.FlowrGithubBaseRef}/flowr/wiki/`;
+exports.FlowrNpmRef = 'https://www.npmjs.com/package/@eagleoutice/flowr';
+function getFilePathMd(path) {
+    // we go one up as we are in doc-util now :D #convenience
+    const fullpath = require.resolve('../' + path);
+    const relative = fullpath.replace(process.cwd(), '.');
+    /* remove project prefix */
+    return `[\`${relative}\`](${exports.RemoteFlowrFilePathBaseRef}${relative})`;
+}
+function getFileContentFromRoot(path) {
+    const fullpath = require.resolve('../../../' + path);
+    return fs_1.default.readFileSync(fullpath, 'utf-8');
+}
+//# sourceMappingURL=doc-files.js.map

package/documentation/doc-util/doc-general.d.ts

@@ -0,0 +1,2 @@
+export declare function prefixLines(line: string, prefix: string): string;
+export declare function lastJoin(elements: readonly string[], join: string, lastjoin: string): string;

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prefixLines = prefixLines;
+exports.lastJoin = lastJoin;
+function prefixLines(line, prefix) {
+    return line.split('\n').map(l => `${prefix}${l}`).join('\n');
+}
+function lastJoin(elements, join, lastjoin) {
+    if (elements.length <= 1) {
+        return elements.join(lastjoin);
+    }
+    else {
+        return elements.slice(0, -1).join(join) + lastjoin + elements[elements.length - 1];
+    }
+}
+//# sourceMappingURL=doc-general.js.map

package/documentation/doc-util/doc-hover-over.d.ts

@@ -0,0 +1 @@
+export declare function textWithTooltip(text: string, tooltip?: string): string;

package/documentation/doc-util/doc-hover-over.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.textWithTooltip = textWithTooltip;
+function textWithTooltip(text, tooltip) {
+    return tooltip ? `<span title=${JSON.stringify(tooltip)}>${text}</span>` : text;
+}
+//# sourceMappingURL=doc-hover-over.js.map

package/documentation/doc-util/doc-issue.d.ts

@@ -0,0 +1 @@
+export declare const NewIssueUrl = "https://github.com/flowr-analysis/flowr/issues/new/choose";

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NewIssueUrl = void 0;
+const doc_files_1 = require("./doc-files");
+exports.NewIssueUrl = `${doc_files_1.FlowrGithubBaseRef}/flowr/issues/new/choose`;
+//# sourceMappingURL=doc-issue.js.map

package/documentation/doc-util/doc-ms.d.ts

@@ -0,0 +1 @@
+export declare function printAsMs(ms: number, precision?: number): string;

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printAsMs = printAsMs;
+function printAsMs(ms, precision = 2) {
+    /* eslint-disable-next-line no-irregular-whitespace*/
+    return `${ms.toFixed(precision)} ms`;
+}
+//# sourceMappingURL=doc-ms.js.map

package/documentation/doc-util/doc-normalized-ast.d.ts

@@ -0,0 +1,11 @@
+import type { DataflowGraph } from '../../dataflow/graph/graph';
+import type { RShell } from '../../r-bridge/shell';
+import type { RNodeWithParent } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
+export declare function printNormalizedAst(ast: RNodeWithParent, prefix?: string): string;
+export interface PrintNormalizedAstOptions {
+    readonly showCode?: boolean;
+    readonly prefix?: string;
+}
+export declare function printNormalizedAstForCode(shell: RShell, code: string, { showCode, prefix }?: PrintNormalizedAstOptions): Promise<string>;
+/** returns resolved expected df graph */
+export declare function verifyExpectedSubgraph(shell: RShell, code: string, expectedSubgraph: DataflowGraph): Promise<DataflowGraph>;

package/documentation/doc-util/doc-normalized-ast.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printNormalizedAst = printNormalizedAst;
+exports.printNormalizedAstForCode = printNormalizedAstForCode;
+exports.verifyExpectedSubgraph = verifyExpectedSubgraph;
+const pipeline_executor_1 = require("../../core/pipeline-executor");
+const default_pipelines_1 = require("../../core/steps/pipeline/default-pipelines");
+const retriever_1 = require("../../r-bridge/retriever");
+const decorate_1 = require("../../r-bridge/lang-4.x/ast/model/processing/decorate");
+const resolve_graph_1 = require("../../dataflow/graph/resolve-graph");
+const diff_1 = require("../../dataflow/graph/diff");
+const assert_1 = require("../../util/assert");
+const doc_ms_1 = require("./doc-ms");
+const ast_1 = require("../../util/mermaid/ast");
+function printNormalizedAst(ast, prefix = 'flowchart TD\n') {
+    return `
+\`\`\`mermaid
+${(0, ast_1.normalizedAstToMermaid)(ast, prefix)}
+\`\`\`
+	`;
+}
+async function printNormalizedAstForCode(shell, code, { showCode = true, prefix = 'flowchart TD\n' } = {}) {
+    const now = performance.now();
+    const result = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_NORMALIZE_PIPELINE, {
+        shell,
+        request: (0, retriever_1.requestFromInput)(code)
+    }).allRemainingSteps();
+    const duration = performance.now() - now;
+    const metaInfo = `The analysis required _${(0, doc_ms_1.printAsMs)(duration)}_ (including parsing) within the generation environment.`;
+    return '\n\n' + printNormalizedAst(result.normalize.ast, prefix) + (showCode ? `
+<details>
+
+<summary style="color:gray">R Code of the Normalized AST</summary>
+
+${metaInfo}
+
+\`\`\`r
+${code}
+\`\`\`
+
+<details>
+
+<summary style="color:gray">Mermaid Code</summary>
+
+\`\`\`
+${(0, ast_1.normalizedAstToMermaid)(result.normalize.ast, prefix)}
+\`\`\`
+
+</details>
+
+</details>
+
+` : '\n(' + metaInfo + ')\n\n');
+}
+/** returns resolved expected df graph */
+async function verifyExpectedSubgraph(shell, code, expectedSubgraph) {
+    /* we verify that we get what we want first! */
+    const info = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
+        shell,
+        request: (0, retriever_1.requestFromInput)(code),
+        getId: (0, decorate_1.deterministicCountingIdGenerator)(0)
+    }).allRemainingSteps();
+    expectedSubgraph.setIdMap(info.normalize.idMap);
+    expectedSubgraph = (0, resolve_graph_1.resolveDataflowGraph)(expectedSubgraph);
+    const report = (0, diff_1.diffOfDataflowGraphs)({ name: 'expected', graph: expectedSubgraph }, { name: 'got', graph: info.dataflow.graph }, {
+        leftIsSubgraph: true
+    });
+    (0, assert_1.guard)(report.isEqual(), () => `report:\n * ${report.comments()?.join('\n * ') ?? ''}`);
+    return expectedSubgraph;
+}
+//# sourceMappingURL=doc-normalized-ast.js.map

package/documentation/doc-util/doc-query.d.ts

@@ -0,0 +1,24 @@
+import type { RShell } from '../../r-bridge/shell';
+import type { Queries, SupportedQueryTypes } from '../../queries/query';
+import type { SupportedVirtualQueryTypes } from '../../queries/virtual-query/virtual-queries';
+import type { VirtualCompoundConstraint } from '../../queries/virtual-query/compound-query';
+export interface ShowQueryOptions {
+    readonly showCode?: boolean;
+    readonly collapseResult?: boolean;
+}
+export declare function showQuery<Base extends SupportedQueryTypes, VirtualArguments extends VirtualCompoundConstraint<Base> = VirtualCompoundConstraint<Base>>(shell: RShell, code: string, queries: Queries<Base, VirtualArguments>, { showCode, collapseResult }?: ShowQueryOptions): Promise<string>;
+export interface QueryDocumentation {
+    readonly name: string;
+    readonly type: 'virtual' | 'active';
+    readonly shortDescription: string;
+    readonly functionName: string;
+    readonly functionFile: string;
+    readonly buildExplanation: (shell: RShell) => Promise<string>;
+}
+export declare const RegisteredQueries: {
+    active: Map<string, QueryDocumentation>;
+    virtual: Map<string, QueryDocumentation>;
+};
+export declare function registerQueryDocumentation(query: SupportedQueryTypes | SupportedVirtualQueryTypes, doc: QueryDocumentation): void;
+export declare function tocForQueryType(type: 'active' | 'virtual'): string;
+export declare function explainQueries(shell: RShell, type: 'active' | 'virtual'): Promise<string>;

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

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisteredQueries = void 0;
+exports.showQuery = showQuery;
+exports.registerQueryDocumentation = registerQueryDocumentation;
+exports.tocForQueryType = tocForQueryType;
+exports.explainQueries = explainQueries;
+const query_1 = require("../../queries/query");
+const pipeline_executor_1 = require("../../core/pipeline-executor");
+const default_pipelines_1 = require("../../core/steps/pipeline/default-pipelines");
+const retriever_1 = require("../../r-bridge/retriever");
+const doc_ms_1 = require("./doc-ms");
+const json_1 = require("../../util/json");
+const ansi_1 = require("../../util/ansi");
+const repl_query_1 = require("../../cli/repl/commands/repl-query");
+const doc_files_1 = require("./doc-files");
+const doc_dfg_1 = require("./doc-dfg");
+async function showQuery(shell, code, queries, { showCode, collapseResult } = {}) {
+    const now = performance.now();
+    const analysis = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
+        shell,
+        request: (0, retriever_1.requestFromInput)(code)
+    }).allRemainingSteps();
+    const results = (0, query_1.executeQueries)({ graph: analysis.dataflow.graph, ast: analysis.normalize }, queries);
+    const duration = performance.now() - now;
+    const metaInfo = `
+The analysis required _${(0, doc_ms_1.printAsMs)(duration)}_ (including parsing and normalization and the query) within the generation environment.
+	`.trim();
+    const resultAsString = JSON.stringify(results, json_1.jsonReplacer, 2);
+    return `
+
+\`\`\`json
+${JSON.stringify(queries, json_1.jsonReplacer, 2)}
+\`\`\`
+
+${collapseResult ? ' <details> <summary style="color:gray">Show Results</summary>' : ''}
+
+_Results (prettified and summarized):_
+
+${(0, repl_query_1.asciiSummaryOfQueryResult)(ansi_1.markdownFormatter, duration, results, analysis)}
+
+<details> <summary style="color:gray">Show Detailed Results as Json</summary>
+
+${metaInfo}	
+
+In general, the JSON contains the Ids of the nodes in question as they are present in the normalized AST or the dataflow graph of flowR.
+Please consult the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more information on how to get those.
+
+\`\`\`json
+${resultAsString}
+\`\`\`
+
+</details>
+
+${showCode ? `
+<details> <summary style="color:gray">Original Code</summary>
+
+${await (0, doc_dfg_1.printDfGraphForCode)(shell, code, { switchCodeAndGraph: true })}
+
+</details>
+	` : ''}
+
+${collapseResult ? '</details>' : ''}
+
+	`;
+}
+exports.RegisteredQueries = {
+    'active': new Map(),
+    'virtual': new Map()
+};
+function registerQueryDocumentation(query, doc) {
+    const map = exports.RegisteredQueries[doc.type];
+    if (map.has(query)) {
+        throw new Error(`Query ${query} already registered`);
+    }
+    map.set(query, doc);
+}
+function linkify(name) {
+    return name.toLowerCase().replace(/ /g, '-');
+}
+function tocForQueryType(type) {
+    const queries = exports.RegisteredQueries[type];
+    const result = [];
+    for (const [id, { name, shortDescription }] of queries) {
+        result.push(`1. [${name}](#${linkify(name)}) (\`${id}\`):\\\n    ${shortDescription}`);
+    }
+    return result.join('\n');
+}
+async function explainQuery(shell, { name, functionName, functionFile, buildExplanation }) {
+    return `
+### ${name}
+
+${await buildExplanation(shell)}
+
+<details> 
+
+<summary style="color:gray">Implementation Details</summary>
+
+Responsible for the execution of the ${name} query is \`${functionName}\` in ${(0, doc_files_1.getFilePathMd)(functionFile)}.
+
+</details>	
+
+`;
+}
+async function explainQueries(shell, type) {
+    const queries = exports.RegisteredQueries[type];
+    const result = [];
+    for (const doc of queries.values()) {
+        result.push(await explainQuery(shell, doc));
+    }
+    return result.join('\n\n\n');
+}
+//# sourceMappingURL=doc-query.js.map

package/documentation/doc-util/doc-repl.d.ts

@@ -0,0 +1,13 @@
+import type { RShell } from '../../r-bridge/shell';
+export declare function printReplHelpAsMarkdownTable(): string;
+export interface DocumentReplSessionOptions {
+    /** defaults to false and shows starting the repl */
+    hideEntry?: boolean;
+    /** defaults to false and allows access to the R session */
+    allowRSessionAccess?: boolean;
+}
+export interface DocumentReplCommand {
+    command: string;
+    description: string;
+}
+export declare function documentReplSession(shell: RShell, commands: readonly DocumentReplCommand[], options?: DocumentReplSessionOptions): Promise<string>;

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

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printReplHelpAsMarkdownTable = printReplHelpAsMarkdownTable;
+exports.documentReplSession = documentReplSession;
+const repl_commands_1 = require("../../cli/repl/commands/repl-commands");
+const doc_cli_option_1 = require("./doc-cli-option");
+const doc_hover_over_1 = require("./doc-hover-over");
+const core_1 = require("../../cli/repl/core");
+const ansi_1 = require("../../util/ansi");
+const doc_docker_1 = require("./doc-docker");
+const prompt_1 = require("../../cli/repl/prompt");
+const doc_code_1 = require("./doc-code");
+function printHelpForScript(script, starredVersion) {
+    let base = `| **${(0, doc_cli_option_1.getReplCommand)(script[0], false, starredVersion !== undefined)}** | ${script[1].description}`;
+    if (starredVersion) {
+        base += ` (star: ${starredVersion.description})`;
+    }
+    if (script[1].aliases.length === 0) {
+        return base;
+    }
+    const aliases = script[1].aliases;
+    return `${base} (alias${aliases.length > 1 ? 'es' : ''}: ${aliases.map(a => '**:' + (0, doc_hover_over_1.textWithTooltip)(a, `Alias of ':${script[0]}'. ${script[1].description}`) + '**').join(', ')}) |`;
+}
+function printReplHelpAsMarkdownTable() {
+    const scriptHelp = [];
+    const cmds = (0, repl_commands_1.getReplCommands)();
+    for (const c of Object.entries(cmds)) {
+        if (c[1].script || c[0].endsWith('*')) {
+            continue;
+        }
+        const starred = cmds[c[0] + '*'];
+        scriptHelp.push(printHelpForScript(c, starred));
+    }
+    return `
+| Command | Description |
+| ------- | ----------- |
+${scriptHelp.sort().join('\n')}
+`;
+}
+async function documentReplSession(shell, commands, options) {
+    const collect = [];
+    for (const command of commands) {
+        const entry = { command, lines: [] };
+        const collectingOutput = {
+            formatter: ansi_1.voidFormatter,
+            stdout(msg) {
+                entry.lines.push(msg);
+            },
+            stderr(msg) {
+                entry.lines.push(msg);
+            }
+        };
+        await (0, core_1.replProcessAnswer)(collectingOutput, command.command, shell, options?.allowRSessionAccess ?? false);
+        collect.push(entry);
+    }
+    let result = '';
+    let cache = options?.hideEntry ? '' : `docker run -it --rm ${doc_docker_1.DockerName}\n`;
+    for (const { command, lines } of collect) {
+        if (lines.length === 0) {
+            cache += prompt_1.rawPrompt + ' ' + command.command + '\n';
+            continue;
+        }
+        result += `
+${(0, doc_code_1.codeBlock)('shell', cache + prompt_1.rawPrompt + ' ' + command.command)}
+<details>
+<summary style='color:gray'>Output</summary>
+
+${command.description}
+
+${(0, doc_code_1.codeBlock)('text', lines.join('\n'))}
+
+</details>
+
+`;
+        cache = '';
+    }
+    return result;
+}
+//# sourceMappingURL=doc-repl.js.map

package/documentation/doc-util/doc-server-message.d.ts

@@ -0,0 +1,37 @@
+import type { RShell } from '../../r-bridge/shell';
+import type { FlowrMessage, IdMessageBase, MessageDefinition } from '../../cli/repl/server/messages/all-messages';
+import type { FakeServer, FakeSocket } from '../../../test/functionality/_helper/net';
+export interface ServerMessageDescription {
+    readonly title: string;
+    readonly type: 'request' | 'response';
+    readonly mermaidSequenceDiagram: string;
+    readonly shortDescription: string;
+    readonly definitionPath: string;
+    readonly defRequest?: MessageDefinition<IdMessageBase>;
+    readonly defResponse?: MessageDefinition<IdMessageBase>;
+    readonly additionalDefs?: MessageDefinition<IdMessageBase>[];
+    readonly text: (shell: RShell) => Promise<string>;
+}
+export declare function documentServerMessage(description: ServerMessageDescription): void;
+export declare function printServerMessages(shell: RShell): Promise<string>;
+export declare function inServerContext<T>(shell: RShell, fn: (socket: FakeSocket, server: FakeServer) => Promise<T> | T): Promise<T>;
+interface ResponseMessageInPingPong {
+    readonly type: 'response';
+    readonly expectedType: FlowrMessage['type'];
+    readonly description?: string | ((msg: IdMessageBase) => string);
+    readonly mark?: boolean;
+}
+interface RequestMessageInPingPong {
+    readonly type: 'request';
+    readonly message: FlowrMessage;
+    readonly description?: string | ((msg: IdMessageBase) => string);
+    readonly mark?: boolean;
+}
+export interface MessagePingPongDocumentationArguments {
+    readonly shell: RShell;
+    readonly title?: string;
+    readonly messageType?: FlowrMessage['type'];
+    readonly messages: readonly (ResponseMessageInPingPong | RequestMessageInPingPong)[];
+}
+export declare function documentServerMessageResponse({ shell, title, messageType, messages }: MessagePingPongDocumentationArguments): Promise<string>;
+export {};