@eagleoutice/flowr 2.6.1 → 2.6.2

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

@@ -2,7 +2,7 @@ import type { NormalizedAst } from '../../r-bridge/lang-4.x/ast/model/processing
 import type { KnownParser } from '../../r-bridge/parser';
 import type { DataflowInformation } from '../../dataflow/info';
 import type { ControlFlowInformation } from '../../control-flow/control-flow-graph';
-import type { CfgSimplificationPassName } from '../../control-flow/cfg-simplification';
+import { type CfgSimplificationPassName } from '../../control-flow/cfg-simplification';
 type GetCfgReturn = {
     info: ControlFlowInformation;
     ast: NormalizedAst;
@@ -10,6 +10,9 @@ type GetCfgReturn = {
 };
 export declare function getCfg(parser: KnownParser, code: string, simplifications?: readonly CfgSimplificationPassName[], useDfg?: true): Promise<Required<GetCfgReturn>>;
 export declare function getCfg(parser: KnownParser, code: string, simplifications?: readonly CfgSimplificationPassName[], useDfg?: boolean): Promise<GetCfgReturn>;
+/**
+ * Serializes the given control flow graph to a mermaid diagram.
+ */
 export declare function printCfg(cfg: ControlFlowInformation, ast: NormalizedAst, prefix?: string, simplify?: boolean): string;
 export interface PrintCfgOptions {
     readonly showCode?: boolean;
@@ -19,5 +22,8 @@ export interface PrintCfgOptions {
     readonly simplify?: boolean;
     readonly useDfg?: boolean;
 }
+/**
+ * Generates and prints the control flow graph for the given code, along with optional metadata and the original code.
+ */
 export declare function printCfgCode(parser: KnownParser, code: string, { showCode, openCode, prefix, simplifications, simplify, useDfg }?: PrintCfgOptions): Promise<string>;
 export {};

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

@@ -12,6 +12,9 @@ const cfg_1 = require("../../util/mermaid/cfg");
 const doc_code_1 = require("./doc-code");
 const cfg_simplification_1 = require("../../control-flow/cfg-simplification");
 const config_1 = require("../../config");
+/**
+ * Returns the control flow graph for the given code.
+ */
 async function getCfg(parser, code, simplifications = [], useDfg = true) {
     const result = useDfg ? await (0, default_pipelines_1.createDataflowPipeline)(parser, {
         request: (0, retriever_1.requestFromInput)(code)
@@ -25,11 +28,17 @@ async function getCfg(parser, code, simplifications = [], useDfg = true) {
         dataflow: 'dataflow' in result ? result.dataflow : undefined
     };
 }
+/**
+ * Serializes the given control flow graph to a mermaid diagram.
+ */
 function printCfg(cfg, ast, prefix = 'flowchart BT\n', simplify = false) {
     return `
 ${(0, doc_code_1.codeBlock)('mermaid', (0, cfg_1.cfgToMermaid)(cfg, ast, prefix, simplify))}
 	`;
 }
+/**
+ * Generates and prints the control flow graph for the given code, along with optional metadata and the original code.
+ */
 async function printCfgCode(parser, code, { showCode = true, openCode = false, prefix = 'flowchart BT\n', simplifications = [], simplify = false, useDfg = true } = {}) {
     const now = performance.now();
     const res = await getCfg(parser, code, simplifications, useDfg);

package/documentation/doc-util/doc-cli-option.d.ts

@@ -2,7 +2,16 @@
 import { scripts } from '../../cli/common/scripts-info';
 import { flowrMainOptionDefinitions } from '../../cli/flowr-main-options';
 type ScriptOptions<Type extends keyof typeof scripts | 'flowr'> = Type extends keyof typeof scripts ? typeof scripts[Type]['options'][number]['name'] : Type extends 'flowr' ? typeof flowrMainOptionDefinitions[number]['name'] : never;
+/**
+ *
+ */
 export declare function getCliLongOptionOf<ScriptName extends keyof typeof scripts | 'flowr', OptionName extends ScriptOptions<ScriptName>>(scriptName: ScriptName, optionName: OptionName, withAlias?: boolean, quote?: boolean): string;
+/**
+ *
+ */
 export declare function multipleCliOptions<ScriptName extends keyof typeof scripts | 'flowr', OptionName extends ScriptOptions<ScriptName>>(scriptName: ScriptName, ...options: OptionName[]): string;
+/**
+ *
+ */
 export declare function getReplCommand(commandName: string, quote?: boolean, showStar?: boolean): string;
 export {};

package/documentation/doc-util/doc-cli-option.js

@@ -10,6 +10,9 @@ const html_hover_over_1 = require("../../util/html-hover-over");
 const flowr_main_options_1 = require("../../cli/flowr-main-options");
 const repl_commands_1 = require("../../cli/repl/commands/repl-commands");
 const doc_escape_1 = require("./doc-escape");
+/**
+ *
+ */
 function getCliLongOptionOf(scriptName, optionName, withAlias = false, quote = true) {
     const script = scriptName === 'flowr' ? flowr_main_options_1.flowrMainOptionDefinitions : scripts_info_1.scripts[scriptName].options;
     (0, assert_1.guard)(script !== undefined, () => `Unknown script ${scriptName}, pick one of ${JSON.stringify(Object.keys(scripts_info_1.scripts))}.`);
@@ -22,9 +25,15 @@ function getCliLongOptionOf(scriptName, optionName, withAlias = false, quote = t
     // span ensures split even with ligatures
     return (0, html_hover_over_1.textWithTooltip)(`${char}-${ligatureBreaker}-${optionName}${char}`, 'Description (Command Line Argument): ' + description) + alias;
 }
+/**
+ *
+ */
 function multipleCliOptions(scriptName, ...options) {
     return options.map(o => getCliLongOptionOf(scriptName, o, false, true)).join(' ');
 }
+/**
+ *
+ */
 function getReplCommand(commandName, quote = true, showStar = false) {
     const availableNames = (0, repl_commands_1.getReplCommands)();
     const commands = availableNames[commandName];

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

@@ -1,3 +1,27 @@
+/**
+ * Produces a code block in markdown format.
+ * @example
+ * ```typescript
+ * codeBlock('ts', 'const x = 42;');
+ * // Produces:
+ * //
+ * // ```ts
+ * // const x = 42;
+ * // ```
+ * ```
+ */
 export declare function codeBlock(language: string, code: string): string;
+/**
+ * Produces an inline code span in markdown format.
+ * @example
+ * ```typescript
+ * codeInline('const x = 42;');
+ * // Produces: `<code>const x = 42;</code>`
+ * ```
+ */
 export declare function codeInline(code: string): string;
+/**
+ * Produces a JSON code block in markdown format, with optional length limit.
+ * If the pretty-printed JSON exceeds the limit, a message is shown instead of the full JSON.
+ */
 export declare function jsonWithLimit(object: object, maxLength?: number, tooLongText?: string): string;

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

@@ -5,12 +5,36 @@ exports.codeInline = codeInline;
 exports.jsonWithLimit = jsonWithLimit;
 const json_1 = require("../../util/json");
 const environment_1 = require("../../dataflow/environments/environment");
+/**
+ * Produces a code block in markdown format.
+ * @example
+ * ```typescript
+ * codeBlock('ts', 'const x = 42;');
+ * // Produces:
+ * //
+ * // ```ts
+ * // const x = 42;
+ * // ```
+ * ```
+ */
 function codeBlock(language, code) {
     return `\n\`\`\`${language}\n${code?.trim() ?? ''}\n\`\`\`\n`;
 }
+/**
+ * Produces an inline code span in markdown format.
+ * @example
+ * ```typescript
+ * codeInline('const x = 42;');
+ * // Produces: `<code>const x = 42;</code>`
+ * ```
+ */
 function codeInline(code) {
     return `<code>${code}</code>`;
 }
+/**
+ * Produces a JSON code block in markdown format, with optional length limit.
+ * If the pretty-printed JSON exceeds the limit, a message is shown instead of the full JSON.
+ */
 function jsonWithLimit(object, maxLength = 5_000, tooLongText = '_As the code is pretty long, we inhibit pretty printing and syntax highlighting (JSON, hiding built-in):_') {
     const prettyPrinted = JSON.stringify(object, json_1.jsonReplacer, 2);
     return `

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

@@ -1,9 +1,12 @@
 import type { DataflowGraph, UnknownSidEffect } from '../../dataflow/graph/graph';
 import type { RShell } from '../../r-bridge/shell';
-import type { MermaidMarkdownMark } from '../../util/mermaid/dfg';
+import { type MermaidMarkdownMark } from '../../util/mermaid/dfg';
 import { DEFAULT_DATAFLOW_PIPELINE } from '../../core/steps/pipeline/default-pipelines';
 import type { PipelineOutput } from '../../core/steps/pipeline/pipeline';
 import type { KnownParser } from '../../r-bridge/parser';
+/**
+ *
+ */
 export declare function printDfGraph(graph: DataflowGraph, mark?: ReadonlySet<MermaidMarkdownMark>, simplified?: boolean): string;
 export interface PrintDataflowGraphOptions {
     readonly mark?: ReadonlySet<MermaidMarkdownMark>;
@@ -13,6 +16,9 @@ export interface PrintDataflowGraphOptions {
     readonly switchCodeAndGraph?: boolean;
     readonly simplified?: boolean;
 }
+/**
+ *
+ */
 export declare function formatSideEffect(ef: UnknownSidEffect): string;
 export declare function printDfGraphForCode(parser: KnownParser, code: string, options: PrintDataflowGraphOptions & {
     exposeResult: true;

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

@@ -16,6 +16,9 @@ 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");
+/**
+ *
+ */
 function printDfGraph(graph, mark, simplified = false) {
     return `
 ${(0, doc_code_1.codeBlock)('mermaid', (0, dfg_1.graphToMermaid)({
@@ -26,6 +29,9 @@ ${(0, doc_code_1.codeBlock)('mermaid', (0, dfg_1.graphToMermaid)({
     }).string)}
 	`;
 }
+/**
+ *
+ */
 function formatSideEffect(ef) {
     if (typeof ef === 'object') {
         return `${ef.id} (linked)`;
@@ -34,6 +40,9 @@ function formatSideEffect(ef) {
         return `${ef}`;
     }
 }
+/**
+ *
+ */
 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, {

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

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

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

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.printEnvironmentToMarkdown = printEnvironmentToMarkdown;
 const dfg_1 = require("../../util/mermaid/dfg");
+/**
+ *
+ */
 function printEnvironmentToMarkdown(env) {
     if (env === undefined) {
         return '?? (error)';

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

@@ -1,6 +1,5 @@
 /**
  * Escapes HTML special characters in a string.
- *
  * @param str - The string to escape
  * @returns The escaped string
  */

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

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.escapeHTML = escapeHTML;
 /**
  * Escapes HTML special characters in a string.
- *
  * @param str - The string to escape
  * @returns The escaped string
  */

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

@@ -1,3 +1,4 @@
+export declare const FlowrGithubGroupName = "flowr-analysis";
 export declare const FlowrGithubBaseRef = "https://github.com/flowr-analysis";
 export declare const FlowrSiteBaseRef = "https://flowr-analysis.github.io/flowr";
 export declare const RemoteFlowrFilePathBaseRef = "https://github.com/flowr-analysis/flowr/tree/main/";
@@ -7,6 +8,16 @@ export declare const FlowrDockerRef = "https://hub.docker.com/r/eagleoutice/flow
 export declare const FlowrCodecovRef = "https://app.codecov.io/gh/flowr-analysis/flowr";
 export declare const FlowrVsCode = "https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr";
 export declare const FlowrPositron = "https://open-vsx.org/extension/code-inspect/vscode-flowr";
+/**
+ * Returns a markdown link to the given file path relative to the project root.
+ */
 export declare function getFilePathMd(path: string): string;
+/**
+ * Returns the content of a file located at the given path relative to the project root.
+ * This reads the file synchronously from disk.
+ */
 export declare function getFileContentFromRoot(path: string): string;
+/**
+ * Returns a markdown link to the given flowr source file path.
+ */
 export declare function linkFlowRSourceFile(path: string): string;

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

@@ -3,20 +3,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlowrPositron = exports.FlowrVsCode = exports.FlowrCodecovRef = exports.FlowrDockerRef = exports.FlowrNpmRef = exports.FlowrWikiBaseRef = exports.RemoteFlowrFilePathBaseRef = exports.FlowrSiteBaseRef = exports.FlowrGithubBaseRef = void 0;
+exports.FlowrPositron = exports.FlowrVsCode = exports.FlowrCodecovRef = exports.FlowrDockerRef = exports.FlowrNpmRef = exports.FlowrWikiBaseRef = exports.RemoteFlowrFilePathBaseRef = exports.FlowrSiteBaseRef = exports.FlowrGithubBaseRef = exports.FlowrGithubGroupName = void 0;
 exports.getFilePathMd = getFilePathMd;
 exports.getFileContentFromRoot = getFileContentFromRoot;
 exports.linkFlowRSourceFile = linkFlowRSourceFile;
 const fs_1 = __importDefault(require("fs"));
-exports.FlowrGithubBaseRef = 'https://github.com/flowr-analysis';
-exports.FlowrSiteBaseRef = 'https://flowr-analysis.github.io/flowr';
+exports.FlowrGithubGroupName = 'flowr-analysis';
+exports.FlowrGithubBaseRef = `https://github.com/${exports.FlowrGithubGroupName}`;
+exports.FlowrSiteBaseRef = `https://${exports.FlowrGithubGroupName}.github.io/flowr`;
 exports.RemoteFlowrFilePathBaseRef = `${exports.FlowrGithubBaseRef}/flowr/tree/main/`;
 exports.FlowrWikiBaseRef = `${exports.FlowrGithubBaseRef}/flowr/wiki`;
 exports.FlowrNpmRef = 'https://www.npmjs.com/package/@eagleoutice/flowr';
 exports.FlowrDockerRef = 'https://hub.docker.com/r/eagleoutice/flowr';
-exports.FlowrCodecovRef = 'https://app.codecov.io/gh/flowr-analysis/flowr';
+exports.FlowrCodecovRef = `https://app.codecov.io/gh/${exports.FlowrGithubGroupName}/flowr`;
 exports.FlowrVsCode = 'https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr';
 exports.FlowrPositron = 'https://open-vsx.org/extension/code-inspect/vscode-flowr';
+/**
+ * Returns a markdown link to the given file path relative to the project root.
+ */
 function getFilePathMd(path) {
     // we go one up as we are in doc-util now :D #convenience
     const fullpath = require.resolve('../' + path);
@@ -26,10 +30,17 @@ function getFilePathMd(path) {
     /* remove project prefix */
     return `[\`${relative}\`](${exports.RemoteFlowrFilePathBaseRef}${relative})`;
 }
+/**
+ * Returns the content of a file located at the given path relative to the project root.
+ * This reads the file synchronously from disk.
+ */
 function getFileContentFromRoot(path) {
     const fullpath = require.resolve('../../../' + path);
     return fs_1.default.readFileSync(fullpath, 'utf-8');
 }
+/**
+ * Returns a markdown link to the given flowr source file path.
+ */
 function linkFlowRSourceFile(path) {
     return `[${path}](${exports.RemoteFlowrFilePathBaseRef}/${path})`;
 }

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

@@ -1,2 +1,8 @@
+/**
+ *
+ */
 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

@@ -2,9 +2,15 @@
 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);

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

@@ -1,12 +1,18 @@
 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 RNodeWithParent } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { KnownParser } from '../../r-bridge/parser';
+/**
+ *
+ */
 export declare function printNormalizedAst(ast: RNodeWithParent, prefix?: string): string;
 export interface PrintNormalizedAstOptions {
     readonly showCode?: boolean;
     readonly prefix?: string;
 }
+/**
+ *
+ */
 export declare function printNormalizedAstForCode(parser: KnownParser, 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

@@ -13,6 +13,9 @@ 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");
+/**
+ *
+ */
 function printNormalizedAst(ast, prefix = 'flowchart TD\n') {
     return `
 \`\`\`mermaid
@@ -20,6 +23,9 @@ ${(0, ast_1.normalizedAstToMermaid)(ast, prefix)}
 \`\`\`
 	`;
 }
+/**
+ *
+ */
 async function printNormalizedAstForCode(parser, code, { showCode = true, prefix = 'flowchart TD\n' } = {}) {
     const now = performance.now();
     const result = await (0, default_pipelines_1.createNormalizePipeline)(parser, {

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

@@ -7,6 +7,9 @@ export interface ShowQueryOptions {
     readonly collapseResult?: boolean;
     readonly collapseQuery?: boolean;
 }
+/**
+ * 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 interface QueryDocumentation {
     readonly name: string;
@@ -20,7 +23,19 @@ 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-query.js

@@ -16,6 +16,9 @@ const time_1 = require("../../util/text/time");
 const query_print_1 = require("../../queries/query-print");
 const flowr_analyzer_builder_1 = require("../../project/flowr-analyzer-builder");
 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 } = {}) {
     const now = performance.now();
     const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder((0, retriever_1.requestFromInput)(code)).setParser(shell).build();
@@ -46,7 +49,7 @@ ${await (0, query_print_1.asciiSummaryOfQueryResult)(ansi_1.markdownFormatter, d
 
 <details> <summary style="color:gray">Show Detailed Results as Json</summary>
 
-${metaInfo}	
+${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.
@@ -71,6 +74,9 @@ exports.RegisteredQueries = {
     'active': new Map(),
     'virtual': new Map()
 };
+/**
+ *
+ */
 function registerQueryDocumentation(query, doc) {
     const map = exports.RegisteredQueries[doc.type];
     if (map.has(query)) {
@@ -81,6 +87,9 @@ function registerQueryDocumentation(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) {
@@ -88,6 +97,9 @@ function linkToQueryOfName(id) {
     }
     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 = [];
@@ -108,10 +120,13 @@ ${await buildExplanation(shell)}
 
 Responsible for the execution of the ${name} query is \`${functionName}\` in ${(0, doc_files_1.getFilePathMd)(functionFile)}.
 
-</details>	
+</details>
 
 `;
 }
+/**
+ *
+ */
 async function explainQueries(shell, type) {
     const queries = [...exports.RegisteredQueries[type].entries()].sort(([, { name: a }], [, { name: b }]) => a.localeCompare(b));
     const result = [];

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

@@ -1,4 +1,7 @@
 import type { KnownParser } from '../../r-bridge/parser';
+/**
+ *
+ */
 export declare function printReplHelpAsMarkdownTable(): string;
 export interface DocumentReplSessionOptions {
     /** defaults to false and shows starting the repl */
@@ -14,4 +17,7 @@ export interface DocumentReplCommand {
     command: string;
     description: string;
 }
+/**
+ *
+ */
 export declare function documentReplSession(parser: KnownParser, commands: readonly DocumentReplCommand[], options?: DocumentReplSessionOptions): Promise<string>;

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

@@ -23,6 +23,9 @@ function printHelpForScript(script, starredVersion) {
     const aliases = script[1].aliases;
     return `${base} (alias${aliases.length > 1 ? 'es' : ''}: ${aliases.map(a => '**:' + (0, html_hover_over_1.textWithTooltip)(a, `Alias of ':${script[0]}'. ${script[1].description}`) + '**').join(', ')}) |`;
 }
+/**
+ *
+ */
 function printReplHelpAsMarkdownTable() {
     const scriptHelp = [];
     const cmds = (0, repl_commands_1.getReplCommands)();
@@ -39,6 +42,9 @@ function printReplHelpAsMarkdownTable() {
 ${scriptHelp.sort().join('\n')}
 `;
 }
+/**
+ *
+ */
 async function documentReplSession(parser, commands, options) {
     const collect = [];
     for (const command of commands) {

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

@@ -6,6 +6,9 @@ export interface ShowSearchOptions {
     readonly showCode?: boolean;
     readonly collapseResult?: boolean;
 }
+/**
+ * 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;
@@ -19,7 +22,19 @@ 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

@@ -15,6 +15,9 @@ const flowr_search_printer_1 = require("../../search/flowr-search-printer");
 const node_id_1 = require("../../r-bridge/lang-4.x/ast/model/processing/node-id");
 const dfg_1 = require("../../util/mermaid/dfg");
 const flowr_analyzer_builder_1 = require("../../project/flowr-analyzer-builder");
+/**
+ * Visualizes a search and its results in markdown format.
+ */
 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))
@@ -52,7 +55,7 @@ ${collapseResult ? ' <details> <summary style="color:gray">Show Results</summary
 The query returns the following vetices (all references to \`x\` in the code):
 ${result.getElements().map(({ node }) => `<b>${node.info.id} ('${(0, node_id_1.recoverContent)(node.info.id, dataflow.graph)}')</b> at L${(0, dfg_1.formatRange)(node.location)}`).join(', ')}
 
-${metaInfo}	
+${metaInfo}
 
 The returned results are highlighted thick and blue within the dataflow graph:
 
@@ -67,6 +70,9 @@ exports.RegisteredQueries = {
     'active': new Map(),
     'virtual': new Map()
 };
+/**
+ *
+ */
 function registerQueryDocumentation(query, doc) {
     const map = exports.RegisteredQueries[doc.type];
     if (map.has(query)) {
@@ -77,6 +83,9 @@ function registerQueryDocumentation(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) {
@@ -84,6 +93,9 @@ function linkToQueryOfName(id) {
     }
     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 = [];
@@ -104,10 +116,13 @@ ${await buildExplanation(shell)}
 
 Responsible for the execution of the ${name} query is \`${functionName}\` in ${(0, doc_files_1.getFilePathMd)(functionFile)}.
 
-</details>	
+</details>
 
 `;
 }
+/**
+ *
+ */
 async function explainQueries(shell, type) {
     const queries = [...exports.RegisteredQueries[type].entries()].sort(([, { name: a }], [, { name: b }]) => a.localeCompare(b));
     const result = [];

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, FakeSocket } from '../../../test/functionality/_helper/net';
+import { type FakeServer, type FakeSocket } from '../../../test/functionality/_helper/net';
 export interface ServerMessageDescription {
     readonly title: string;
     readonly type: 'request' | 'response';
@@ -12,8 +12,17 @@ export interface ServerMessageDescription {
     readonly additionalDefs?: MessageDefinition<IdMessageBase>[];
     readonly text: (shell: RShell) => Promise<string>;
 }
+/**
+ * Documents a server message for later printing.
+ */
 export declare function documentServerMessage(description: ServerMessageDescription): void;
+/**
+ * Visualizes all documented server messages in markdown format.
+ */
 export declare function printServerMessages(shell: RShell): 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>;
 interface ResponseMessageInPingPong {
     readonly type: 'response';
@@ -33,5 +42,8 @@ export interface MessagePingPongDocumentationArguments {
     readonly messageType?: FlowrMessage['type'];
     readonly messages: readonly (ResponseMessageInPingPong | RequestMessageInPingPong)[];
 }
+/**
+ * Documents a ping-pong message exchange with the server.
+ */
 export declare function documentServerMessageResponse({ shell, title, messageType, messages }: MessagePingPongDocumentationArguments): Promise<string>;
 export {};