@eagleoutice/flowr 2.6.1 → 2.6.3

package/dataflow/internal/process/functions/process-argument.d.ts

@@ -1,9 +1,15 @@
-import type { DataflowProcessorInformation } from '../../../processor';
-import type { DataflowInformation } from '../../../info';
+import { type DataflowProcessorInformation } from '../../../processor';
+import { type DataflowInformation } from '../../../info';
 import type { ParentInformation } from '../../../../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { RNode } from '../../../../r-bridge/lang-4.x/ast/model/model';
 import type { IdentifierReference } from '../../../environments/identifier';
 import { DataflowGraph } from '../../../graph/graph';
 import type { RArgument } from '../../../../r-bridge/lang-4.x/ast/model/nodes/r-argument';
+/**
+ * Links all reads that occur before the argument to the argument root node.
+ */
 export declare function linkReadsForArgument<OtherInfo>(root: RNode<OtherInfo & ParentInformation>, ingoingRefs: readonly IdentifierReference[], graph: DataflowGraph): void;
+/**
+ * Processes the dataflow information for a function argument.
+ */
 export declare function processFunctionArgument<OtherInfo>(argument: RArgument<OtherInfo & ParentInformation>, data: DataflowProcessorInformation<OtherInfo & ParentInformation>): DataflowInformation;

package/dataflow/internal/process/functions/process-argument.js

@@ -8,6 +8,9 @@ const graph_1 = require("../../../graph/graph");
 const type_1 = require("../../../../r-bridge/lang-4.x/ast/model/type");
 const edge_1 = require("../../../graph/edge");
 const vertex_1 = require("../../../graph/vertex");
+/**
+ * Links all reads that occur before the argument to the argument root node.
+ */
 function linkReadsForArgument(root, ingoingRefs, graph) {
     const allIdsBeforeArguments = new Set((0, collect_1.collectAllIds)(root, n => n.type === type_1.RType.Argument && n.info.id !== root.info.id));
     const ingoingBeforeArgs = ingoingRefs.filter(r => allIdsBeforeArguments.has(r.nodeId));
@@ -16,6 +19,9 @@ function linkReadsForArgument(root, ingoingRefs, graph) {
         graph.addEdge(root.info.id, ref, edge_1.EdgeType.Reads);
     }
 }
