@eagleoutice/flowr 2.6.2 → 2.7.0

package/dataflow/processor.d.ts

@@ -3,11 +3,10 @@
  */
 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 { REnvironmentInformation } from './environments/environment';
 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,26 +23,18 @@ 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).
      */
     readonly controlDependencies: ControlDependency[] | undefined;
     /**
-     * The built-in environment
-     */
-    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> & {

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,7 +8,6 @@ export interface SubExplanationParameters {
     readonly expectedSubgraph: DataflowGraph;
 }
 export interface ExplanationParameters {
-    readonly shell: RShell;
     readonly name: string;
     readonly type: VertexType | EdgeType;
     readonly description: string;

package/documentation/data/faq/faqs.js

@@ -4,6 +4,7 @@ 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");
 /**
  *
  */
@@ -11,12 +12,12 @@ 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. 
+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\` 
+	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).
@@ -29,14 +30,16 @@ There are several ways to generate mermaid diagrams based on the input data that
 `)
         .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 \`print-my-page-wiki.ts\`.
-- Add a new wiki generation script to the ${(0, doc_files_1.getFilePathMd)('../../package.json')}. You can copy one of the existing ones of the form \`"wiki:my-page": "ts-node src/documentation/print-my-page-wiki.ts"\`.
-- Add the wiki generation script to the \`broken-links-and-wiki.yml\` GitHub workflow file to enable automatic generation through the CI. You can copy one of the existing ones of the form \`update_page wiki/"My page" wiki:my-page\`.
+- 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 --silent wiki:my-page > __my-page.md')}
+${(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')}
 
-Remember not to commit this file, as it's only meant for testing.
 `)
         .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:
@@ -48,31 +51,37 @@ Check out the [Logging Section in the Linting and Testing wiki page](${doc_files
     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 
+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 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. 
+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\` 
+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. 
+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. 
+🖥️ 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

@@ -2,6 +2,7 @@ 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;
 /**

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

@@ -7,7 +7,8 @@ const assert_1 = require("../../../util/assert");
 const FlowrFaqTopics = {
     'flowr.use': '✨ Using <i>flowR</i>',
     'flowr.development': '🧑‍💻 <i>flowR</i> Development',
-    'r.packages': '📦 R Packages'
+    'r.packages': '📦 R Packages',
+    'editor.configs': '⚙️ Recommended Editor Configs'
 };
 /**
  * Manage all questions and answers by topic.
@@ -55,6 +56,9 @@ ${(0, doc_structure_1.collapsibleToc)({
             },
             ['🇷 R FAQ']: {
                 [FlowrFaqTopics['r.packages']]: {}
+            },
+            ['💻 Editor FAQ']: {
+                [FlowrFaqTopics['editor.configs']]: {}
             }
         })}
 
@@ -64,7 +68,11 @@ ${this.printAllTopics(/^flowr.*$/)}
 
 ${(0, doc_structure_1.section)('🇷 R FAQ', 2)}
 
-${this.printAllTopics(/^r.*$/)}  
+${this.printAllTopics(/^r.*$/)}
+
+${(0, doc_structure_1.section)('💻 Editor FAQ', 2)}
+
+${this.printAllTopics(/^editor.*$/)}
 		`;
     }
 }

package/documentation/data/server/doc-data-server-messages.js

