@eagleoutice/flowr 2.6.2 → 2.6.3

package/documentation/wiki-mk/doc-maker.d.ts

@@ -0,0 +1,95 @@
+import type { PathLike } from 'fs';
+import type { GeneralDocContext } from './doc-context';
+import type { RShell } from '../../r-bridge/shell';
+import type { TreeSitterExecutor } from '../../r-bridge/lang-4.x/tree-sitter/tree-sitter-executor';
+import type { AsyncOrSync } from 'ts-essentials';
+export interface DocMakerArgs {
+    /** Overwrite existing wiki files, even if nothing changes */
+    readonly force?: boolean;
+    /**
+     * The general documentation context to use for generating links and headers
+     */
+    readonly ctx: GeneralDocContext;
+    /**
+     * The RShell engine to use for R code execution and retrieval
+     */
+    readonly shell: RShell;
+    /**
+     * The TreeSitter engine to use for R code parsing
+     */
+    readonly treeSitter: TreeSitterExecutor;
+}
+export interface DocMakerOutputArgs {
+    writeFileSync(path: PathLike, data: string): void;
+    readFileSync(path: PathLike): string | Buffer<ArrayBufferLike> | undefined;
+}
+export declare enum WikiChangeType {
+    Changed = 0,
+    UnimportantChange = 1,
+    Identical = 2
+}
+export interface DocMakerLike {
+    make(args: DocMakerArgs & DocMakerOutputArgs): Promise<boolean>;
+    getTarget(): string;
+    getProducer(): string;
+    getWrittenSubfiles(): Set<string>;
+}
+/**
+ * Abstract base class for generating wiki files.
+ * **Please make sure to register your WikiMaker implementation in the CLI wiki tool to have it executed:
+ * `src/cli/wiki.ts`.**
+ *
+ * If this wiki page produces multiple pages ("sub files"), you can use `writeSubFile` inside the `text` method
+ * to write those additional files.
+ */
+export declare abstract class DocMaker implements DocMakerLike {
+    private readonly target;
+    private readonly filename;
+    private readonly purpose;
+    private readonly printHeader;
+    private currentArgs?;
+    private writtenSubfiles;
+    /**
+     * Creates a new WikiMaker instance.
+     * @param target      - The target path where the wiki file will be generated.
+     * @param filename    - The name of the file being generated. Probably use `module.filename`.
+     * @param purpose     - The purpose of the file, e.g., 'wiki context for types'.
+     * @param printHeader - Whether to print the auto-generation header. Default is `true`. Only mark this `false` if you plan to add it yourself.
+     * @protected
+     */
+    protected constructor(target: PathLike, filename: string, purpose: string, printHeader?: boolean);
+    /**
+     * Gets the target path where the wiki file will be generated.
+     */
+    getTarget(): string;
+    /**
+     * Gets the name of the producer of this wiki file.
+     */
+    getProducer(): string;
+    /**
+     * Gets the set of subfiles written during the last `make` call.
+     */
+    getWrittenSubfiles(): Set<string>;
+    /**
+     * Generates or updates the wiki file at the given target location.
+     * @returns `true` if the file was created or updated, `false` if it was identical and not changed.
+     */
+    make(args: DocMakerArgs & DocMakerOutputArgs): Promise<boolean>;
+    /**
+     * Please note that for subfiles you have to always add your own header
+     */
+    protected writeSubFile(path: PathLike, data: string): boolean;
+    /**
+     * Normalizes the given wiki text for comparison.
+     */
+    protected normalizeText(text: string): string;
+    /**
+     * Determines the type of change between the old and new text.
+     */
+    protected didUpdate(path: PathLike, newText: string, oldText: string | undefined): WikiChangeType;
+    /**
+     * Generates the wiki text for the given arguments.
+     * The text will be automatically prefixed with metadata including filename and purpose.
+     */
+    protected abstract text(args: DocMakerArgs): AsyncOrSync<string>;
+}