+/**
+ * Processes the dataflow information for a function argument.
+ */
 function processFunctionArgument(argument, data) {
     const name = argument.name === undefined ? undefined : (0, processor_1.processDataflowFor)(argument.name, data);
     const value = argument.value === undefined ? undefined : (0, processor_1.processDataflowFor)(argument.value, data);

package/dataflow/internal/process/functions/process-parameter.d.ts

@@ -1,5 +1,8 @@
-import type { DataflowInformation } from '../../../info';
-import type { DataflowProcessorInformation } from '../../../processor';
+import { type DataflowInformation } from '../../../info';
+import { type DataflowProcessorInformation } from '../../../processor';
 import type { RParameter } from '../../../../r-bridge/lang-4.x/ast/model/nodes/r-parameter';
 import type { ParentInformation } from '../../../../r-bridge/lang-4.x/ast/model/processing/decorate';
+/**
+ *
+ */
 export declare function processFunctionParameter<OtherInfo>(parameter: RParameter<OtherInfo & ParentInformation>, data: DataflowProcessorInformation<OtherInfo & ParentInformation>): DataflowInformation;

package/dataflow/internal/process/functions/process-parameter.js

@@ -7,6 +7,9 @@ const identifier_1 = require("../../../environments/identifier");
 const define_1 = require("../../../environments/define");
 const type_1 = require("../../../../r-bridge/lang-4.x/ast/model/type");
 const edge_1 = require("../../../graph/edge");
+/**
+ *
+ */
 function processFunctionParameter(parameter, data) {
     const name = (0, processor_1.processDataflowFor)(parameter.name, data);
     const defaultValue = parameter.defaultValue === undefined ? undefined : (0, processor_1.processDataflowFor)(parameter.defaultValue, data);
@@ -20,13 +23,13 @@ function processFunctionParameter(parameter, data) {
     for (const writtenNode of writtenNodes) {
         log_1.log.trace(`parameter ${writtenNode.name} (${writtenNode.nodeId}) is defined at id ${writtenNode.definedAt} with ${defaultValue === undefined ? 'no default value' : ' no default value'}`);
         graph.setDefinitionOfVertex(writtenNode);
-        environment = (0, define_1.define)(writtenNode, false, environment, data.flowrConfig);
+        environment = (0, define_1.define)(writtenNode, false, environment, data.ctx.config);
         if (defaultValue !== undefined) {
             if (parameter.defaultValue?.type === type_1.RType.FunctionDefinition) {
                 graph.addEdge(writtenNode, parameter.defaultValue.info.id, edge_1.EdgeType.DefinedBy);
             }
             else {
-                const definedBy = [...defaultValue.in, ...defaultValue.unknownReferences];
+                const definedBy = defaultValue.in.concat(defaultValue.unknownReferences);
                 for (const node of definedBy) {
                     graph.addEdge(writtenNode, node, edge_1.EdgeType.DefinedBy);
                 }
@@ -35,8 +38,8 @@ function processFunctionParameter(parameter, data) {
     }
     return {
         unknownReferences: [],
-        in: defaultValue === undefined ? [] : [...defaultValue.in, ...defaultValue.unknownReferences, ...name.in],
-        out: [...(defaultValue?.out ?? []), ...name.out, ...name.unknownReferences],
+        in: defaultValue === undefined ? [] : defaultValue.in.concat(defaultValue.unknownReferences, name.in),
+        out: (defaultValue?.out ?? []).concat(name.out, name.unknownReferences),
         graph: graph,
         environment: environment,
         entryPoint: parameter.info.id,

package/dataflow/internal/process/process-symbol.d.ts

@@ -2,4 +2,7 @@ import { type DataflowInformation } from '../../info';
 import type { DataflowProcessorInformation } from '../../processor';
 import type { RSymbol } from '../../../r-bridge/lang-4.x/ast/model/nodes/r-symbol';
 import type { ParentInformation } from '../../../r-bridge/lang-4.x/ast/model/processing/decorate';
+/**
+ *
+ */
 export declare function processSymbol<OtherInfo>(symbol: RSymbol<OtherInfo & ParentInformation>, data: DataflowProcessorInformation<OtherInfo>): DataflowInformation;

package/dataflow/internal/process/process-symbol.js

@@ -6,6 +6,9 @@ const convert_values_1 = require("../../../r-bridge/lang-4.x/convert-values");
 const graph_1 = require("../../graph/graph");
 const vertex_1 = require("../../graph/vertex");
 const identifier_1 = require("../../environments/identifier");
+/**
+ *
+ */
 function processSymbol(symbol, data) {
     if (symbol.content === convert_values_1.RNull || symbol.content === convert_values_1.RNa) {
         return (0, process_value_1.processValue)(symbol, data);

package/dataflow/internal/process/process-uninteresting-leaf.d.ts

@@ -1,4 +1,7 @@
 import { type DataflowInformation } from '../../info';
 import type { DataflowProcessorInformation } from '../../processor';
 import type { RNodeWithParent } from '../../../r-bridge/lang-4.x/ast/model/processing/decorate';
+/**
+ *
+ */
 export declare function processUninterestingLeaf<OtherInfo>(leaf: RNodeWithParent, info: DataflowProcessorInformation<OtherInfo>): DataflowInformation;

package/dataflow/internal/process/process-uninteresting-leaf.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.processUninterestingLeaf = processUninterestingLeaf;
 const info_1 = require("../../info");
+/**
+ *
+ */
 function processUninterestingLeaf(leaf, info) {
     return (0, info_1.initializeCleanDataflowInformation)(leaf.info.id, info);
 }

package/dataflow/internal/process/process-value.d.ts

@@ -1,4 +1,7 @@
 import { type DataflowInformation } from '../../info';
 import type { DataflowProcessorInformation } from '../../processor';
 import type { RNodeWithParent } from '../../../r-bridge/lang-4.x/ast/model/processing/decorate';
+/**
+ *
+ */
 export declare function processValue<OtherInfo>({ info: { id } }: RNodeWithParent, data: DataflowProcessorInformation<OtherInfo>): DataflowInformation;

package/dataflow/internal/process/process-value.js

@@ -4,6 +4,9 @@ exports.processValue = processValue;
 const graph_1 = require("../../graph/graph");
 const vertex_1 = require("../../graph/vertex");
 const identifier_1 = require("../../environments/identifier");
+/**
+ *
+ */
 function processValue({ info: { id } }, data) {
     return {
         unknownReferences: [],

package/dataflow/origin/dfg-get-origin.d.ts

@@ -10,7 +10,6 @@ export declare const enum OriginType {
 /**
  * An origin that indicates that the definition is read, written, or simply a constant.
  * These origins only reference the 'direct' dependencies. There is no transitivity.
- *
  * @example
  * ```r
  * x <- 2
@@ -28,7 +27,6 @@ export interface SimpleOrigin {
 /**
  * Determines the (transitive) origin of a function call (i.e., all anonymous function definitions within the program that
  * can be called).
- *
  * @example
  * ```r
  * f <- function(x) {

package/dataflow/origin/dfg-get-symbol-refs.d.ts

@@ -5,17 +5,15 @@ import type { DataflowGraph } from '../graph/graph';
  *
  * For example, for the following code
  * ```ts
- *   y <- 5
- *   f <- function() {
- *     y <- 8
- *     print(y)
- *   }
+ * y <- 5
+ * f <- function() {
+ * y <- 8
+ * print(y)
+ * }
  * ```
- *
  * @example getAllRefsToSymbol('3\@y') returns ['3\@y', '4\@y']
- *
  * @param graph  - Dataflow Graph
  * @param nodeId - NodeId of Symbol to resolve
- * @returns List including the Definitions and Refereneces to that definition
+ * @returns List including the Definitions and References to that definition
  */
 export declare function getAllRefsToSymbol(graph: DataflowGraph, nodeId: NodeId): NodeId[] | undefined;

package/dataflow/origin/dfg-get-symbol-refs.js

@@ -9,18 +9,16 @@ const dfg_get_origin_1 = require("./dfg-get-origin");
  *
  * For example, for the following code
  * ```ts
- *   y <- 5
- *   f <- function() {
- *     y <- 8
- *     print(y)
- *   }
+ * y <- 5
+ * f <- function() {
+ * y <- 8
+ * print(y)
+ * }
  * ```
- *
  * @example getAllRefsToSymbol('3\@y') returns ['3\@y', '4\@y']
- *
  * @param graph  - Dataflow Graph
  * @param nodeId - NodeId of Symbol to resolve
- * @returns List including the Definitions and Refereneces to that definition
+ * @returns List including the Definitions and References to that definition
  */
 function getAllRefsToSymbol(graph, nodeId) {
     // Get all origins and filter for ones that happen for sure
@@ -32,7 +30,7 @@ function getAllRefsToSymbol(graph, nodeId) {
     if (definitiveOrigins.length === 0) {
         return undefined;
     }
-    // Gather all the references 
+    // Gather all the references
     const res = new Set();
     for (const origin of definitiveOrigins) {
         res.add(origin.id);

package/dataflow/processor.d.ts

@@ -4,10 +4,9 @@
 import type { ControlDependency, DataflowInformation } from './info';
 import type { NormalizedAst, ParentInformation, RNodeWithParent } from '../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { IEnvironment, REnvironmentInformation } from './environments/environment';
-import type { RParseRequest } from '../r-bridge/retriever';
 import type { RNode } from '../r-bridge/lang-4.x/ast/model/model';
 import type { KnownParserType, Parser } from '../r-bridge/parser';
-import type { FlowrConfigOptions } from '../config';
+import type { FlowrAnalyzerContext } from '../project/context/flowr-analyzer-context';
 export interface DataflowProcessorInformation<OtherInfo> {
     readonly parser: Parser<KnownParserType>;
     /**
@@ -24,14 +23,10 @@ export interface DataflowProcessorInformation<OtherInfo> {
      */
     readonly processors: DataflowProcessors<OtherInfo>;
     /**
-     * The {@link RParseRequests} that is currently being parsed
+     * The chain of file paths that lead to this inclusion.
+     * The most recent (last) entry is expected to always be the current one.
      */
-    readonly currentRequest: RParseRequest;
-    /**
-     * The chain of {@link RParseRequests} that lead to the {@link currentRequest}.
-     * The most recent (last) entry is expected to always be the {@link currentRequest}.
-     */
-    readonly referenceChain: RParseRequest[];
+    readonly referenceChain: (string | undefined)[];
     /**
      * The chain of control-flow {@link NodeId}s that lead to the current node (e.g., of known ifs).
      */
@@ -41,9 +36,9 @@ export interface DataflowProcessorInformation<OtherInfo> {
      */
     readonly builtInEnvironment: IEnvironment;
     /**
-     * The flowr configuration used for environment seeding, and precision control
+     * The flowr context used for environment seeding, files, and precision control, ...
      */
-    readonly flowrConfig: FlowrConfigOptions;
+    readonly ctx: FlowrAnalyzerContext;
 }
 export type DataflowProcessor<OtherInfo, NodeType extends RNodeWithParent<OtherInfo>> = (node: NodeType, data: DataflowProcessorInformation<OtherInfo>) => DataflowInformation;
 type NodeWithKey<OtherInfo, Key> = RNode<OtherInfo & ParentInformation> & {
@@ -64,7 +59,6 @@ export type DataflowProcessors<OtherInfo> = {
  * <p>
  * Now this method can be called recursively within the other processors to parse the dataflow for nodes that you cannot narrow down
  * in type or context.
- *
  * @param current - The current node to start processing from
  * @param data    - The initial (/current) information to be passed down
  */

package/dataflow/processor.js

@@ -10,7 +10,6 @@ exports.processDataflowFor = processDataflowFor;
  * <p>
  * Now this method can be called recursively within the other processors to parse the dataflow for nodes that you cannot narrow down
  * in type or context.
- *
  * @param current - The current node to start processing from
  * @param data    - The initial (/current) information to be passed down
  */

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

@@ -1,4 +1,3 @@
-import type { RShell } from '../../../r-bridge/shell';
 import { VertexType } from '../../../dataflow/graph/vertex';
 import { EdgeType } from '../../../dataflow/graph/edge';
 import type { DataflowGraph } from '../../../dataflow/graph/graph';
@@ -9,12 +8,17 @@ export interface SubExplanationParameters {
     readonly expectedSubgraph: DataflowGraph;
 }
 export interface ExplanationParameters {
-    readonly shell: RShell;
     readonly name: string;
     readonly type: VertexType | EdgeType;
     readonly description: string;
     readonly code: string;
     readonly expectedSubgraph: DataflowGraph;
 }
+/**
+ *
+ */
 export declare function getAllVertices(): [string, VertexType][];
+/**
+ *
+ */
 export declare function getAllEdges(): [string, EdgeType][];

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

@@ -4,9 +4,15 @@ exports.getAllVertices = getAllVertices;
 exports.getAllEdges = getAllEdges;
 const vertex_1 = require("../../../dataflow/graph/vertex");
 const edge_1 = require("../../../dataflow/graph/edge");
+/**
+ *
+ */
 function getAllVertices() {
     return Object.entries(vertex_1.VertexType);
 }
+/**
+ *
+ */
 function getAllEdges() {
     return Object.entries(edge_1.EdgeType).filter(([, v]) => Number.isInteger(v));
 }

package/documentation/data/faq/faqs.d.ts

@@ -0,0 +1,5 @@
+import { FaqStore } from './wiki-faq-store';
+/**
+ *
+ */
+export declare function registerFaqs(): FaqStore;

package/documentation/data/faq/faqs.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerFaqs = registerFaqs;
+const wiki_faq_store_1 = require("./wiki-faq-store");
+const doc_files_1 = require("../../doc-util/doc-files");
+const doc_code_1 = require("../../doc-util/doc-code");
+const recommended_configs_1 = require("./recommended-configs");
+/**
+ *
+ */
+function registerFaqs() {
+    const wikiFaq = new wiki_faq_store_1.FaqStore();
+    wikiFaq.withTopic('flowr.development')
+        .addFaq('What are *test labels*?', `
+Tests are labeled based on the *flowR* capabilities that they test for.
+The list of supported capabilities can be found on the [Capabilities](${doc_files_1.FlowrWikiBaseRef}/Capabilities) wiki page.
+For more extensive information on test labels, see the [test labels wiki section](${doc_files_1.FlowrWikiBaseRef}/Linting-and-Testing#test-labels).
+`)
+        .addFaq('How to get a REPL with debug-info/*hot-reload*?', `
+	To enter the development repl, execute \`npm run main-dev\` in contrast to \`npm run flowr\`
+	this will use an unminified build (keeping debug info) and also watches the source files for changes.
+	In case of a change, this mode automatically recompiles.
+	Please note, that this may have negative performance implications (so do not use this for e.g., benchmarking).
+`)
+        .addFaq('How to generate *mermaid diagrams*?', `
+There are several ways to generate mermaid diagrams based on the input data that you want to use.
+- From the AST (abstract syntax tree): ${(0, doc_files_1.getFilePathMd)('../util/mermaid/ast.ts')}
+- From the CFG (control flow graph): ${(0, doc_files_1.getFilePathMd)('../util/mermaid/cfg.ts')}
+- From the DFG (dataflow graph): ${(0, doc_files_1.getFilePathMd)('../util/mermaid/dfg.ts')}
+`)
+        .addFaq('How to create *new wiki* pages?', `
+To create an automatically generated wiki page, you can follow these steps:
+- Create a new file in \`src/documentation\` with a name like \`wiki-thename.ts\`.
+- Register your new wiki page in the \`src/cli/wiki.ts\` file to have it executed by the wiki generation tool.
+
+You can test your page by piping the wiki generation script to a file. For example, you can run the following command:
+${(0, doc_code_1.codeBlock)('shell', 'npm run wiki')}
+Alternatively use the following to generate a specific wiki page:
+${(0, doc_code_1.codeBlock)('shell', 'npm run wiki -- --filter=Dataflow')}
+Or, activate the watch mode to automatically regenerate the wiki on changes:
+${(0, doc_code_1.codeBlock)('shell', 'npm run wiki:watch')}
+
+`)
+        .addFaq('Why can\'t I pass *arguments* when running flowR *with npm*?', `
+With \`npm\` you have to pass arguments in a specific way. The \`--\` operator is used to separate the \`npm\` arguments from the script arguments. For example, if you want to run \`flowR\` with the \`--help\` argument, you can use the following command:
+${(0, doc_code_1.codeBlock)('shell', 'npm run flowR -- --help')}
+`)
+        .addFaq('How to do *logging* in flowR?', `
+Check out the [Logging Section in the Linting and Testing wiki page](${doc_files_1.FlowrWikiBaseRef}/Linting-and-Testing#logging) for more information on how to do logging in *flowR*.
+`);
+    wikiFaq.withTopic('flowr.use')
+        .addFaq('How to *query* an R project?', `
+For this you can use flowR's [Query API](${doc_files_1.FlowrWikiBaseRef}/Query-API).
+If you want to create your own project using flowR as a library, check out the
+[${doc_files_1.FlowrGithubGroupName}/sample-analyzer-project-query](${doc_files_1.FlowrGithubBaseRef}/sample-analyzer-project-query) repository for an example project setup.
+		`);
+    wikiFaq.withTopic('r.packages')
+        .addFaq('What is the R *prelude* and R *base* package?', `
+The base package contains lots of base functions like \`source\` for example.
+The R prelude includes the base package along with several other packages.
+Packages that were loaded by the prelude can be called without prefixing the
+function call with the package name and the \`::\` operator.
+
+The packages loaded by the R prelude can be seen in the \`attached base packages\`
+sections in the output of \`sessionInfo()\`.
+`)
+        .addFaq('How to get *documentation* for a function or package?', `
+There are a couple of ways to get documentation for a function or package.
+
+🖥️ Firstly, if you have already installed the package the function originated from you can simply run \`?<package name>::<function name>\` in an R session to print the
+relevant documentation. If you don't know the origin of the package, you can use
+\`??<function name>\` in an R shell to fuzzy find all documentations containing
+\`<function name>\` or something similar.
+
+🌐 Secondly, if you don't have or don't want to install the package you can simply google the fully qualified name of the function. Good sources include [rdrr.io](https://rdrr.io/)
+or [rdocumentation.org](https://rdocumentation.org/). Additionally, the package documentation PDF can also
+be downloaded directly from [cran](https://cran.r-project.org/).
+`);
+    wikiFaq.withTopic('editor.configs')
+        .addFaq('How can I make eslint and ZED work together?', `Use this project config (\`.zed/settings.json\`) to disable all formatters except eslint:
+			${(0, doc_code_1.codeBlock)('json', JSON.stringify(recommended_configs_1.recommendedZedConfig, null, 2))}`);
+    wikiFaq.withTopic('editor.configs')
+        .addFaq('How can I launch the flowr repl form vs code?', `You can use the following launch task (\`.vscode/launch.json\`):
+			${(0, doc_code_1.codeBlock)('json', JSON.stringify(recommended_configs_1.recommendedVsCodeTask, null, 2))}`);
+    return wikiFaq;
+}
+//# sourceMappingURL=faqs.js.map

package/documentation/data/faq/recommended-configs.d.ts

@@ -0,0 +1,36 @@
+export declare const recommendedZedConfig: {
+    languages: {
+        TypeScript: {
+            formatter: never[];
+            prettier: {
+                allowed: boolean;
+            };
+            code_actions_on_format: {
+                'source.fixAll.eslint': boolean;
+            };
+        };
+    };
+    hard_tabs: boolean;
+};
+export declare const recommendedVsCodeTask: {
+    version: string;
+    configurations: ({
+        type: string;
+        request: string;
+        name: string;
+        skipFiles: string[];
+        program: string;
+        preLaunchTask: string;
+        console: string;
+        port?: undefined;
+    } | {
+        type: string;
+        request: string;
+        name: string;
+        port: number;
+        skipFiles?: undefined;
+        program?: undefined;
+        preLaunchTask?: undefined;
+        console?: undefined;
+    })[];
+};

package/documentation/data/faq/recommended-configs.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recommendedVsCodeTask = exports.recommendedZedConfig = void 0;
+exports.recommendedZedConfig = {
+    'languages': {
+        'TypeScript': {
+            'formatter': [],
+            'prettier': {
+                'allowed': false
+            },
+            'code_actions_on_format': {
+                'source.fixAll.eslint': true
+            }
+        }
+    },
+    'hard_tabs': true
+};
+exports.recommendedVsCodeTask = {
+    'version': '0.2.0',
+    'configurations': [
+        {
+            'type': 'node',
+            'request': 'launch',
+            'name': 'Launch Program',
+            'skipFiles': [
+                'node_modules/**'
+            ],
+            'program': '${workspaceFolder}/src/cli/flowr.ts',
+            'preLaunchTask': 'npm: build-dev',
+            'console': 'integratedTerminal',
+        },
+        {
+            'type': 'node',
+            'request': 'attach',
+            'name': 'Attach to Process',
+            'port': 9229
+        }
+    ]
+};
+//# sourceMappingURL=recommended-configs.js.map

package/documentation/data/faq/wiki-faq-store.d.ts

@@ -0,0 +1,19 @@
+declare const FlowrFaqTopics: {
+    readonly 'flowr.use': "✨ Using <i>flowR</i>";
+    readonly 'flowr.development': "🧑‍💻 <i>flowR</i> Development";
+    readonly 'r.packages': "📦 R Packages";
+    readonly 'editor.configs': "⚙️ Recommended Editor Configs";
+};
+type Topic = keyof typeof FlowrFaqTopics;
+/**
+ * Manage all questions and answers by topic.
+ */
+export declare class FaqStore {
+    private faqs;
+    private currTopic;
+    withTopic(topic: Topic): this;
+    addFaq(question: string, answer: string): this;
+    private printAllTopics;
+    toMarkdown(): string;
+}
+export {};

package/documentation/data/faq/wiki-faq-store.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FaqStore = void 0;
+const doc_structure_1 = require("../../doc-util/doc-structure");
+const defaultmap_1 = require("../../../util/collections/defaultmap");
+const assert_1 = require("../../../util/assert");
+const FlowrFaqTopics = {
+    'flowr.use': '✨ Using <i>flowR</i>',
+    'flowr.development': '🧑‍💻 <i>flowR</i> Development',
+    'r.packages': '📦 R Packages',
+    'editor.configs': '⚙️ Recommended Editor Configs'
+};
+/**
+ * Manage all questions and answers by topic.
+ */
+class FaqStore {
+    faqs = new defaultmap_1.DefaultMap(() => []);
+    currTopic = undefined;
+    withTopic(topic) {
+        this.currTopic = topic;
+        return this;
+    }
+    addFaq(question, answer) {
+        (0, assert_1.guard)(this.currTopic !== undefined, 'Current topic is not set use withTopic first');
+        question = question.replace(/\*([^*]+)\*/g, '<b>$1</b>');
+        const store = this.faqs.get(this.currTopic);
+        if (store.find(([q]) => q === question)) {
+            throw new Error(`FAQ for question "${question}" in topic "${this.currTopic}" already exists`);
+        }
+        store.push([question, answer]);
+        return this;
+    }
+    printAllTopics(topicsRegex) {
+        const topics = Array.from(this.faqs.keys())
+            .filter(topic => topicsRegex.test(topic))
+            .sort((a, b) => a.localeCompare(b));
+        let output = '';
+        for (const topic of topics) {
+            const faqs = this.faqs.get(topic).sort(([q1], [q2]) => q1.localeCompare(q2));
+            if (faqs.length === 0) {
+                continue;
+            }
+            output += (0, doc_structure_1.section)(FlowrFaqTopics[topic], 3) + '\n\n';
+            for (const [question, answer] of faqs) {
+                output += qAndA(question, answer) + '\n\n';
+            }
+        }
+        return output;
+    }
+    toMarkdown() {
+        return `
+${(0, doc_structure_1.collapsibleToc)({
+            ['💮 *flowR* FAQ']: {
+                [FlowrFaqTopics['flowr.development']]: {},
+                [FlowrFaqTopics['flowr.use']]: {}
+            },
+            ['🇷 R FAQ']: {
+                [FlowrFaqTopics['r.packages']]: {}
+            },
+            ['💻 Editor FAQ']: {
+                [FlowrFaqTopics['editor.configs']]: {}
+            }
+        })}
+
+${(0, doc_structure_1.section)('💮 <i>flowR</i> FAQ', 2)}
+
+${this.printAllTopics(/^flowr.*$/)}
+
+${(0, doc_structure_1.section)('🇷 R FAQ', 2)}
+
+${this.printAllTopics(/^r.*$/)}
+
+${(0, doc_structure_1.section)('💻 Editor FAQ', 2)}
+
+${this.printAllTopics(/^editor.*$/)}
+		`;
+    }
+}
+exports.FaqStore = FaqStore;
+function qAndA(question, answer) {
+    return (0, doc_structure_1.details)(question.trim(), answer.trim(), { hideIfEmpty: true });
+}
+//# sourceMappingURL=wiki-faq-store.js.map

package/documentation/data/server/doc-data-server-messages.d.ts

@@ -1 +1,4 @@
+/**
+ *
+ */
 export declare function documentAllServerMessages(): void;