@@ -84,7 +84,7 @@ ${await (0, doc_server_message_1.documentServerMessageResponse)({
                 messages: [
                     {
                         type: 'request',
-                        description: `Let' suppose you simply want to analyze the following script:\n ${(0, doc_code_1.codeBlock)('r', 'x <- 1\nx + 1')}\n For this, you can send the following request:`,
+                        description: `Let's suppose you simply want to analyze the following script:\n ${(0, doc_code_1.codeBlock)('r', 'x <- 1\nx + 1')}\n For this, you can send the following request:`,
                         message: {
                             type: 'request-file-analysis',
                             id: '1',

package/documentation/doc-capabilities.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/Capabilities
+ */
+export declare class DocCapabilities extends DocMaker {
+    constructor();
+    protected text({ treeSitter }: DocMakerArgs): Promise<string>;
+}

package/documentation/{print-capabilities-markdown.js → doc-capabilities.js}

@@ -3,14 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocCapabilities = void 0;
 const data_1 = require("../r-bridge/data/data");
-const log_1 = require("../../test/functionality/_helper/log");
-const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
 const strings_1 = require("../util/text/strings");
 const doc_general_1 = require("./doc-util/doc-general");
-const tree_sitter_executor_1 = require("../r-bridge/lang-4.x/tree-sitter/tree-sitter-executor");
 const fs_1 = __importDefault(require("fs"));
 const doc_structure_1 = require("./doc-util/doc-structure");
+const doc_maker_1 = require("./wiki-mk/doc-maker");
 const detailedInfoFile = 'coverage/flowr-test-details.json';
 function obtainDetailedInfos() {
     if (!fs_1.default.existsSync(detailedInfoFile)) {
@@ -130,8 +129,7 @@ async function printAsMarkdown(info, capabilities, depth = 0, lines = []) {
     return lines.join('\n');
 }
 function getPreamble() {
-    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'current capabilities' })}
-
+    return `
 Each capability has an id that can be used to link to it (use the link symbol to get a direct link to the capability).
 The internal id is also mentioned in the capability description. This id can be used to reference the capability in a labeled test within flowR.
 Besides, we use colored bullets like this:
@@ -154,21 +152,20 @@ Please prefer using a statement like "flowR has only partial support for feature
     })}
 `;
 }
-async function print(parser) {
-    /* check if the detailed test data is available */
-    if (!fs_1.default.existsSync(detailedInfoFile)) {
-        console.warn('\x1b[31mNo detailed test data available. Run the full tests (npm run test-full) to generate it.\x1b[m');
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Capabilities
+ */
+class DocCapabilities extends doc_maker_1.DocMaker {
+    constructor() {
+        super('wiki/Capabilities.md', module.filename, 'flowR capabilities overview');
+    }
+    async text({ treeSitter }) {
+        /* check if the detailed test data is available */
+        if (!fs_1.default.existsSync(detailedInfoFile)) {
+            console.warn('\x1b[31mNo detailed test data available. Run the full tests (npm run test-full) to generate it.\x1b[m');
+        }
+        return getPreamble() + await printAsMarkdown({ parser: treeSitter, info: obtainDetailedInfos() }, data_1.flowrCapabilities.capabilities);
     }
-    return getPreamble() + await printAsMarkdown({ parser, info: obtainDetailedInfos() }, data_1.flowrCapabilities.capabilities);
-}
-/** if we run this script, we want a Markdown representation of the capabilities */
-if (require.main === module) {
-    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
-    void tree_sitter_executor_1.TreeSitterExecutor.initTreeSitter().then(() => {
-        const parser = new tree_sitter_executor_1.TreeSitterExecutor();
-        void print(parser).then(str => {
-            console.log(str);
-        });
-    });
 }
-//# sourceMappingURL=print-capabilities-markdown.js.map
+exports.DocCapabilities = DocCapabilities;
+//# sourceMappingURL=doc-capabilities.js.map

package/documentation/doc-readme.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/blob/main/README.md
+ */
+export declare class DocReadme extends DocMaker {
+    constructor();
+    text({ treeSitter }: DocMakerArgs): Promise<string>;
+}

package/documentation/{print-readme.js → doc-readme.js}

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const shell_1 = require("../r-bridge/shell");
-const log_1 = require("../../test/functionality/_helper/log");
-const tree_sitter_executor_1 = require("../r-bridge/lang-4.x/tree-sitter/tree-sitter-executor");
+exports.DocReadme = void 0;
 const doc_files_1 = require("./doc-util/doc-files");
 const doc_code_1 = require("./doc-util/doc-code");
 const doc_cli_option_1 = require("./doc-util/doc-cli-option");
@@ -17,6 +15,7 @@ const doc_dfg_1 = require("./doc-util/doc-dfg");
 const doc_query_1 = require("./doc-util/doc-query");
 const doc_issue_1 = require("./doc-util/doc-issue");
 const strings_1 = require("../util/text/strings");
+const doc_maker_1 = require("./wiki-mk/doc-maker");
 const PublicationsMain = [
     {
         header: 'Statically Analyzing the Dataflow of R Programs (OOPSLA \'25)',
@@ -113,9 +112,16 @@ ${(0, doc_general_1.prefixLines)((0, doc_code_1.codeBlock)('bibtex', pub.bibtex)
     }).join('\n\n') + '\n\n Works using flowR include:\n' +
         (0, strings_1.joinWithLast)(OtherWorksUsingFlowr.map(pub => `[${pub.name}](${pub.doi})`)) + '.\n';
 }
-async function getText(shell) {
-    const dateOptions = { year: 'numeric', month: 'short', day: 'numeric' };
-    return `
+/**
+ * https://github.com/flowr-analysis/flowr/blob/main/README.md
+ */
+class DocReadme extends doc_maker_1.DocMaker {
+    constructor() {
+        super('README.md', module.filename, 'flowR README', false);
+    }
+    async text({ treeSitter }) {
+        const dateOptions = { year: 'numeric', month: 'short', day: 'numeric' };
+        return `
 [![flowR logo](https://raw.githubusercontent.com/wiki/flowr-analysis/flowr/img/flowR.png)](${doc_files_1.FlowrGithubBaseRef}/flowr/wiki)\\
 [![QA (and potentially deploy)](${doc_files_1.FlowrGithubBaseRef}/flowr/actions/workflows/qa.yaml/badge.svg)](${doc_files_1.FlowrGithubBaseRef}/flowr/actions/workflows/qa.yaml)
 [![codecov](https://codecov.io/gh/flowr-analysis/flowr/graph/badge.svg)](https://codecov.io/gh/flowr-analysis/flowr)
@@ -136,18 +142,18 @@ It offers a wide variety of features, for example:
 	${(0, doc_general_1.prefixLines)((0, doc_structure_1.details)('Example: Linting code with flowR', `To lint your code, you can use the [REPL](${doc_files_1.FlowrWikiBaseRef}/Interface#using-the-repl) or the [Visual Studio Code extension](${doc_files_1.FlowrVsCode}) (see [vscode-flowr#283](https://github.com/flowr-analysis/vscode-flowr/pull/283)).
 	
 ${await (async () => {
-        const code = 'read.csv("/root/x.txt")';
-        const res = await (0, doc_query_1.showQuery)(shell, code, [{ type: 'linter' }], { showCode: false, collapseQuery: true, collapseResult: false });
-        return await (0, doc_repl_1.documentReplSession)(shell, [{
-                command: `:query @linter ${JSON.stringify(code)}`,
-                description: `
+            const code = 'read.csv("/root/x.txt")';
+            const res = await (0, doc_query_1.showQuery)(treeSitter, code, [{ type: 'linter' }], { showCode: false, collapseQuery: true, collapseResult: false });
+            return await (0, doc_repl_1.documentReplSession)(treeSitter, [{
+                    command: `:query @linter ${JSON.stringify(code)}`,
+                    description: `
 The linter will analyze the code and return any issues found.
 Formatted more nicely, this returns:
 
 ${res}
 		`
-            }]);
-    })()}
+                }]);
+        })()}
 	   
 	   `), '    ')}
 
@@ -169,10 +175,10 @@ ${(0, doc_code_1.codeBlock)('r', (0, doc_files_1.getFileContentFromRoot)('test/t
 Let's suppose we are interested only in the \`sum\` which is printed in line 11.
 To get a slice for this, you can use the following command:
 
-${await (0, doc_repl_1.documentReplSession)(shell, [{
-            command: ':slicer test/testfiles/example.R --criterion "11@sum"',
-            description: ''
-        }])}
+${await (0, doc_repl_1.documentReplSession)(treeSitter, [{
+                command: ':query @static-slice (11@sum) file://test/testfiles/example.R',
+                description: ''
+            }])}
    
    `), '    ')}
 
@@ -203,12 +209,12 @@ ${(0, doc_code_1.codeBlock)('r', (0, doc_files_1.getFileContentFromRoot)('test/t
 
 To get the dataflow graph for this script, you can use the following command:
 
-${await (0, doc_repl_1.documentReplSession)(shell, [{
-            command: ':dataflow* test/testfiles/example.R',
-            description: `
+${await (0, doc_repl_1.documentReplSession)(treeSitter, [{
+                command: ':dataflow* test/testfiles/example.R',
+                description: `
 Following the link output should show the following:
-${await (0, doc_dfg_1.printDfGraphForCode)(shell, (0, doc_files_1.getFileContentFromRoot)('test/testfiles/example.R'), { showCode: false })}`
-        }])}
+${await (0, doc_dfg_1.printDfGraphForCode)(treeSitter, (0, doc_files_1.getFileContentFromRoot)('test/testfiles/example.R'), { showCode: false })}`
+            }])}
    
    `), '    ')}
 
@@ -285,17 +291,7 @@ If you want to make changes please edit the source file (the CI will take care o
 In fact, many files in the [wiki](${doc_files_1.FlowrWikiBaseRef}) are generated, so make sure to check for the source file if you want to make changes.
 
 `.trim();
+    }
 }
-/** if we run this script, we want a Markdown representation of the capabilities */
-if (require.main === module) {
-    void tree_sitter_executor_1.TreeSitterExecutor.initTreeSitter().then(() => {
-        (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-readme.js.map
+exports.DocReadme = DocReadme;
+//# sourceMappingURL=doc-readme.js.map

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

@@ -17,19 +17,21 @@ interface BenchmarkElementBench {
     readonly extra: string;
 }
 /**
- *
+ * Loads the benchmark data from the predefined path.
+ * This is the location which is used by the CI to store benchmark results.
  */
 export declare function loadBenchmarkData(): Promise<BenchmarkData>;
 /**
- *
+ * Returns the latest benchmark for the given suite.
  */
 export declare function getLatestBenchmark(suite: string): Promise<BenchmarkElement>;
 /**
- *
+ * Returns the timestamp of the last benchmark update.
+ * We can use this to find out when the last (recorded) benchmark run was.
  */
 export declare function getLastBenchmarkUpdate(): Promise<number>;
 /**
- *
+ * Get the total time taken for dataflow analysis in the given suite.
  */
 export declare function getLatestDfAnalysisTime(suite: string): Promise<number>;
 export {};

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

@@ -45,7 +45,8 @@ const assert_1 = require("../../util/assert");
 const BenchmarkDataPath = path_1.default.resolve(__dirname, '..', '..', '..', 'wiki', 'stats', 'benchmark', 'data.js');
 let benchmarkData = null;
 /**
- *
+ * Loads the benchmark data from the predefined path.
+ * This is the location which is used by the CI to store benchmark results.
  */
 async function loadBenchmarkData() {
     if (benchmarkData === null) {
@@ -58,7 +59,7 @@ async function loadBenchmarkData() {
     return benchmarkData;
 }
 /**
- *
+ * Returns the latest benchmark for the given suite.
  */
 async function getLatestBenchmark(suite) {
     // provide a window object to attach to in the import
@@ -67,7 +68,8 @@ async function getLatestBenchmark(suite) {
     return suiteData.sort((a, b) => b.date - a.date)[0];
 }
 /**
- *
+ * Returns the timestamp of the last benchmark update.
+ * We can use this to find out when the last (recorded) benchmark run was.
  */
 async function getLastBenchmarkUpdate() {
     return (await loadBenchmarkData()).lastUpdate;
@@ -78,7 +80,7 @@ function getBenchmarkElement(bench, name) {
     return element;
 }
 /**
- *
+ * Get the total time taken for dataflow analysis in the given suite.
  */
 async function getLatestDfAnalysisTime(suite) {
     const elem = await getLatestBenchmark(suite);

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

@@ -5,23 +5,20 @@ exports.printCfg = printCfg;
 exports.printCfgCode = printCfgCode;
 const extract_cfg_1 = require("../../control-flow/extract-cfg");
 const default_pipelines_1 = require("../../core/steps/pipeline/default-pipelines");
-const retriever_1 = require("../../r-bridge/retriever");
 const time_1 = require("../../util/text/time");
 const doc_files_1 = require("./doc-files");
 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");
+const flowr_analyzer_context_1 = require("../../project/context/flowr-analyzer-context");
 /**
  * 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)
-    }, config_1.defaultConfigOptions).allRemainingSteps() : await (0, default_pipelines_1.createNormalizePipeline)(parser, {
-        request: (0, retriever_1.requestFromInput)(code)
-    }, config_1.defaultConfigOptions).allRemainingSteps();
-    const cfg = (0, extract_cfg_1.extractCfg)(result.normalize, config_1.defaultConfigOptions, useDfg ? result.dataflow.graph : undefined, [...cfg_simplification_1.DefaultCfgSimplificationOrder, ...simplifications]);
+    const context = (0, flowr_analyzer_context_1.contextFromInput)(code);
+    const result = await (useDfg ? (0, default_pipelines_1.createDataflowPipeline)(parser, { context })
+        : (0, default_pipelines_1.createNormalizePipeline)(parser, { context })).allRemainingSteps();
+    const cfg = (0, extract_cfg_1.extractCfg)(result.normalize, context, useDfg ? result.dataflow.graph : undefined, [...cfg_simplification_1.DefaultCfgSimplificationOrder, ...simplifications]);
     return {
         info: cfg,
         ast: result.normalize,

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

@@ -1,11 +1,11 @@
-import type { DataflowGraph, UnknownSidEffect } from '../../dataflow/graph/graph';
-import type { RShell } from '../../r-bridge/shell';
+import type { DataflowGraph, UnknownSideEffect } from '../../dataflow/graph/graph';
 import { type MermaidMarkdownMark } from '../../util/mermaid/dfg';
-import { DEFAULT_DATAFLOW_PIPELINE } from '../../core/steps/pipeline/default-pipelines';
+import type { DEFAULT_DATAFLOW_PIPELINE } from '../../core/steps/pipeline/default-pipelines';
 import type { PipelineOutput } from '../../core/steps/pipeline/pipeline';
 import type { KnownParser } from '../../r-bridge/parser';
 /**
- *
+ * 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.
  */
 export declare function printDfGraph(graph: DataflowGraph, mark?: ReadonlySet<MermaidMarkdownMark>, simplified?: boolean): string;
 export interface PrintDataflowGraphOptions {
@@ -17,9 +17,9 @@ export interface PrintDataflowGraphOptions {
     readonly simplified?: boolean;
 }
 /**
- *
+ * Visualizes a side effect for documentation purposes.
  */
-export declare function formatSideEffect(ef: UnknownSidEffect): string;
+export declare function formatSideEffect(ef: UnknownSideEffect): string;
 export declare function printDfGraphForCode(parser: KnownParser, code: string, options: PrintDataflowGraphOptions & {
     exposeResult: true;
 }): Promise<[string, PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>]>;
@@ -27,4 +27,4 @@ export declare function printDfGraphForCode(parser: KnownParser, code: string, o
     exposeResult?: false | undefined;
 }): Promise<string>;
 /** returns resolved expected df graph */
-export declare function verifyExpectedSubgraph(shell: RShell, code: string, expectedSubgraph: DataflowGraph): Promise<DataflowGraph>;
+export declare function verifyExpectedSubgraph(parser: KnownParser, code: string, expectedSubgraph: DataflowGraph): Promise<DataflowGraph>;