@eagleoutice/flowr 2.7.0 → 2.7.2

package/documentation/wiki-overview.js

@@ -0,0 +1,248 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WikiOverview = void 0;
+const doc_maker_1 = require("./wiki-mk/doc-maker");
+const doc_files_1 = require("./doc-util/doc-files");
+const shell_1 = require("../r-bridge/shell");
+const graph_1 = require("../dataflow/graph/graph");
+const flowr_analyzer_1 = require("../project/flowr-analyzer");
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Overview
+ */
+class WikiOverview extends doc_maker_1.DocMaker {
+    constructor() {
+        super('wiki/Overview.md', module.filename, 'modules');
+    }
+    text({ ctx }) {
+        return `
+First of all, if you have never used _flowR_ before,
+please refer to the ${ctx.linkPage('wiki/Setup')} wiki page first, 
+for instructions on how to install _flowR_.
+
+<!-- TOC -->
+- [_flowR_'s Modules](#flowrs-modules)
+- [Using _flowR_ from the outside](#using-flowr-from-the-outside)
+  - [The Read-Eval-Print Loop (REPL)](#the-read-eval-print-loop-repl)
+  - [The Server](#the-server)
+- [Calling the Scripts Directly](#calling-the-scripts-directly)
+  - [Generate Static Slices](#generate-static-slices)
+  - [Benchmark the Slicer](#benchmark-the-slicer)
+    - [Summarizing the Benchmark Results](#summarizing-the-benchmark-results)
+  - [Generate Usage Statistics of R Code](#generate-usage-statistics-of-r-code)
+<!-- TOC -->
+
+## _flowR_'s Modules
+
+[![flowRview](https://raw.githubusercontent.com/wiki/flowr-analysis/flowr/img/flowr-overview.jpg)](${doc_files_1.FlowrGithubBaseRef}/flowr/wiki)
+
+Primarily, _flowR_ provides a dataflow analysis framework for the [*R*](https://www.r-project.org/) programming language.
+Its subcomponents (like the custom ${ctx.link(shell_1.RShell)}) or the internals of the static ${ctx.link(graph_1.DataflowGraph)}) 
+are not important if you simply wish to use _flowR_.
+If you wish to use _flowR_, check out one of its extensions (e.g., the [VS Code extension](${doc_files_1.FlowrVsCode})), 
+the [REPL and server interfaces](#using-_flowr_-from-the-outside) or its coding API with the
+${ctx.link(flowr_analyzer_1.FlowrAnalyzer)}. 
+
+The benchmark module is only of interest if you want to benchmark/measure the runtime performance and reduction of the slicer. 
+It is available with the [\`benchmark\`](#benchmark-the-slicer) script.
+
+The statistics module is mostly independent of the slicer and can be used to analyze R files regarding their use of function definitions, assignments, and more.  It is used to identify common patterns in R code and is available with the [\`statistics\`](#generate-usage-statistics-of-r-code) script.
+
+The [core](https://github.com/flowr-analysis/flowr/tree/main/src/core) module contains _flowR_'s read-eval-print loop (REPL) and 
+_flowR_'s server. Furthermore, it contains the root definitions of how _flowR_ slices (see the ${ctx.linkPage('wiki/Interface')} wiki page for more information).
+
+The [utility](https://github.com/flowr-analysis/flowr/tree/main/src/util) module is of no further interest for the usage of _flowR_
+
+The following sections explain how to use these features.
+
+## Using _flowR_ from the outside
+
+_flowR_ itself has two main ways to operate:
+
+- as a [**server**](#the-server) which processes analysis and slicing requests (${ctx.cliOption('flowr', 'server')} option)
+- as a [**read-eval-print loop** (REPL)](#the-read-eval-print-loop-repl) that can be accessed directly from the command line (default option)
+
+Besides these two ways, there is a [Visual Studio Code extension](${doc_files_1.FlowrVsCode}) that allows you to use _flowR_ directly from within the editor (it is available on [open-vsx](${doc_files_1.FlowrPositron}) as well).
+Similarly, we offer an [Addin for RStudio](${doc_files_1.FlowrRStudioAddin}), as well as an [R package](${doc_files_1.FlowrRAdapter}).
+
+🐳️ If you use the docker-version, simply starting the docker container in interactive mode drops you right into the REPL (\`docker run -it --rm eagleoutice/flowr:latest\`), while launching with the ${ctx.cliOption('flowr', 'server')} argument starts the server (\`docker run -it --rm eagleoutice/flowr:latest --server\`).\\
+⚒️ If you compile the _flowR_ sources yourself, you can access _flowR_ by the main script \`npm run flowr\` or in the development mode \`npm run main-dev\`.
+
+Independent of your way of launching *flowr*, we will write simply \`flowr\` for either (🐳️)&nbsp;\`docker run -it --rm eagleoutice/flowr:latest\` or (⚒️)&nbsp;\`npm run flowr\`.
+See the ${ctx.linkPage('wiki/Setup')} wiki page for more information on how to get _flowR_ running.
+
+### The Read-Eval-Print Loop (REPL)
+
+Once you launched _flowR_, you should see a small&nbsp;\`R>\` prompt. Use \`:help\` to receive instructions on how to use the REPL and what features are available (most prominently, you can access all [scripts](#calling-the-scripts-directly) simply by adding a colon before them).
+In general, all commands start with a colon (\`:\`), everything else is interpreted as a&nbsp;R expression which is directly evaluated by the underlying R shell 
+(however, due to security concerns, you need to start _flowR_ with ${ctx.cliOption('flowr', 'r-session-access')} and use the \`r-shell\` ${ctx.linkPage('wiki/Engines', 'engine')} to allow this).
+See the ${ctx.linkPage('wiki/Interface')} wiki page for more information on usage and the available commands.
+The following GIF showcases a simple example session:
+
+![Example of a simple REPL session](gif/repl-demo-opt.gif)
+
+<!--
+# Use https://github.com/charmbracelet/vhs
+Output repl-demo-opt.gif
+
+Set FontSize 30
+Set Width 1600
+Set Height 850
+Set WindowBar Colorful
+Set CursorBlink false
+Set PlaybackSpeed 3.0
+Set TypingSpeed 0.15
+
+Type "docker run -it --rm eagleoutice/flowr"
+Sleep 200ms
+Enter
+Sleep 4000ms
+
+Type ":slicer -c '11@prod' demo.R --diff"
+Sleep 400ms
+Enter
+Sleep 500ms
+Type ":quit"
+Sleep 400ms
+Enter
+Sleep 20000ms
+-->
+
+### The Server
+
+Instead of the REPL, you can start _flowR_ in "([TCP](https://de.wikipedia.org/wiki/Transmission_Control_Protocol)) server-mode" using \`flowr --server\` (write \`flowr --help\` to find out more). Together with the server option, you can configure the port with ${ctx.cliOption('flowr', 'port')}.
+The supported requests are documented alongside the internal documentation, see the ${ctx.linkPage('wiki/Interface')} wiki page for more information.
+
+<details>
+    <summary>Small demonstration using netcat</summary>
+
+![Example of a simple netcat session](gif/server-demo.gif)
+
+<details>
+  <summary>Used <a href="https://github.com/charmbracelet/vhs">vhs</a> code</summary>
+
+\`\`\`vhs
+Output demo.gif
+
+Set FontSize 40
+Set Width 1800
+Set Height 750
+Set WindowBar Colorful
+Set TypingSpeed 0.05s
+Set CursorBlink true
+
+Type "netcat 127.0.0.1 1042"
+Sleep 200ms
+Enter
+Sleep 600ms
+
+Type '{"type":"request-file-analysis","filetoken":"x","filename":"example-input","content":"2 - x"}'
+Sleep 200ms
+Enter
+Sleep 2s
+
+Type '{"type":"request-slice","filetoken":"x","criterion":["1@x"]}'
+Sleep 200ms
+Enter
+Sleep 8s
+
+Ctrl+C
+Sleep 200ms
+\`\`\`
+
+</details>
+</details>
+
+The server allows accessing the REPL as well
+(see the ${ctx.linkPage('wiki/Interface')} wiki page for more information).
+
+## Calling the Scripts Directly
+
+This describes the old way of using _flowR_ by creating and calling the respective scripts directly.
+Although this is no longer necessary, the scripts still remain, fully integrated into the REPL of _flowR_ (you can access them simply by adding a colon \`:\` before the name).
+
+### Generate Static Slices
+
+To generate a slice, you need to provide two things:
+
+1. A [slicing criterion](https://github.com/flowr-analysis/flowr/wiki/Terminology#slicing-criterion): the location of a single variable or several variables of interest to slice for, like "\`12@product\`"
+2. The path to an R&nbsp;file that should be sliced.
+
+For example, from the \`cli\` directory, you can run
+
+\`\`\`shell
+npm run slicer -- --criterion "12@product" "test/testfiles/example.R"
+\`\`\`
+
+This slices for the first use of the variable \`product\` in line&nbsp;12 of the source file at \`test/testfiles/example.R\` (see the [slicing criterion](https://github.com/flowr-analysis/flowr/wiki/Terminology#slicing-criterion) definition for more information).
+By default, the resulting slice is output to the standard output.
+
+For more options, run the following from the \`cli\` directory:
+
+\`\`\`shell
+npm run slicer -- --help
+\`\`\`
+
+Now, the following alternative is to be preferred:
+
+\`\`\`shell
+flowr -e ":slicer --help"
+\`\`\`
+
+### Benchmark the Slicer
+
+Within the original [thesis](https://github.com/flowr-analysis/flowr/wiki/Thesis), I conducted a benchmark of the slicer, measuring:
+
+1. The required time of each step of the slicing process, and
+2. The achieved reductions in the size of the slice.
+
+The corresponding _benchmark_ script ultimately allows doing the same thing as the _slicing_ script, but 1) parallel for many files and 2) for a wider selection of slicing points.
+By default, it starts by collecting all variables in a script, producing a slice for each of them.
+
+For example, to run the benchmark on 500 randomly picked files of the folder \`<folder>\` using 8 threads and writing the output to \`<output.json>\`, you can run this from the \`cli\` directory:
+
+\`\`\`shell
+npm run benchmark -- --limit 500 --parallel 8 --output "<output.json>" "<folder>"
+\`\`\`
+
+For more options, run the following from the \`cli\` directory:
+
+\`\`\`shell
+npm run benchmark -- --help
+\`\`\`
+
+#### Summarizing the Benchmark Results
+
+The resulting JSON file can be rather larger (starting off with a couple of hundred megabytes). Therefore, you probably want to summarize the results of the benchmark.
+For this, you can make use of the _summarizer_ script from within the \`cli\` directory like this:
+
+\`\`\`shell
+npm run summarizer -- "<output.json>"
+\`\`\`
+
+Please note that the summarizer may require a long time as it parses, normalizes, and analyzes _each_ slice produced, to calculate the reduction numbers. Therefore, it actually executes two steps:
+
+1. For each file, it calculates the reduction, required time, and other information, written to \`<output-summary.json>\`
+2. Calculate the "ultimate" summary by aggregating the intermediate results for each file
+
+As the ultimate summary is much quicker, you can re-run it by specifically adding the \`--ultimate-only\` flag (although this is only really of use if you modify what should be summarized within the source code of _flowR_).
+
+For more options, run the following from the \`cli\` directory:
+
+\`\`\`shell
+npm run summarizer -- --help
+\`\`\`
+
+### Generate Usage Statistics of R Code
+
+If you want to reproduce the statistics as presented in the original [master's thesis](http://dx.doi.org/10.18725/OPARU-50107), see the corresponding [wiki page](https://github.com/flowr-analysis/flowr/wiki/Thesis#how-to-reproduce-the-statistics-from-the-masters-thesis).
+
+For more information, run the following from the \`cli\` directory:
+
+\`\`\`shell
+npm run stats -- --help
+\`\`\`
+    `.trim();
+    }
+}
+exports.WikiOverview = WikiOverview;
+//# sourceMappingURL=wiki-overview.js.map

