@eagleoutice/flowr 2.6.2 → 2.7.0

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

@@ -5,9 +5,7 @@ exports.formatSideEffect = formatSideEffect;
 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_dataflow_graph_1 = require("../../dataflow/graph/diff-dataflow-graph");
@@ -15,9 +13,10 @@ const assert_1 = require("../../util/assert");
 const time_1 = require("../../util/text/time");
 const doc_files_1 = require("./doc-files");
 const doc_code_1 = require("./doc-code");
-const config_1 = require("../../config");
+const flowr_analyzer_context_1 = require("../../project/context/flowr-analyzer-context");
 /**
- *
+ * Visualizes the dataflow graph as a mermaid graph inside a markdown code block.
+ * Please use this only for documentation purposes, for programmatic usage use {@link graphToMermaid} directly.
  */
 function printDfGraph(graph, mark, simplified = false) {
     return `
@@ -30,7 +29,7 @@ ${(0, doc_code_1.codeBlock)('mermaid', (0, dfg_1.graphToMermaid)({
 	`;
 }
 /**
- *
+ * Visualizes a side effect for documentation purposes.
  */
 function formatSideEffect(ef) {
     if (typeof ef === 'object') {
@@ -41,13 +40,15 @@ function formatSideEffect(ef) {
     }
 }
 /**
- *
+ * Visualizes the dataflow graph of the given R code using the given parser.
+ * This function returns a markdown string containing the dataflow graph as a mermaid code block,
+ * along with the R code itself in a collapsible section.
  */
 async function printDfGraphForCode(parser, code, { simplified = false, mark, showCode = true, codeOpen = false, exposeResult, switchCodeAndGraph = false } = {}) {
     const now = performance.now();
     const result = await (0, default_pipelines_1.createDataflowPipeline)(parser, {
-        request: (0, retriever_1.requestFromInput)(code)
-    }, config_1.defaultConfigOptions).allRemainingSteps();
+        context: (0, flowr_analyzer_context_1.contextFromInput)(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');
@@ -80,15 +81,15 @@ ${switchCodeAndGraph ? dfGraph : codeText}
     return exposeResult ? [resultText, result] : resultText;
 }
 /** returns resolved expected df graph */
-async function verifyExpectedSubgraph(shell, code, expectedSubgraph) {
+async function verifyExpectedSubgraph(parser, code, expectedSubgraph) {
+    const context = (0, flowr_analyzer_context_1.contextFromInput)(code);
     /* we verify that we get what we want first! */
-    const info = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
-        parser: shell,
-        request: (0, retriever_1.requestFromInput)(code),
+    const info = await (0, default_pipelines_1.createDataflowPipeline)(parser, {
+        context: context,
         getId: (0, decorate_1.deterministicCountingIdGenerator)(0)
-    }, config_1.defaultConfigOptions).allRemainingSteps();
+    }).allRemainingSteps();
     expectedSubgraph.setIdMap(info.normalize.idMap);
-    expectedSubgraph = (0, resolve_graph_1.resolveDataflowGraph)(expectedSubgraph);
+    expectedSubgraph = (0, resolve_graph_1.resolveDataflowGraph)(expectedSubgraph, context);
     const report = (0, diff_dataflow_graph_1.diffOfDataflowGraphs)({ name: 'expected', graph: expectedSubgraph }, { name: 'got', graph: info.dataflow.graph }, {
         leftIsSubgraph: true
     });

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

@@ -4,3 +4,9 @@
  * @returns The escaped string
  */
 export declare function escapeHTML(str: string | undefined): string | undefined;
+/**
+ * Escapes newline characters in a string (Supports Windows and Unix newlines).
+ * @param str - The string to escape
+ * @returns The escaped string
+ */
+export declare function escapeNewline(str: string): string;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.escapeHTML = escapeHTML;
+exports.escapeNewline = escapeNewline;
 /**
  * Escapes HTML special characters in a string.
  * @param str - The string to escape
@@ -15,4 +16,14 @@ function escapeHTML(str) {
         "'": ''',
     }[tag] ?? tag));
 }
+/**
+ * Escapes newline characters in a string (Supports Windows and Unix newlines).
+ * @param str - The string to escape
+ * @returns The escaped string
+ */
+function escapeNewline(str) {
+    return str.replace(/([\n\r])/g, (match) => {
+        return match == '\n' ? '\\n' : '\\r';
+    });
+}
 //# sourceMappingURL=doc-escape.js.map

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

@@ -1,8 +1,28 @@
 /**
- *
+ * Prefixes each line in the given string with the given prefix.
+ * @example
+ * ```ts
+ * const text = `Line 1
+ * Line 2
+ * Line 3`;
+ * const prefixed = prefixLines(text, '> ');
+ * console.log(prefixed);
+ * ```
+ * This will output:
+ * ```md
+ * > Line 1
+ * > Line 2
+ * > Line 3
+ * ```
  */
 export declare function prefixLines(line: string, prefix: string): string;
 /**
- *
+ * Joins the given elements using the given join string, but uses a different string for the last join.
+ * @example
+ * ```ts
+ * const items = ['apple', 'banana', 'cherry'];
+ * const result = lastJoin(items, ', ', ' and ');
+ * console.log(result); // Output: "apple, banana and cherry"
+ * ```
  */
 export declare function lastJoin(elements: readonly string[], join: string, lastjoin: string): string;

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

@@ -3,13 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.prefixLines = prefixLines;
 exports.lastJoin = lastJoin;
 /**
- *
+ * Prefixes each line in the given string with the given prefix.
+ * @example
+ * ```ts
+ * const text = `Line 1
+ * Line 2
+ * Line 3`;
+ * const prefixed = prefixLines(text, '> ');
+ * console.log(prefixed);
+ * ```
+ * This will output:
+ * ```md
+ * > Line 1
+ * > Line 2
+ * > Line 3
+ * ```
  */
 function prefixLines(line, prefix) {
     return line.split('\n').map(l => `${prefix}${l}`).join('\n');
 }
 /**
- *
+ * Joins the given elements using the given join string, but uses a different string for the last join.
+ * @example
+ * ```ts
+ * const items = ['apple', 'banana', 'cherry'];
+ * const result = lastJoin(items, ', ', ' and ');
+ * console.log(result); // Output: "apple, banana and cherry"
+ * ```
  */
 function lastJoin(elements, join, lastjoin) {
     if (elements.length <= 1) {

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

@@ -1,18 +1,23 @@
 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';
+import { type ParentInformation, type RNodeWithParent } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { KnownParser } from '../../r-bridge/parser';
+import type { RProject } from '../../r-bridge/lang-4.x/ast/model/nodes/r-project';
 /**
- *
+ * Visualizes the normalized AST using mermaid syntax.
+ * This is mainly intended for documentation purposes.
  */
-export declare function printNormalizedAst(ast: RNodeWithParent, prefix?: string): string;
+export declare function printNormalizedAst(ast: RProject<ParentInformation> | RNodeWithParent, prefix?: string): string;
 export interface PrintNormalizedAstOptions {
     readonly showCode?: boolean;
     readonly prefix?: string;
 }
 /**
- *
+ * Generates and prints the normalized AST for the given code, along with optional metadata and the original code.
+ * This is intended for documentation purposes.
  */
 export declare function printNormalizedAstForCode(parser: KnownParser, code: string, { showCode, prefix }?: PrintNormalizedAstOptions): Promise<string>;
-/** returns resolved expected df graph */
+/**
+ * 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

@@ -4,7 +4,6 @@ exports.printNormalizedAst = printNormalizedAst;
 exports.printNormalizedAstForCode = printNormalizedAstForCode;
 exports.verifyExpectedSubgraph = verifyExpectedSubgraph;
 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_dataflow_graph_1 = require("../../dataflow/graph/diff-dataflow-graph");
@@ -12,9 +11,10 @@ const assert_1 = require("../../util/assert");
 const ast_1 = require("../../util/mermaid/ast");
 const time_1 = require("../../util/text/time");
 const doc_files_1 = require("./doc-files");
-const config_1 = require("../../config");
+const flowr_analyzer_context_1 = require("../../project/context/flowr-analyzer-context");
 /**
- *
+ * Visualizes the normalized AST using mermaid syntax.
+ * This is mainly intended for documentation purposes.
  */
 function printNormalizedAst(ast, prefix = 'flowchart TD\n') {
     return `
@@ -24,13 +24,14 @@ ${(0, ast_1.normalizedAstToMermaid)(ast, prefix)}
 	`;
 }
 /**
- *
+ * Generates and prints the normalized AST for the given code, along with optional metadata and the original code.
+ * This is intended for documentation purposes.
  */
 async function printNormalizedAstForCode(parser, code, { showCode = true, prefix = 'flowchart TD\n' } = {}) {
     const now = performance.now();
     const result = await (0, default_pipelines_1.createNormalizePipeline)(parser, {
-        request: (0, retriever_1.requestFromInput)(code)
-    }, config_1.defaultConfigOptions).allRemainingSteps();
+        context: (0, flowr_analyzer_context_1.contextFromInput)(code)
+    }).allRemainingSteps();
     const duration = performance.now() - now;
     const metaInfo = `The analysis required _${(0, time_1.printAsMs)(duration)}_ (including parsing with the [${parser.name}](${doc_files_1.FlowrWikiBaseRef}/Engines) engine) within the generation environment.`;
     return '\n\n' + printNormalizedAst(result.normalize.ast, prefix) + (showCode ? `
@@ -58,15 +59,18 @@ ${(0, ast_1.normalizedAstToMermaid)(result.normalize.ast, prefix)}
 
 ` : '\n(' + metaInfo + ')\n\n');
 }
-/** returns resolved expected df graph */
+/**
+ * returns resolved expected df graph
+ */
 async function verifyExpectedSubgraph(shell, code, expectedSubgraph) {
     /* we verify that we get what we want first! */
+    const context = (0, flowr_analyzer_context_1.contextFromInput)(code);
     const info = await (0, default_pipelines_1.createDataflowPipeline)(shell, {
-        request: (0, retriever_1.requestFromInput)(code),
+        context: context,
         getId: (0, decorate_1.deterministicCountingIdGenerator)(0)
-    }, config_1.defaultConfigOptions).allRemainingSteps();
+    }).allRemainingSteps();
     expectedSubgraph.setIdMap(info.normalize.idMap);
-    expectedSubgraph = (0, resolve_graph_1.resolveDataflowGraph)(expectedSubgraph);
+    expectedSubgraph = (0, resolve_graph_1.resolveDataflowGraph)(expectedSubgraph, context);
     const report = (0, diff_dataflow_graph_1.diffOfDataflowGraphs)({ name: 'expected', graph: expectedSubgraph }, { name: 'got', graph: info.dataflow.graph }, {
         leftIsSubgraph: true
     });

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

@@ -2,31 +2,39 @@ 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';
+import type { SlicingCriteria } from '../../slicing/criterion/parse';
+import type { GeneralDocContext } from '../wiki-mk/doc-context';
+import type { KnownParser } from '../../r-bridge/parser';
 export interface ShowQueryOptions {
     readonly showCode?: boolean;
     readonly collapseResult?: boolean;
     readonly collapseQuery?: boolean;
+    readonly shorthand?: string;
 }
 /**
  * Visualizes a query and its results in markdown format.
  */
-export declare function showQuery<Base extends SupportedQueryTypes, VirtualArguments extends VirtualCompoundConstraint<Base> = VirtualCompoundConstraint<Base>>(shell: RShell, code: string, queries: Queries<Base, VirtualArguments>, { showCode, collapseResult, collapseQuery }?: ShowQueryOptions): Promise<string>;
+export declare function showQuery<Base extends SupportedQueryTypes, VirtualArguments extends VirtualCompoundConstraint<Base> = VirtualCompoundConstraint<Base>>(parser: KnownParser, code: string, queries: Queries<Base, VirtualArguments>, { showCode, collapseResult, collapseQuery, shorthand }?: 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>;
+    readonly buildExplanation: (shell: RShell, ctx: GeneralDocContext) => Promise<string>;
 }
 export declare const RegisteredQueries: {
     active: Map<string, QueryDocumentation>;
     virtual: Map<string, QueryDocumentation>;
 };
 /**
- *
+ * Registers a new documentation for a query.
  */
 export declare function registerQueryDocumentation(query: SupportedQueryTypes | SupportedVirtualQueryTypes, doc: QueryDocumentation): void;
+/**
+ * Creates a REPL shorthand for the given slicing criteria and R code.
+ */
+export declare function sliceQueryShorthand(criteria: SlicingCriteria, code: string, forward?: boolean): string;
 /**
  *
  */
@@ -38,4 +46,4 @@ export declare function tocForQueryType(type: 'active' | 'virtual'): string;
 /**
  *
  */
-export declare function explainQueries(shell: RShell, type: 'active' | 'virtual'): Promise<string>;
+export declare function explainQueries(shell: RShell, ctx: GeneralDocContext, type: 'active' | 'virtual'): Promise<string>;

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

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RegisteredQueries = void 0;
 exports.showQuery = showQuery;
 exports.registerQueryDocumentation = registerQueryDocumentation;
+exports.sliceQueryShorthand = sliceQueryShorthand;
 exports.linkToQueryOfName = linkToQueryOfName;
 exports.tocForQueryType = tocForQueryType;
 exports.explainQueries = explainQueries;
-const retriever_1 = require("../../r-bridge/retriever");
 const json_1 = require("../../util/json");
 const ansi_1 = require("../../util/text/ansi");
 const doc_files_1 = require("./doc-files");
@@ -19,9 +19,10 @@ const doc_cli_option_1 = require("./doc-cli-option");
 /**
  * Visualizes a query and its results in markdown format.
  */
-async function showQuery(shell, code, queries, { showCode, collapseResult, collapseQuery } = {}) {
+async function showQuery(parser, code, queries, { showCode, collapseResult, collapseQuery, shorthand } = {}) {
     const now = performance.now();
-    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder((0, retriever_1.requestFromInput)(code)).setParser(shell).build();
+    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder().setParser(parser).build();
+    analyzer.addRequest(code);
     const results = await analyzer.query(queries);
     const duration = performance.now() - now;
     const metaInfo = `
@@ -33,8 +34,8 @@ The analysis required _${(0, time_1.printAsMs)(duration)}_ (including parsing an
 ${(0, doc_code_1.codeBlock)('json', collapseQuery ? str.split('\n').join(' ').replace(/([{[])\s{2,}/g, '$1 ').replace(/\s{2,}([\]}])/g, ' $1') : str)}
 
 ${(function () {
-        if (queries.length === 1 && Object.keys(queries[0]).length === 1) {
-            return `(This query can be shortened to \`@${queries[0].type}\` when used within the REPL command ${(0, doc_cli_option_1.getReplCommand)('query')}).`;
+        if ((queries.length === 1 && Object.keys(queries[0]).length === 1) || shorthand) {
+            return `(This query can be shortened to \`@${queries[0].type}${shorthand ? ' ' + shorthand : ''}\` when used within the REPL command ${(0, doc_cli_option_1.getReplCommand)('query')}).`;
         }
         else {
             return '';
@@ -61,7 +62,7 @@ ${(0, doc_code_1.jsonWithLimit)(results)}
 ${showCode ? `
 <details> <summary style="color:gray">Original Code</summary>
 
-${await (0, doc_dfg_1.printDfGraphForCode)(shell, code, { switchCodeAndGraph: true })}
+${await (0, doc_dfg_1.printDfGraphForCode)(parser, code, { switchCodeAndGraph: true })}
 
 </details>
 	` : ''}
@@ -75,7 +76,7 @@ exports.RegisteredQueries = {
     'virtual': new Map()
 };
 /**
- *
+ * Registers a new documentation for a query.
  */
 function registerQueryDocumentation(query, doc) {
     const map = exports.RegisteredQueries[doc.type];
@@ -84,6 +85,12 @@ function registerQueryDocumentation(query, doc) {
     }
     map.set(query, doc);
 }
+/**
+ * Creates a REPL shorthand for the given slicing criteria and R code.
+ */
+function sliceQueryShorthand(criteria, code, forward) {
+    return `(${(criteria.join(';'))})${forward ? 'f' : ''} "${code}"`;
+}
 function linkify(name) {
     return name.toLowerCase().replace(/ /g, '-');
 }
@@ -108,11 +115,11 @@ function tocForQueryType(type) {
     }
     return result.join('\n');
 }
-async function explainQuery(shell, { name, functionName, functionFile, buildExplanation }) {
+async function explainQuery(shell, ctx, { name, functionName, functionFile, buildExplanation }) {
     return `
 ### ${name}
 
-${await buildExplanation(shell)}
+${await buildExplanation(shell, ctx)}
 
 <details> 
 
@@ -127,11 +134,11 @@ Responsible for the execution of the ${name} query is \`${functionName}\` in ${(
 /**
  *
  */
-async function explainQueries(shell, type) {
+async function explainQueries(shell, ctx, type) {
     const queries = [...exports.RegisteredQueries[type].entries()].sort(([, { name: a }], [, { name: b }]) => a.localeCompare(b));
     const result = [];
     for (const [, doc] of queries) {
-        result.push(await explainQuery(shell, doc));
+        result.push(await explainQuery(shell, ctx, doc));
     }
     return result.join(`\n${'-'.repeat(5)}\n\n`);
 }

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

@@ -1,6 +1,4 @@
 import type { RShell } from '../../r-bridge/shell';
-import type { SupportedQueryTypes } from '../../queries/query';
-import type { SupportedVirtualQueryTypes } from '../../queries/virtual-query/virtual-queries';
 import type { FlowrSearchLike } from '../../search/flowr-search-builder';
 export interface ShowSearchOptions {
     readonly showCode?: boolean;
@@ -10,31 +8,3 @@ export interface ShowSearchOptions {
  * Visualizes a search and its results in markdown format.
  */
 export declare function showSearch(shell: RShell, code: string, search: FlowrSearchLike, { collapseResult }?: ShowSearchOptions): 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 linkToQueryOfName(id: SupportedQueryTypes | SupportedVirtualQueryTypes): string;
-/**
- *
- */
-export declare function tocForQueryType(type: 'active' | 'virtual'): string;
-/**
- *
- */
-export declare function explainQueries(shell: RShell, type: 'active' | 'virtual'): Promise<string>;

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

@@ -1,13 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegisteredQueries = void 0;
 exports.showSearch = showSearch;
-exports.registerQueryDocumentation = registerQueryDocumentation;
-exports.linkToQueryOfName = linkToQueryOfName;
-exports.tocForQueryType = tocForQueryType;
-exports.explainQueries = explainQueries;
-const retriever_1 = require("../../r-bridge/retriever");
-const doc_files_1 = require("./doc-files");
 const doc_dfg_1 = require("./doc-dfg");
 const doc_code_1 = require("./doc-code");
 const time_1 = require("../../util/text/time");
@@ -20,9 +13,10 @@ const flowr_analyzer_builder_1 = require("../../project/flowr-analyzer-builder")
  */
 async function showSearch(shell, code, search, { collapseResult = true } = {}) {
     const now = performance.now();
-    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder((0, retriever_1.requestFromInput)(code))
+    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder()
         .setParser(shell)
         .build();
+    analyzer.addRequest(code);
     const result = await analyzer.runSearch(search);
     const duration = performance.now() - now;
     const metaInfo = `
@@ -66,69 +60,4 @@ ${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 linkToQueryOfName(id) {
-    const query = exports.RegisteredQueries.active.get(id) ?? exports.RegisteredQueries.virtual.get(id);
-    if (!query) {
-        throw new Error(`Query ${id} not found`);
-    }
-    return `[${query.name}](#${linkify(query.name)})`;
-}
-/**
- *
- */
-function tocForQueryType(type) {
-    const queries = [...exports.RegisteredQueries[type].entries()].sort(([, { name: a }], [, { name: b }]) => a.localeCompare(b));
-    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].entries()].sort(([, { name: a }], [, { name: b }]) => a.localeCompare(b));
-    const result = [];
-    for (const [, doc] of queries) {
-        result.push(await explainQuery(shell, doc));
-    }
-    return result.join(`\n${'-'.repeat(5)}\n\n`);
-}
 //# sourceMappingURL=doc-search.js.map

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

@@ -1,6 +1,6 @@
-import type { RShell } from '../../r-bridge/shell';
 import type { FlowrMessage, IdMessageBase, MessageDefinition } from '../../cli/repl/server/messages/all-messages';
 import { type FakeServer, type FakeSocket } from '../../../test/functionality/_helper/net';
+import type { KnownParser } from '../../r-bridge/parser';
 export interface ServerMessageDescription {
     readonly title: string;
     readonly type: 'request' | 'response';
@@ -10,7 +10,7 @@ export interface ServerMessageDescription {
     readonly defRequest?: MessageDefinition<IdMessageBase>;
     readonly defResponse?: MessageDefinition<IdMessageBase>;
     readonly additionalDefs?: MessageDefinition<IdMessageBase>[];
-    readonly text: (shell: RShell) => Promise<string>;
+    readonly text: (shell: KnownParser) => Promise<string>;
 }
 /**
  * Documents a server message for later printing.
@@ -19,11 +19,11 @@ export declare function documentServerMessage(description: ServerMessageDescript
 /**
  * Visualizes all documented server messages in markdown format.
  */
-export declare function printServerMessages(shell: RShell): Promise<string>;
+export declare function printServerMessages(treeSitter: KnownParser): Promise<string>;
 /**
  * Executes the given function within a server context.
  */
-export declare function inServerContext<T>(shell: RShell, fn: (socket: FakeSocket, server: FakeServer) => Promise<T> | T): Promise<T>;
+export declare function inServerContext<T>(shell: KnownParser, fn: (socket: FakeSocket, server: FakeServer) => Promise<T> | T): Promise<T>;
 interface ResponseMessageInPingPong {
     readonly type: 'response';
     readonly expectedType: FlowrMessage['type'];
@@ -37,7 +37,7 @@ interface RequestMessageInPingPong {
     readonly mark?: boolean;
 }
 export interface MessagePingPongDocumentationArguments {
-    readonly shell: RShell;
+    readonly shell: KnownParser;
     readonly title?: string;
     readonly messageType?: FlowrMessage['type'];
     readonly messages: readonly (ResponseMessageInPingPong | RequestMessageInPingPong)[];

package/documentation/doc-util/doc-server-message.js

@@ -21,10 +21,10 @@ function documentServerMessage(description) {
 /**
  * Visualizes all documented server messages in markdown format.
  */
-async function printServerMessages(shell) {
+async function printServerMessages(treeSitter) {
     let text = '<ul>';
     for (const message of messages) {
-        text += '<li>' + await printServerMessage(message, shell) + '</li>\n\n';
+        text += '<li>' + await printServerMessage(message, treeSitter) + '</li>\n\n';
     }
     return text + '</ul>';
 }
@@ -128,7 +128,7 @@ ${(0, schema_1.describeSchema)(def.schema, ansi_1.markdownFormatter)}
 </details>
 ` : '';
 }
-async function printServerMessage({ mermaidSequenceDiagram, text, title, shortDescription, definitionPath, defRequest, defResponse, additionalDefs }, shell) {
+async function printServerMessage({ mermaidSequenceDiagram, text, title, shortDescription, definitionPath, defRequest, defResponse, additionalDefs }, treeSitter) {
     const base = defRequest ?? defResponse;
     (0, assert_1.guard)(base !== undefined, 'At least one of the definitions must be given');
     return `
@@ -147,7 +147,7 @@ sequenceDiagram
     ${mermaidSequenceDiagram}
 \`\`\`
 
-${await text(shell)}
+${await text(treeSitter)}
 
 <hr>