package/documentation/wiki-mk/doc-maker.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocMaker = exports.WikiChangeType = void 0;
+var WikiChangeType;
+(function (WikiChangeType) {
+    WikiChangeType[WikiChangeType["Changed"] = 0] = "Changed";
+    WikiChangeType[WikiChangeType["UnimportantChange"] = 1] = "UnimportantChange";
+    WikiChangeType[WikiChangeType["Identical"] = 2] = "Identical";
+})(WikiChangeType || (exports.WikiChangeType = WikiChangeType = {}));
+const DefaultReplacementPatterns = [
+    // eslint-disable-next-line no-irregular-whitespace -- we may produce it in output
+    [/[0-9]+(\.[0-9]+)?( |\s*)?ms/g, ''],
+    [/tmp[%A-Za-z0-9-]+/g, ''],
+    [/"(timing|searchTimeMs|processTimeMs|id|treeSitterId)":\s*[0-9]+(\.[0-9])?,?/g, ''],
+    [/"format":"compact".+/gmius, ''],
+    [/%%\s*\d*-+/g, ''],
+    [/"[rR]": "\d+\.\d+\.\d+.*?"/g, ''],
+    [/R\s*\d+\.\d+\.\d+/g, ''],
+    // async wrapper depends on whether the promise got forfilled already
+    [/%20async%20/g, ' ']
+];
+/**
+ * Abstract base class for generating wiki files.
+ * **Please make sure to register your WikiMaker implementation in the CLI wiki tool to have it executed:
+ * `src/cli/wiki.ts`.**
+ *
+ * If this wiki page produces multiple pages ("sub files"), you can use `writeSubFile` inside the `text` method
+ * to write those additional files.
+ */
+class DocMaker {
+    target;
+    filename;
+    purpose;
+    printHeader;
+    currentArgs;
+    writtenSubfiles = new Set();
+    /**
+     * Creates a new WikiMaker instance.
+     * @param target      - The target path where the wiki file will be generated.
+     * @param filename    - The name of the file being generated. Probably use `module.filename`.
+     * @param purpose     - The purpose of the file, e.g., 'wiki context for types'.
+     * @param printHeader - Whether to print the auto-generation header. Default is `true`. Only mark this `false` if you plan to add it yourself.
+     * @protected
+     */
+    constructor(target, filename, purpose, printHeader = true) {
+        this.filename = filename;
+        this.purpose = purpose;
+        this.target = target;
+        this.printHeader = printHeader;
+    }
+    /**
+     * Gets the target path where the wiki file will be generated.
+     */
+    getTarget() {
+        return this.target.toString();
+    }
+    /**
+     * Gets the name of the producer of this wiki file.
+     */
+    getProducer() {
+        return this.filename;
+    }
+    /**
+     * Gets the set of subfiles written during the last `make` call.
+     */
+    getWrittenSubfiles() {
+        return this.writtenSubfiles;
+    }
+    /**
+     * Generates or updates the wiki file at the given target location.
+     * @returns `true` if the file was created or updated, `false` if it was identical and not changed.
+     */
+    async make(args) {
+        this.currentArgs = args;
+        this.writtenSubfiles = new Set();
+        const newText = (this.printHeader ? (await args.ctx.header(this.filename, this.purpose)) + '\n' : '') + await this.text(args);
+        if (args.force || this.didUpdate(this.target, newText, args.readFileSync(this.target)?.toString()) === WikiChangeType.Changed) {
+            args.writeFileSync(this.target, newText);
+            return true;
+        }
+        return this.writtenSubfiles.size > 0;
+    }
+    /**
+     * Please note that for subfiles you have to always add your own header
+     */
+    writeSubFile(path, data) {
+        if (!this.currentArgs) {
+            throw new Error('DocMaker: writeSubFile called outside of make()');
+        }
+        if (this.currentArgs.force || this.didUpdate(path, data, this.currentArgs.readFileSync(path)?.toString()) === WikiChangeType.Changed) {
+            this.currentArgs.writeFileSync(path.toString(), data);
+            this.writtenSubfiles.add(path.toString());
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Normalizes the given wiki text for comparison.
+     */
+    normalizeText(text) {
+        // drop first two meta lines
+        let result = text.split('\n').slice(2).join('\n');
+        for (const [pattern, replacement] of DefaultReplacementPatterns) {
+            result = result.replace(pattern, replacement);
+        }
+        return result.trim();
+    }
+    /**
+     * Determines the type of change between the old and new text.
+     */
+    didUpdate(path, newText, oldText) {
+        if (oldText === newText) {
+            return WikiChangeType.Identical;
+        }
+        const normOld = this.normalizeText(oldText ?? '');
+        const normNew = this.normalizeText(newText);
+        const same = normOld === normNew;
+        if (!same) {
+            // find first diff
+            for (let i = 0; i < Math.min(normOld.length, normNew.length); i++) {
+                if (normOld[i] !== normNew[i]) {
+                    const contextOld = normOld.slice(Math.max(0, i - 20), Math.min(normOld.length, i + 20));
+                    const contextNew = normNew.slice(Math.max(0, i - 20), Math.min(normNew.length, i + 20));
+                    console.log(`      [${path.toString()}] First diff at pos ${i}:\n      - Old: ...${contextOld}...\n      + New: ...${contextNew}...`);
+                    break;
+                }
+            }
+        }
+        return same ? WikiChangeType.UnimportantChange : WikiChangeType.Changed;
+    }
+}
+exports.DocMaker = DocMaker;
+//# sourceMappingURL=doc-maker.js.map

package/documentation/wiki-normalized-ast.d.ts

@@ -0,0 +1,9 @@
+import type { DocMakerArgs } from './wiki-mk/doc-maker';
+import { DocMaker } from './wiki-mk/doc-maker';
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Normalized-AST
+ */
+export declare class WikiNormalizedAst extends DocMaker {
+    constructor();
+    protected text({ ctx, treeSitter }: DocMakerArgs): Promise<string>;
+}

package/documentation/{print-normalized-ast-wiki.js → wiki-normalized-ast.js}

@@ -1,18 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.WikiNormalizedAst = void 0;
 const shell_1 = require("../r-bridge/shell");
-const log_1 = require("../../test/functionality/_helper/log");
-const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
 const doc_code_1 = require("./doc-util/doc-code");
 const doc_normalized_ast_1 = require("./doc-util/doc-normalized-ast");
-const doc_types_1 = require("./doc-util/doc-types");
-const path_1 = __importDefault(require("path"));
 const doc_files_1 = require("./doc-util/doc-files");
 const doc_cli_option_1 = require("./doc-util/doc-cli-option");
-const time_1 = require("../util/text/time");
 const doc_structure_1 = require("./doc-util/doc-structure");
 const pipeline_executor_1 = require("../core/pipeline-executor");
 const retriever_1 = require("../r-bridge/retriever");
@@ -21,17 +14,29 @@ const collect_1 = require("../r-bridge/lang-4.x/ast/model/collect");
 const normalized_ast_fold_1 = require("../abstract-interpretation/normalized-ast-fold");
 const default_pipelines_1 = require("../core/steps/pipeline/default-pipelines");
 const flowr_analyzer_1 = require("../project/flowr-analyzer");
-async function getText(shell) {
-    const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';
-    const now = performance.now();
-    const types = (0, doc_types_1.getTypesFromFolder)({
-        rootFolder: path_1.default.resolve('./src'),
-        typeNameForMermaid: 'RNode',
-        inlineTypes: doc_types_1.mermaidHide
-    });
-    const elapsed = performance.now() - now;
-    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'normalized ast', rVersion: rversion })}
-
+const flowr_analyzer_builder_1 = require("../project/flowr-analyzer-builder");
+const flowr_file_1 = require("../project/context/flowr-file");
+const doc_maker_1 = require("./wiki-mk/doc-maker");
+async function quickNormalizedAstMultipleFiles() {
+    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder()
+        .setEngine('tree-sitter')
+        .build();
+    analyzer.addFile(new flowr_file_1.FlowrInlineTextFile('foo.R', 'x <- 12; source("a.R")'));
+    analyzer.addFile(new flowr_file_1.FlowrInlineTextFile('a.R', 'y <- x + 3'));
+    analyzer.addFile(new flowr_file_1.FlowrInlineTextFile('b.R', 'print(x, y)'));
+    analyzer.addRequest({ request: 'file', content: 'a.R' }, { request: 'file', content: 'b.R' }, { request: 'file', content: 'foo.R' });
+    const n = await analyzer.normalize();
+    return n;
+}
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Normalized-AST
+ */
+class WikiNormalizedAst extends doc_maker_1.DocMaker {
+    constructor() {
+        super('wiki/Normalized AST.md', module.filename, 'normalized ast');
+    }
+    async text({ ctx, treeSitter }) {
+        return `
 _flowR_ produces a normalized version of R's abstract syntax tree (AST),
 offering the following benefits:
 
@@ -48,14 +53,15 @@ ${(0, doc_code_1.codeBlock)('r', 'x <- 2 * 3 + 1')}
 Each node in the AST contains the type, the id, and the lexeme (if applicable).
 Each edge is labeled with the type of the parent-child relationship (the "role").
 
-${await (0, doc_normalized_ast_1.printNormalizedAstForCode)(shell, 'x <- 2 * 3 + 1', { showCode: false, prefix: 'flowchart LR\n' })}
+${await (0, doc_normalized_ast_1.printNormalizedAstForCode)(treeSitter, 'x <- 2 * 3 + 1', { showCode: false, prefix: 'flowchart LR\n' })}
 
 > [!TIP]
 > If you want to investigate the normalized AST, 
 > you can either use the [Visual Studio Code extension](${doc_files_1.FlowrGithubBaseRef}/vscode-flowr) or the ${(0, doc_cli_option_1.getReplCommand)('normalize*')} 
 > command in the REPL (see the [Interface wiki page](${doc_files_1.FlowrWikiBaseRef}/Interface) for more information).
 
-Indicative of the normalization is the root expression list node, which is present in every normalized AST.
+Indicative of the normalization is the root ${ctx.link('RProject')} node, which is present in every normalized AST
+and provides the ${ctx.link('RExpressionList')} nodes for each file in the project.
 In general, we provide node types for:
 
 1. literals (e.g., numbers and strings)
@@ -71,19 +77,18 @@ In general, we provide node types for:
 Every node is a link, which directly refers to the implementation in the source code.
 Grayed-out parts are used for structuring the AST, grouping together related nodes.
 
-${(0, doc_code_1.codeBlock)('mermaid', types.mermaid)}
+${(0, doc_code_1.codeBlock)('mermaid', ctx.mermaid('RNode'))}
 
-_The generation of the class diagram required ${(0, time_1.printAsMs)(elapsed)}._
 </details>
 
-Node types are controlled by the ${(0, doc_types_1.shortLink)('RType', types.info)} enum (see ${(0, doc_files_1.getFilePathMd)('../r-bridge/lang-4.x/ast/model/type.ts')}), 
+Node types are controlled by the ${ctx.link('RType')} enum (see ${(0, doc_files_1.getFilePathMd)('../r-bridge/lang-4.x/ast/model/type.ts')}), 
 which is used to distinguish between different types of nodes.
 Additionally, every AST node is generic with respect to the \`Info\` type which allows for arbitrary decorations (e.g., parent inforamtion or dataflow constraints).
 Most notably, the \`info\` field holds the \`id\` of the node, which is used to reference the node in the [dataflow graph](${doc_files_1.FlowrWikiBaseRef}/Dataflow%20Graph).
 
 In summary, we have the following types:
 
-${(0, doc_structure_1.details)('Normalized AST Node Types', (0, doc_types_1.printHierarchy)({ program: types.program, info: types.info, root: 'RNode', collapseFromNesting: Number.MAX_VALUE }))}
+${(0, doc_structure_1.details)('Normalized AST Node Types', ctx.hierarchy('RNode', { collapseFromNesting: Number.MAX_VALUE }))}
 
 The following segments intend to give you an overview of how to work with the normalized AST:
 
@@ -93,7 +98,7 @@ The following segments intend to give you an overview of how to work with the no
 ## How to Get a Normalized AST
 
 As explained alongside the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface#creating-flowr-analyses) wiki page, you can use an instance of
-${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, types.info)} to get the ${(0, doc_types_1.shortLink)('NormalizedAst', types.info)}:
+${ctx.link(flowr_analyzer_1.FlowrAnalyzer)} to get the ${ctx.link('NormalizedAst')}:
 
 ${(0, doc_code_1.codeBlock)('ts', `
 async function getAst(code: string): Promise<RNode> {
@@ -104,17 +109,37 @@ async function getAst(code: string): Promise<RNode> {
 
 From the REPL, you can use the ${(0, doc_cli_option_1.getReplCommand)('normalize')} command.
 
+### Multi-File Projects
+
+With the ${ctx.link(flowr_analyzer_1.FlowrAnalyzer)}, you can analyze multiple files at once:
+
+${ctx.code(quickNormalizedAstMultipleFiles, { dropLinesStart: 1, dropLinesEnd: 2, hideDefinedAt: true })}
+
+Visualizing the resulting AST yields the following.
+
+<details>
+
+<summary style="color:gray">Mermaid Diagram</summary>
+
+${(0, doc_normalized_ast_1.printNormalizedAst)((await quickNormalizedAstMultipleFiles()).ast, 'flowchart LR\n')}
+
+</details>
+
+
 ## Traversing the Normalized AST
 
 We provide two ways to traverse the normalized AST: [Visitors](#visitors) and [Folds](#folds).
+Please note, that they usually operate on the ${ctx.link('RExpressionList')} level, and it is up to
+you to decide how you want to traverse multiple files with a ${ctx.link('RProject')} in the AST (you can, for example, simplify flat-map over the files).
+The ${ctx.link('RProject')} node cannot appear nested within other nodes, so you can safely assume that any child of a node is not an ${ctx.link('RProject')}.
 
 ### Visitors
 
-If you want a simple visitor which traverses the AST, the ${(0, doc_types_1.shortLink)(visitor_1.visitAst.name, types.info)} function is a good starting point.
+If you want a simple visitor which traverses the AST, the ${ctx.link(visitor_1.visitAst)} function is a good starting point.
 You may specify functions to be called whenever you enter and exit a node during the traversal, and any
 computation is to be done by side effects.
 For example, if you want to collect all the \`id\`s present within a normalized (sub-)AST,
-as it is done by the ${(0, doc_types_1.shortLink)(collect_1.collectAllIds.name, types.info)} function, you can use the following visitor:
+as it is done by the ${ctx.link(collect_1.collectAllIds)} function, you can use the following visitor:
 
 ${(0, doc_code_1.codeBlock)('ts', `
 const ids = new Set<NodeId>();
@@ -126,12 +151,12 @@ return ids;
 
 ### Folds
 
-We formulate a fold with the base class ${(0, doc_types_1.shortLink)(normalized_ast_fold_1.DefaultNormalizedAstFold.name, types.info)} in ${(0, doc_files_1.getFilePathMd)('../abstract-interpretation/normalized-ast-fold.ts')}.
+We formulate a fold with the base class ${ctx.link(normalized_ast_fold_1.DefaultNormalizedAstFold)} in ${(0, doc_files_1.getFilePathMd)('../abstract-interpretation/normalized-ast-fold.ts')}.
 Using this class, you can create your own fold behavior by overwriting the default methods.
 By default, the class provides a monoid abstraction using the _empty_ from the constructor and the _concat_ method.
 
  
-${(0, doc_types_1.printHierarchy)({ program: types.program, info: types.info, root: 'DefaultNormalizedAstFold' })}
+${ctx.hierarchy(normalized_ast_fold_1.DefaultNormalizedAstFold)}
 
 Now, of course, we could provide hundreds of examples here, but we use tests to verify that the fold behaves as expected
 and happily point to them at ${(0, doc_files_1.getFilePathMd)('../../test/functionality/r-bridge/normalize-ast-fold.test.ts')}.
@@ -168,7 +193,7 @@ class MyMathFold<Info> extends ${normalized_ast_fold_1.DefaultNormalizedAstFold.
 }
 `)}
 
-Now, we can use the ${(0, doc_types_1.shortLink)(pipeline_executor_1.PipelineExecutor.name, types.info)} to get the normalized AST and apply the fold:
+Now, we can use the ${ctx.link(pipeline_executor_1.PipelineExecutor)} to get the normalized AST and apply the fold:
  
 ${(0, doc_code_1.codeBlock)('ts', `
 const shell = new ${shell_1.RShell.name}();
@@ -181,23 +206,15 @@ console.log(result); // -> 7
 `)}
 
 ${(0, doc_structure_1.block)({
-        type: 'NOTE',
-        content: `
+            type: 'NOTE',
+            content: `
 If you want to retrieve the normalized AST with the [Tree-Sitter Engine](${doc_files_1.FlowrWikiBaseRef}/Engines),
-you may use the ${(0, doc_types_1.shortLink)('TREE_SITTER_NORMALIZE_PIPELINE', types.info)} or directly rely on one of the
-helper functions like ${(0, doc_types_1.shortLink)(default_pipelines_1.createNormalizePipeline.name, types.info)}.
+you may use the ${ctx.link('TREE_SITTER_NORMALIZE_PIPELINE')} or directly rely on one of the
+helper functions like ${ctx.link(default_pipelines_1.createNormalizePipeline)}.
 		`
-    })}
+        })}
 `;
+    }
 }
-/** if we run this script, we want a Markdown representation of the capabilities */
-if (require.main === module) {
-    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
-    const shell = new shell_1.RShell();
-    void getText(shell).then(str => {
-        console.log(str);
-    }).finally(() => {
-        shell.close();
-    });
-}
-//# sourceMappingURL=print-normalized-ast-wiki.js.map
+exports.WikiNormalizedAst = WikiNormalizedAst;
+//# sourceMappingURL=wiki-normalized-ast.js.map

package/documentation/wiki-onboarding.d.ts

@@ -0,0 +1,8 @@
+import { DocMaker } from './wiki-mk/doc-maker';
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Onboarding
+ */
+export declare class WikiOnboarding extends DocMaker {
+    constructor();
+    text(): string;
+}

package/documentation/{print-onboarding-wiki.js → wiki-onboarding.js}

@@ -1,21 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const log_1 = require("../../test/functionality/_helper/log");
+exports.WikiOnboarding = void 0;
 const doc_files_1 = require("./doc-util/doc-files");
 const doc_code_1 = require("./doc-util/doc-code");
-const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
-function print() {
-    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'developer onboarding process' })}
-	
-To get started developing on *flowR*, we recommend carefully reading the following pages:
-- 💻 [Setting up the *flowR* development environment](${doc_files_1.FlowrWikiBaseRef}/Setup#%EF%B8%8F-building-from-scratch).\
+const doc_maker_1 = require("./wiki-mk/doc-maker");
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Onboarding
+ */
+class WikiOnboarding extends doc_maker_1.DocMaker {
+    constructor() {
+        super('wiki/Onboarding.md', module.filename, 'developer onboarding process');
+    }
+    text() {
+        return `To get started developing on *flowR*, we recommend carefully reading the following pages:
+- 💻 [Setting up the *flowR* development environment](${doc_files_1.FlowrWikiBaseRef}/Setup#%EF%B8%8F-building-from-scratch).\\
   This page explains how to install **R** and **Node.js**.  
-- 💖 [Contributing guidelines](${doc_files_1.FlowrGithubBaseRef}/flowr/tree/main/.github/CONTRIBUTING.md).\
+- 💖 [Contributing guidelines](${doc_files_1.FlowrGithubBaseRef}/flowr/tree/main/.github/CONTRIBUTING.md).\\
   This page also includes information about how to set up **git-lfs** and several **git hooks**.
 
 If you have any questions, please check out the [FAQ](${doc_files_1.FlowrWikiBaseRef}/FAQ) first, but if the question
-is not answered there (or in the wiki in general), feel free to ask a question.  
-	
+is not answered there (or in the wiki in general), feel free to ask a question.
+The [FAQ](${doc_files_1.FlowrWikiBaseRef}/FAQ) also includes information about how you can configure your editor.
 
 ## ⌛ TL;DR
 
@@ -38,9 +43,7 @@ git config --local core.hooksPath .githooks/
 git push --dry-run
 `)}
     `.trim();
+    }
 }
-if (require.main === module) {
-    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
-    console.log(print());
-}
-//# sourceMappingURL=print-onboarding-wiki.js.map
+exports.WikiOnboarding = WikiOnboarding;
+//# sourceMappingURL=wiki-onboarding.js.map

package/documentation/wiki-query.d.ts

@@ -0,0 +1,9 @@
+import type { DocMakerArgs } from './wiki-mk/doc-maker';
+import { DocMaker } from './wiki-mk/doc-maker';
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Query-API
+ */
+export declare class WikiQuery extends DocMaker {
+    constructor();
+    protected text({ ctx, shell }: DocMakerArgs): Promise<string>;
+}