package/documentation/wiki-query.d.ts

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

package/documentation/wiki-query.js

@@ -34,6 +34,7 @@ const doc_repl_1 = require("./doc-util/doc-repl");
 const inspect_higher_order_query_executor_1 = require("../queries/catalog/inspect-higher-order-query/inspect-higher-order-query-executor");
 const doc_escape_1 = require("./doc-util/doc-escape");
 const doc_maker_1 = require("./wiki-mk/doc-maker");
+const files_query_executor_1 = require("../queries/catalog/files-query/files-query-executor");
 (0, doc_query_1.registerQueryDocumentation)('call-context', {
     name: 'Call-Context Query',
     type: 'active',
@@ -123,6 +124,21 @@ ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
 		`;
     }
 });
+(0, doc_query_1.registerQueryDocumentation)('files', {
+    name: 'Files Query',
+    type: 'active',
+    shortDescription: 'Returns the files matching the given criteria.',
+    functionName: files_query_executor_1.executeFileQuery.name,
+    functionFile: '../queries/catalog/files-query/files-query-executor.ts',
+    buildExplanation: async (shell) => {
+        return `
+This query returns the files that match the given criteria.
+${await (0, doc_query_1.showQuery)(shell, '', [{
+                type: 'files'
+            }], { showCode: true, collapseQuery: true })}
+		`;
+    }
+});
 (0, doc_query_1.registerQueryDocumentation)('project', {
     name: 'Project Query',
     type: 'active',
@@ -645,7 +661,7 @@ class WikiQuery extends doc_maker_1.DocMaker {
     async text({ ctx, shell }) {
         return `
 This page briefly summarizes flowR's query API, represented by the ${query_1.executeQueries.name} function in ${(0, doc_files_1.getFilePathMd)('../queries/query.ts')}.
-Please see the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more information on how to access this API.
+Please see the ${ctx.linkPage('wiki/Interface')} wiki page for more information on how to access this API.
 
 ${(0, doc_structure_1.block)({
             type: 'NOTE',

package/documentation/wiki-search.d.ts

@@ -3,7 +3,7 @@ import { DocMaker } from './wiki-mk/doc-maker';
 /**
  * https://github.com/flowr-analysis/flowr/wiki/Search-API
  */
-export declare class WikiSearch extends DocMaker {
+export declare class WikiSearch extends DocMaker<'wiki/Search API.md'> {
     constructor();
     text({ ctx, shell }: DocMakerArgs): Promise<string>;
 }

package/documentation/wiki-setup.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/Setup
+ */
+export declare class WikiSetup extends DocMaker<'wiki/Setup.md'> {
+    constructor();
+    text({ ctx }: DocMakerArgs): string;
+}

package/documentation/wiki-setup.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WikiSetup = void 0;
+const doc_maker_1 = require("./wiki-mk/doc-maker");
+const doc_files_1 = require("./doc-util/doc-files");
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Setup
+ */
+class WikiSetup extends doc_maker_1.DocMaker {
+    constructor() {
+        super('wiki/Setup.md', module.filename, 'setup instructions');
+    }
+    text({ ctx }) {
+        return `
+There are several ways to use _flowR_.
+You can download and build it from source, download the accompanying [docker image](${doc_files_1.FlowrDockerRef}), 
+or use its [Visual Studio Code extension](${doc_files_1.FlowrVsCode}) and [RStudio Addin](${doc_files_1.FlowrRStudioAddin}).
+
+- [🗒️ Using the Visual Studio Code Extension](#-using-the-visual-studio-code-extension)
+- [🗒️ Using the RStudio Addin](#-using-the-rstudio-addin)
+- [🐳️ Using the Docker Image](#-using-the-docker-image)
+- [⚒️ Building From Scratch](#-building-from-scratch)
+- [📜 Developing for _flowR_](#-developing-for-flowr)
+
+
+If you want to develop for _flowR_, you want to see how to [build from scratch](#-building-from-scratch) and have a 
+look at the [Contributing Guidelines](https://github.com/flowr-analysis/flowr/tree/main//.github/CONTRIBUTING.md).
+
+## 🗒️ Using the Visual Studio Code Extension
+
+The easiest way to use _flowR_ is to install the [Visual Studio Code extension](${doc_files_1.FlowrVsCode}).
+The extension directly includes a version of _flowR_ that can be used by default, so you can start analyzing code right away (given that you have R installed on your system).
+Please check out the marketplace entry for more information.
+This extension works with Positron as well (in general, it is available on [open-vsx](${doc_files_1.FlowrPositron}) as well).
+
+## 🗒️ Using the RStudio Addin
+
+You can also use _flowR_ as an RStudio Addin. Please check out the [RStudio Addin repository](${doc_files_1.FlowrRStudioAddin}) for more information on how to get started!
+
+## 🐳️ Using the Docker Image
+
+You can get the image from [docker hub](${doc_files_1.FlowrDockerRef}) by running:
+
+\`\`\`shell
+docker pull eagleoutice/flowr
+\`\`\`
+
+Afterward, you can test if the installation was successful by running the following (currently, there is no helper script for that):
+
+\`\`\`shell
+docker run -it --rm eagleoutice/flowr
+\`\`\`
+
+This should drop you into _flowR_'s read-evaluate-print loop.
+Enter ${ctx.replCmd('help')} to receive more information and ${ctx.replCmd('quit')} to leave.
+Please remember that you have to link external directories to make them available within the running container.
+
+To start flowr as a server, you can run:
+
+\`\`\`shell
+docker run -it --rm -p1042:1042 eagleoutice/flowr --server
+\`\`\`
+
+For more information, see the ${ctx.linkPage('wiki/Interface')} wiki page.
+
+## ⚒️ Building From Scratch
+
+To use _flowR_, you may need [_R_](https://www.r-project.org/) installed and on your path
+(this only affects the [\`r-shell\` engine][r-shell], which is _not_ the default).
+
+### Installing R
+Although there are several ways to do so, there is nothing wrong with installing&nbsp;R with the help of your favorite package manager or directly from the [website](https://cloud.r-project.org/).<a href="#note1" id="note1ref"><sup>&lt;1&gt;</sup></a>
+For 🪟&nbsp;Windows, see [here](https://www.hanss.info/sebastian/post/rtools-path/) for an explanation on how to add [_R_](https://www.r-project.org/) to your path variable.
+Again, you only require this for the [\`r-shell\` engine][r-shell].
+
+### Installing Node.js
+
+Furthermore, you need the [node package manager](https://www.npmjs.com/) (for Linux, we recommend using [nvm](https://github.com/nvm-sh/nvm)).
+To work, we currently rely on node versions starting from \`22.x\`.
+
+### Installing _flowR_
+
+After cloning the repository,<a href="#note2" id="note2ref"><sup>&lt;2&gt;</sup></a> you can install the dependencies with:
+
+\`\`\`shell
+npm i
+\`\`\`
+
+After that, you should be fine! You may test _flowR_'s command-line interface by running the following from the \`cli\` directory:
+
+\`\`\`shell
+npm run slicer -- --criterion "12@product" test/testfiles/example.R
+\`\`\`
+
+The output should look similar to this:
+
+\`\`\`R
+product <- 1
+N <- 10
+for(i in 1:(N-1)) product <- product * i
+cat("Product:", product, "\\n")
+\`\`\`
+
+At the time of writing this, there is currently no page for frequently encountered errors. So just [message me](mailto:florian.sihler@uni-ulm.de) in case of problems.
+
+## 📜 Developing for _flowR_
+
+If you want to develop for _flowR_, explore the wiki.
+For details on _how_ to contribute, please refer to the [CONTRIBUTING.md](https://github.com/flowr-analysis/flowr/blob/main/.github/CONTRIBUTING.md) in the repository.
+
+-----
+<a id="note1" href="#note1ref">&lt;1&gt;</a>: Currently, _flowR_ is only tested with R versions \`4.x\` and \`3.6.x\`.
+
+<a id="note2" href="#note2ref">&lt;2&gt;</a>: We use
+[git-lfs](https://git-lfs.com/) to store larger files, especially for the wiki pages. So if you want to work on these parts, make sure to have it set-up (see the [CONTRIBUTING.md](https://github.com/flowr-analysis/flowr/blob/main/.github/CONTRIBUTING.md) in the repository for more information).
+
+[r-shell]: (https://github.com/flowr-analysis/flowr/wiki/Engines)
+    `.trim();
+    }
+}
+exports.WikiSetup = WikiSetup;
+//# sourceMappingURL=wiki-setup.js.map

package/linter/rules/dataframe-access-validation.d.ts

@@ -2,7 +2,7 @@ import type { ParentInformation } from '../../r-bridge/lang-4.x/ast/model/proces
 import type { FlowrSearchElements } from '../../search/flowr-search';
 import { type MergeableRecord } from '../../util/objects';
 import { type SourceRange } from '../../util/range';
-import { type LintingResult, LintingRuleCertainty } from '../linter-format';
+import { LintingRuleCertainty, type LintingResult } from '../linter-format';
 import { LintingRuleTag } from '../linter-tags';
 export interface DataFrameAccessValidationResult extends LintingResult {
     /** The type of the data frame access ("column" or "row") */

package/linter/rules/dataframe-access-validation.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DATA_FRAME_ACCESS_VALIDATION = void 0;
-const absint_info_1 = require("../../abstract-interpretation/data-frame/absint-info");
 const shape_inference_1 = require("../../abstract-interpretation/data-frame/shape-inference");
 const satisfiable_domain_1 = require("../../abstract-interpretation/domains/satisfiable-domain");
 const config_1 = require("../../config");
@@ -28,14 +27,15 @@ exports.DATA_FRAME_ACCESS_VALIDATION = {
             })
         };
         const cfg = (0, extract_cfg_1.extractCfg)(data.normalize, ctx, data.dataflow.graph);
-        (0, shape_inference_1.inferDataFrameShapes)(cfg, data.dataflow.graph, data.normalize, ctx);
-        const accessOperations = getAccessOperations(elements);
+        const inference = new shape_inference_1.DataFrameShapeInferenceVisitor({ controlFlow: cfg, dfg: data.dataflow.graph, normalizedAst: data.normalize, ctx });
+        inference.start();
+        const accessOperations = getAccessOperations(elements, inference);
         const accesses = [];
         for (const [nodeId, operations] of accessOperations) {
             const access = { nodeId };
             for (const operation of operations) {
                 access.operand ??= operation.operand;
-                access.operandShape ??= (0, shape_inference_1.resolveIdToDataFrameShape)(operation.operand, data.dataflow.graph);
+                access.operandShape ??= inference.getAbstractValue(operation.operand);
                 if (operation.operation === 'accessCols' && operation.columns !== undefined) {
                     access.accessedCols ??= [];
                     access.accessedCols.push(...operation.columns);
@@ -89,13 +89,11 @@ exports.DATA_FRAME_ACCESS_VALIDATION = {
         defaultConfig: { readLoadedData: false }
     }
 };
-function getAccessOperations(elements) {
+function getAccessOperations(elements, inference) {
     return new Map(elements.getElements()
-        .map(element => element.node)
-        .filter(absint_info_1.hasDataFrameExpressionInfo)
-        .map(node => [node.info.id, node.info.dataFrame.operations
-            .filter(({ operation }) => operation === 'accessCols' || operation === 'accessRows')
-            .map(({ operation, operand, type: _type, options: _options, ...args }) => ({ operation, operand, ...args }))
+        .map(element => [element.node.info.id, inference.getAbstractOperations(element.node.info.id)
+            ?.filter(({ operation }) => operation === 'accessCols' || operation === 'accessRows')
+            .map(({ operation, operand, type: _type, options: _options, ...args }) => ({ operation, operand, ...args })) ?? []
     ])
         .filter(([, operations]) => operations.length > 0));
 }

package/linter/rules/unused-definition.js

@@ -20,7 +20,7 @@ function getDefinitionArguments(def, dfg) {
 function buildQuickFix(variable, dfg, ast) {
     // first we check whether any of the 'Defined by' targets have any obligations - if so, we can not remove the definition
     // otherwise we can automatically remove the full definition!
-    if (variable.info.role === "accessed" /* RoleInParent.Accessed */ || variable.info.role === "for-variable" /* RoleInParent.ForVariable */) {
+    if (variable.info.role === "accessed" /* RoleInParent.Accessed */ || variable.info.role === "for-var" /* RoleInParent.ForVariable */) {
         // this is an access or a for variable, we can not remove it currently
         return undefined;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eagleoutice/flowr",
-  "version": "2.7.0",
+  "version": "2.7.2",
   "description": "Static Dataflow Analyzer and Program Slicer for the R Programming Language",
   "types": "dist/src/index.d.ts",
   "repository": {

package/project/context/flowr-analyzer-context.d.ts

@@ -28,6 +28,10 @@ export interface ReadOnlyFlowrAnalyzerContext {
      * The configuration options used by the analyzer.
      */
     readonly config: FlowrConfigOptions;
+    /**
+     * Run all resolution steps that can be done before the main analysis run.
+     */
+    readonly resolvePreAnalysis: () => void;
 }
 /**
  * This summarizes the other context layers used by the {@link FlowrAnalyzer}.

package/project/context/flowr-analyzer-files-context.d.ts

@@ -4,7 +4,8 @@ import type { FlowrAnalyzerLoadingOrderContext, ReadOnlyFlowrAnalyzerLoadingOrde
 import { FlowrAnalyzerProjectDiscoveryPlugin } from '../plugins/project-discovery/flowr-analyzer-project-discovery-plugin';
 import { FlowrAnalyzerFilePlugin } from '../plugins/file-plugins/flowr-analyzer-file-plugin';
 import { FlowrFile, type FlowrFileProvider, FileRole } from './flowr-file';
-import type { FlowrDescriptionFile } from '../plugins/file-plugins/flowr-description-file';
+import type { FlowrDescriptionFile } from '../plugins/file-plugins/files/flowr-description-file';
+import type { FlowrNewsFile } from '../plugins/file-plugins/files/flowr-news-file';
 /**
  * This is a request to process a folder as a project, which will be expanded by the registered {@link FlowrAnalyzerProjectDiscoveryPlugin}s.
  */
@@ -18,6 +19,7 @@ export interface RProjectAnalysisRequest {
 export type RAnalysisRequest = RParseRequest | RProjectAnalysisRequest;
 export type RoleBasedFiles = {
     [FileRole.Description]: FlowrDescriptionFile[];
+    [FileRole.News]: FlowrNewsFile[];
     [FileRole.Namespace]: FlowrFileProvider[];
     [FileRole.Source]: FlowrFileProvider[];
     [FileRole.Data]: FlowrFileProvider[];
@@ -45,6 +47,11 @@ export interface ReadOnlyFlowrAnalyzerFilesContext {
      * ```
      */
     getFilesByRole<Role extends FileRole>(role: Role): RoleBasedFiles[Role];
+    /**
+     * Get all files known to this context.
+     * @returns An array of all files.
+     */
+    getAllFiles(): FlowrFileProvider[];
     /**
      * Check if the context has a file with the given path.
      * Please note, that this may also check the file system, depending on the configuration
@@ -132,4 +139,5 @@ export declare class FlowrAnalyzerFilesContext extends AbstractFlowrAnalyzerCont
      */
     computeLoadingOrder(): readonly RParseRequest[];
     getFilesByRole<Role extends FileRole>(role: Role): RoleBasedFiles[Role];
+    getAllFiles(): FlowrFileProvider[];
 }

package/project/context/flowr-analyzer-files-context.js

@@ -42,6 +42,7 @@ class FlowrAnalyzerFilesContext extends abstract_flowr_analyzer_context_1.Abstra
     /* files that are part of the analysis, e.g. source files */
     byRole = {
         [flowr_file_1.FileRole.Description]: [],
+        [flowr_file_1.FileRole.News]: [],
         [flowr_file_1.FileRole.Namespace]: [],
         [flowr_file_1.FileRole.Source]: [],
         [flowr_file_1.FileRole.Data]: [],
@@ -200,6 +201,9 @@ class FlowrAnalyzerFilesContext extends abstract_flowr_analyzer_context_1.Abstra
     getFilesByRole(role) {
         return this.byRole[role];
     }
+    getAllFiles() {
+        return [...this.files.values(), ...this.inlineFiles];
+    }
 }
 exports.FlowrAnalyzerFilesContext = FlowrAnalyzerFilesContext;
 //# sourceMappingURL=flowr-analyzer-files-context.js.map

package/project/context/flowr-file.d.ts

@@ -15,6 +15,8 @@ export declare enum FileRole {
     Description = "description",
     /** The `NAMESPACE` file in R packages, currently not specially supported. */
     Namespace = "namespace",
+    /** The `NEWS` file in R packages */
+    News = "news",
     /** Data files, e.g., `R/sysdata.rda`, currently not specially supported. */
     Data = "data",
     /**

package/project/context/flowr-file.js

@@ -17,6 +17,8 @@ var FileRole;
     FileRole["Description"] = "description";
     /** The `NAMESPACE` file in R packages, currently not specially supported. */
     FileRole["Namespace"] = "namespace";
+    /** The `NEWS` file in R packages */
+    FileRole["News"] = "news";
     /** Data files, e.g., `R/sysdata.rda`, currently not specially supported. */
     FileRole["Data"] = "data";
     /**

package/project/plugins/file-plugins/{flowr-description-file.d.ts → files/flowr-description-file.d.ts}

@@ -1,4 +1,4 @@
-import { type FlowrFileProvider, type FileRole, FlowrFile } from '../../context/flowr-file';
+import { type FlowrFileProvider, type FileRole, FlowrFile } from '../../../context/flowr-file';
 export type DCF = Map<string, string[]>;
 /**
  * This decorates a text file and provides access to its content as a DCF (Debian Control File)-like structure.