@eagleoutice/flowr 2.7.4 → 2.7.6

package/README.md

@@ -24,7 +24,7 @@ It offers a wide variety of features, for example:
     
     ```shell
     $ docker run -it --rm eagleoutice/flowr # or npm run flowr 
-    flowR repl using flowR v2.7.3, R grammar v14 (tree-sitter engine)
+    flowR repl using flowR v2.7.5, R grammar v14 (tree-sitter engine)
     R> :query @linter "read.csv(\"/root/x.txt\")"
     ```
     
@@ -33,21 +33,21 @@ It offers a wide variety of features, for example:
     
     
     ```text
-    Query: linter (2 ms)
+    Query: linter (1 ms)
        ╰ **Deprecated Functions** (deprecated-functions):
            ╰ _Metadata_: <code>{"totalCalls":0,"totalFunctionDefinitions":0,"searchTimeMs":0,"processTimeMs":0}</code>
        ╰ **File Path Validity** (file-path-validity):
            ╰ certain:
                ╰ Path `/root/x.txt` at 1.1-23
-           ╰ _Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":1,"processTimeMs":0}</code>
+           ╰ _Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":0,"processTimeMs":0}</code>
        ╰ **Seeded Randomness** (seeded-randomness):
            ╰ _Metadata_: <code>{"consumerCalls":0,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"callsWithOtherBranchProducers":0,"searchTimeMs":0,"processTimeMs":0}</code>
        ╰ **Absolute Paths** (absolute-file-paths):
            ╰ certain:
                ╰ Path `/root/x.txt` at 1.1-23
-           ╰ _Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":0,"processTimeMs":0}</code>
+           ╰ _Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":1,"processTimeMs":0}</code>
        ╰ **Unused Definitions** (unused-definitions):
-           ╰ _Metadata_: <code>{"totalConsidered":0,"searchTimeMs":0,"processTimeMs":1}</code>
+           ╰ _Metadata_: <code>{"totalConsidered":0,"searchTimeMs":0,"processTimeMs":0}</code>
        ╰ **Naming Convention** (naming-convention):
            ╰ _Metadata_: <code>{"numMatches":0,"numBreak":0,"searchTimeMs":0,"processTimeMs":0}</code>
        ╰ **Network Functions** (network-functions):
@@ -58,7 +58,7 @@ It offers a wide variety of features, for example:
            ╰ _Metadata_: <code>{"consideredNodes":5,"searchTimeMs":0,"processTimeMs":0}</code>
        ╰ **Useless Loops** (useless-loop):
            ╰ _Metadata_: <code>{"numOfUselessLoops":0,"searchTimeMs":0,"processTimeMs":0}</code>
-    All queries together required ≈2 ms (1ms accuracy, total 3 ms)
+    All queries together required ≈1 ms (1ms accuracy, total 2 ms)
     ```
     
     
@@ -100,16 +100,16 @@ It offers a wide variety of features, for example:
     &nbsp;&nbsp;&nbsp;╰ **Network Functions** (network-functions):\
     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"totalCalls":0,"totalFunctionDefinitions":0,"searchTimeMs":0,"processTimeMs":0}</code>\
     &nbsp;&nbsp;&nbsp;╰ **Dataframe Access Validation** (dataframe-access-validation):\
-    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"numOperations":0,"numAccesses":0,"totalAccessed":0,"searchTimeMs":0,"processTimeMs":1}</code>\
+    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"numOperations":0,"numAccesses":0,"totalAccessed":0,"searchTimeMs":0,"processTimeMs":0}</code>\
     &nbsp;&nbsp;&nbsp;╰ **Dead Code** (dead-code):\
     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"consideredNodes":5,"searchTimeMs":0,"processTimeMs":0}</code>\
     &nbsp;&nbsp;&nbsp;╰ **Useless Loops** (useless-loop):\
     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ _Metadata_: <code>{"numOfUselessLoops":0,"searchTimeMs":0,"processTimeMs":0}</code>\
-    _All queries together required ≈3 ms (1ms accuracy, total 4 ms)_
+    _All queries together required ≈3 ms (1ms accuracy, total 3 ms)_
     
     <details> <summary style="color:gray">Show Detailed Results as Json</summary>
     
-    The analysis required _3.5 ms_ (including parsing and normalization and the query) within the generation environment.
+    The analysis required _3.2 ms_ (including parsing and normalization and the query) within the generation environment.
     
     In general, the JSON contains the Ids of the nodes in question as they are present in the normalized AST or the dataflow graph of flowR.
     Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.
@@ -217,7 +217,7 @@ It offers a wide variety of features, for example:
               "numAccesses": 0,
               "totalAccessed": 0,
               "searchTimeMs": 0,
-              "processTimeMs": 1
+              "processTimeMs": 0
             }
           },
           "dead-code": {
@@ -307,7 +307,7 @@ It offers a wide variety of features, for example:
     
     ```shell
     $ docker run -it --rm eagleoutice/flowr # or npm run flowr 
-    flowR repl using flowR v2.7.3, R grammar v14 (tree-sitter engine)
+    flowR repl using flowR v2.7.5, R grammar v14 (tree-sitter engine)
     R> :query @static-slice (11@sum) file://test/testfiles/example.R
     ```
     
@@ -355,7 +355,7 @@ It offers a wide variety of features, for example:
         
 
 * 🚀 **fast data- and control-flow graphs**\
-  Within just <i><span title="This measurement is automatically fetched from the latest benchmark!">120.3 ms</span></i> (as of Dec 21, 2025), 
+  Within just <i><span title="This measurement is automatically fetched from the latest benchmark!">122.3 ms</span></i> (as of Dec 23, 2025), 
   _flowR_ can analyze the data- and control-flow of the average real-world R script. See the [benchmarks](https://flowr-analysis.github.io/flowr/wiki/stats/benchmark) for more information,
   and consult the [wiki pages](https://github.com/flowr-analysis/flowr/wiki/Dataflow-Graph) for more details on the dataflow graph.
 
@@ -391,7 +391,7 @@ It offers a wide variety of features, for example:
     
     ```shell
     $ docker run -it --rm eagleoutice/flowr # or npm run flowr 
-    flowR repl using flowR v2.7.3, R grammar v14 (tree-sitter engine)
+    flowR repl using flowR v2.7.5, R grammar v14 (tree-sitter engine)
     R> :dataflow* test/testfiles/example.R
     ```
     
@@ -696,7 +696,7 @@ It offers a wide variety of features, for example:
     ```
     
     	
-    (The analysis required _2.9 ms_ (including parse and normalize, using the [tree-sitter](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
+    (The analysis required _2.1 ms_ (including parse and normalize, using the [tree-sitter](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
     
     
     

package/cli/repl/commands/repl-commands.d.ts

@@ -16,6 +16,8 @@ declare const _commands: {
     readonly 'dataflow*': ReplCodeCommand;
     readonly dataflowsimple: ReplCodeCommand;
     readonly 'dataflowsimple*': ReplCodeCommand;
+    readonly dataflowascii: ReplCodeCommand;
+    readonly dataflowsilent: ReplCodeCommand;
     readonly controlflow: ReplCodeCommand;
     readonly 'controlflow*': ReplCodeCommand;
     readonly controlflowbb: ReplCodeCommand;

package/cli/repl/commands/repl-commands.js

@@ -83,6 +83,8 @@ const _commands = {
     'dataflow*': repl_dataflow_1.dataflowStarCommand,
     'dataflowsimple': repl_dataflow_1.dataflowSimplifiedCommand,
     'dataflowsimple*': repl_dataflow_1.dataflowSimpleStarCommand,
+    'dataflowascii': repl_dataflow_1.dataflowAsciiCommand,
+    'dataflowsilent': repl_dataflow_1.dataflowSilentCommand,
     'controlflow': repl_cfg_1.controlflowCommand,
     'controlflow*': repl_cfg_1.controlflowStarCommand,
     'controlflowbb': repl_cfg_1.controlflowBbCommand,

package/cli/repl/commands/repl-dataflow.d.ts

@@ -1,5 +1,7 @@
 import type { ReplCodeCommand } from './repl-main';
 export declare const dataflowCommand: ReplCodeCommand;
 export declare const dataflowStarCommand: ReplCodeCommand;
+export declare const dataflowAsciiCommand: ReplCodeCommand;
+export declare const dataflowSilentCommand: ReplCodeCommand;
 export declare const dataflowSimplifiedCommand: ReplCodeCommand;
 export declare const dataflowSimpleStarCommand: ReplCodeCommand;

package/cli/repl/commands/repl-dataflow.js

@@ -33,11 +33,13 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dataflowSimpleStarCommand = exports.dataflowSimplifiedCommand = exports.dataflowStarCommand = exports.dataflowCommand = void 0;
+exports.dataflowSimpleStarCommand = exports.dataflowSimplifiedCommand = exports.dataflowSilentCommand = exports.dataflowAsciiCommand = exports.dataflowStarCommand = exports.dataflowCommand = void 0;
 const retriever_1 = require("../../../r-bridge/retriever");
 const dfg_1 = require("../../../util/mermaid/dfg");
 const ansi_1 = require("../../../util/text/ansi");
 const core_1 = require("../core");
+const vertex_1 = require("../../../dataflow/graph/vertex");
+const dfg_ascii_1 = require("../../../util/simple-df/dfg-ascii");
 function formatInfo(out, type, meta) {
     return out.formatter.format(`Copied ${type} to clipboard (dataflow: ${meta['.meta'].timing + 'ms'}).`, { color: 7 /* Colors.White */, effect: ansi_1.ColorEffect.Foreground, style: 3 /* FontStyles.Italic */ });
 }
@@ -80,6 +82,41 @@ exports.dataflowStarCommand = {
         catch { /* do nothing this is a service thing */ }
     }
 };
+exports.dataflowAsciiCommand = {
+    description: 'Returns an ASCII representation of the dataflow graph',
+    isCodeCommand: true,
+    usageExample: ':dataflowascii',
+    aliases: ['df!'],
+    script: false,
+    argsParser: (args) => (0, core_1.handleString)(args),
+    fn: async ({ output, analyzer }) => {
+        const result = await analyzer.dataflow();
+        output.stdout((0, dfg_ascii_1.dfgToAscii)(result.graph));
+    }
+};
+exports.dataflowSilentCommand = {
+    description: 'Just calculates the DFG, but only prints summary info',
+    isCodeCommand: true,
+    usageExample: ':dataflowsilent',
+    aliases: ['d#', 'df#'],
+    script: false,
+    argsParser: (args) => (0, core_1.handleString)(args),
+    fn: async ({ output, analyzer }) => {
+        const result = await analyzer.dataflow();
+        const numOfEdges = Array.from(result.graph.edges().flatMap(e => e[1].entries())).length;
+        const numOfVertices = Array.from(result.graph.vertices(true)).length;
+        output.stdout(output.formatter.format(`Dataflow calculated in ${result['.meta'].timing}ms.`, { color: 7 /* Colors.White */, effect: ansi_1.ColorEffect.Foreground, style: 3 /* FontStyles.Italic */ }) + '\n' +
+            'Edges:    ' + output.formatter.format(`${String(numOfEdges).padStart(12)}`, { color: 6 /* Colors.Cyan */, effect: ansi_1.ColorEffect.Foreground }) + '\n' +
+            // number of vertices and edges
+            'Vertices: ' + output.formatter.format(`${String(numOfVertices).padStart(12)}`, { color: 6 /* Colors.Cyan */, effect: ansi_1.ColorEffect.Foreground }));
+        const longestVertexType = Math.max(...Object.keys(vertex_1.VertexType).map(vt => vt.length));
+        for (const vertType of Object.values(vertex_1.VertexType)) {
+            const vertsOfType = Array.from(result.graph.verticesOfType(vertType));
+            const longVertexName = Object.entries(vertex_1.VertexType).find(([, v]) => v === vertType)?.[0] ?? vertType;
+            output.stdout(` - ${(longVertexName + ':').padEnd(longestVertexType + 1)} ` + output.formatter.format(`${String(vertsOfType.length).padStart(8)}`, { color: 6 /* Colors.Cyan */, effect: ansi_1.ColorEffect.Foreground }).padStart(9, ' '));
+        }
+    }
+};
 exports.dataflowSimplifiedCommand = {
     description: `Get mermaid code for the simplified dataflow graph, start with '${retriever_1.fileProtocol}' to indicate a file`,
     isCodeCommand: true,

package/cli/repl/core.js

@@ -53,6 +53,7 @@ const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const args_1 = require("../../util/text/args");
+const ansi_1 = require("../../util/text/ansi");
 const repl_commands_1 = require("./commands/repl-commands");
 const scripts_info_1 = require("../common/scripts-info");
 const retriever_1 = require("../../r-bridge/retriever");
@@ -144,6 +145,7 @@ function handleString(code) {
     };
 }
 async function replProcessStatement(output, statement, analyzer, allowRSessionAccess) {
+    const time = Date.now();
     if (statement.startsWith(':')) {
         const command = statement.slice(1).split(' ')[0].toLowerCase();
         const processor = (0, repl_commands_1.getCommand)(command);
@@ -179,6 +181,26 @@ async function replProcessStatement(output, statement, analyzer, allowRSessionAc
     else {
         await (0, repl_execute_1.tryExecuteRShellCommand)({ output, analyzer, remainingLine: statement, allowRSessionAccess });
     }
+    if (analyzer.inspectContext().config.repl.quickStats) {
+        try {
+            const duration = Date.now() - time;
+            console.log(output.formatter.format(`[REPL Stats] Processed in ${duration}ms`, {
+                style: 3 /* FontStyles.Italic */,
+                effect: ansi_1.ColorEffect.Foreground,
+                color: 7 /* Colors.White */
+            }));
+            const memoryUsage = process.memoryUsage();
+            const memoryUsageStr = Object.entries(memoryUsage).map(([key, value]) => `${key}: ${(value / 1024 / 1024).toFixed(2)} MB`).join(', ');
+            console.log(output.formatter.format(`[REPL Stats] Memory Usage: ${memoryUsageStr}`, {
+                style: 3 /* FontStyles.Italic */,
+                effect: ansi_1.ColorEffect.Foreground,
+                color: 7 /* Colors.White */
+            }));
+        }
+        catch {
+            // do nothing, this is just a nice-to-have
+        }
+    }
 }
 /**
  * This function interprets the given `expr` as a REPL command (see {@link repl} for more on the semantics).

package/config.d.ts

@@ -98,6 +98,11 @@ export interface FlowrConfigOptions extends MergeableRecord {
             };
         };
     };
+    /** Configuration options for the REPL */
+    readonly repl: {
+        /** Whether to show quick stats in the REPL after each evaluation */
+        quickStats: boolean;
+    };
     readonly project: {
         /** Whether to resolve unknown paths loaded by the r project disk when trying to source/analyze files */
         resolveUnknownPathsOnDisk: boolean;

package/config.js

@@ -65,6 +65,9 @@ exports.defaultConfigOptions = {
             }
         }
     },
+    repl: {
+        quickStats: false
+    },
     project: {
         resolveUnknownPathsOnDisk: true
     },
@@ -106,6 +109,9 @@ exports.flowrConfigFileSchema = joi_1.default.object({
             }).optional().description('Do you want to overwrite (parts) of the builtin definition?')
         }).optional().description('Semantics regarding how to handle the R environment.')
     }).description('Configure language semantics and how flowR handles them.'),
+    repl: joi_1.default.object({
+        quickStats: joi_1.default.boolean().optional().description('Whether to show quick stats in the REPL after each evaluation.')
+    }).description('Configuration options for the REPL.'),
     project: joi_1.default.object({
         resolveUnknownPathsOnDisk: joi_1.default.boolean().optional().description('Whether to resolve unknown paths loaded by the r project disk when trying to source/analyze files.')
     }).description('Project specific configuration options.'),

package/dataflow/graph/graph.js

@@ -308,6 +308,8 @@ class DataflowGraph {
         }
         else {
             this.vertexInformation.set(reference.nodeId, { ...vertex, tag: vertex_1.VertexType.VariableDefinition });
+            this.types.set(vertex.tag, (this.types.get(vertex.tag) ?? []).filter(id => id !== reference.nodeId));
+            this.types.set(vertex_1.VertexType.VariableDefinition, (this.types.get(vertex_1.VertexType.VariableDefinition) ?? []).concat([reference.nodeId]));
         }
     }
     /**

package/documentation/wiki-analyzer.js

@@ -27,6 +27,7 @@ const doc_maker_1 = require("./wiki-mk/doc-maker");
 const flowr_analyzer_rmd_file_plugin_1 = require("../project/plugins/file-plugins/notebooks/flowr-analyzer-rmd-file-plugin");
 const flowr_analyzer_plugin_1 = require("../project/plugins/flowr-analyzer-plugin");
 const flowr_analyzer_environment_context_1 = require("../project/context/flowr-analyzer-environment-context");
+const flowr_analyzer_functions_context_1 = require("../project/context/flowr-analyzer-functions-context");
 async function analyzerQuickExample() {
     const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder()
         .setEngine('tree-sitter')
@@ -398,6 +399,17 @@ Probably the most important method is
 ${ctx.linkM(flowr_analyzer_dependencies_context_1.FlowrAnalyzerDependenciesContext, 'getDependency', { codeFont: true, realNameWrapper: 'i' })}
 that allows you to query for a specific dependency by name.
 
+${(0, doc_structure_1.section)('Functions Context', 3)}
+
+The ${ctx.link(flowr_analyzer_dependencies_context_1.FlowrAnalyzerDependenciesContext)} also provides access to the associated
+${ctx.link(flowr_analyzer_functions_context_1.FlowrAnalyzerFunctionsContext)} via its \`functionsContext\` attribute.
+
+${ctx.hierarchy(flowr_analyzer_functions_context_1.FlowrAnalyzerFunctionsContext, { showImplSnippet: false })}
+
+Probably the most important method is
+${ctx.linkM(flowr_analyzer_functions_context_1.FlowrAnalyzerFunctionsContext, 'getFunctionInfo', { codeFont: true, realNameWrapper: 'i' })}
+that allows you to query for a specific function by name.
+
 ${(0, doc_structure_1.section)('Environment Context', 3)}
 
 Here is the structure of the ${ctx.link(flowr_analyzer_environment_context_1.FlowrAnalyzerEnvironmentContext)} that provides access to the built-in environment:

package/documentation/wiki-interface.js

@@ -213,6 +213,9 @@ ${(0, doc_code_1.codeBlock)('json', JSON.stringify({
                 }
             }
         },
+        repl: {
+            quickStats: false
+        },
         project: {
             resolveUnknownPathsOnDisk: true
         },

package/documentation/wiki-query.js

@@ -149,7 +149,7 @@ ${await (0, doc_query_1.showQuery)(shell, '', [{
         const exampleCode = 'x + 1';
         return `
 This query returns the information about the analyzed project.
-Currently, this is only the list of file paths included.
+If present, it will incorporate plugins to, e.g., extract author and license information from R package DESCRIPTION files.
 
 ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 type: 'project'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eagleoutice/flowr",
-  "version": "2.7.4",
+  "version": "2.7.6",
   "description": "Static Dataflow Analyzer and Program Slicer for the R Programming Language",
   "types": "dist/src/index.d.ts",
   "repository": {
@@ -172,6 +172,7 @@
     "@types/command-line-args": "^5.2.3",
     "@types/command-line-usage": "^5.0.4",
     "@types/commonmark": "^0.27.10",
+    "@types/dagre": "^0.7.53",
     "@types/n-readlines": "^1.0.6",
     "@types/n3": "^1.26.0",
     "@types/object-hash": "^3.0.6",
@@ -203,6 +204,7 @@
     "command-line-args": "^6.0.1",
     "command-line-usage": "^7.0.3",
     "commonmark": "^0.31.2",
+    "dagre": "^0.8.5",
     "gray-matter": "^4.0.3",
     "joi": "^18.0.1",
     "lz-string": "^1.5.0",

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

@@ -1,7 +1,7 @@
 import { AbstractFlowrAnalyzerContext } from './abstract-flowr-analyzer-context';
 import { FlowrAnalyzerPackageVersionsPlugin } from '../plugins/package-version-plugins/flowr-analyzer-package-versions-plugin';
 import type { Package } from '../plugins/package-version-plugins/package';
-import type { FlowrAnalyzerFunctionsContext } from './flowr-analyzer-functions-context';
+import type { FlowrAnalyzerFunctionsContext, ReadOnlyFlowrAnalyzerFunctionsContext } from './flowr-analyzer-functions-context';
 /**
  * This is a read-only interface to the {@link FlowrAnalyzerDependenciesContext}.
  * It prevents you from modifying the dependencies, but allows you to inspect them (which is probably what you want when using the {@link FlowrAnalyzer}).
@@ -12,6 +12,10 @@ export interface ReadOnlyFlowrAnalyzerDependenciesContext {
      * The name of this context.
      */
     readonly name: string;
+    /**
+     * The functions context associated with this dependencies-context.
+     */
+    readonly functionsContext: ReadOnlyFlowrAnalyzerFunctionsContext;
     /**
      * Get the dependency with the given name, if it exists.
      *

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

@@ -14,10 +14,26 @@ export interface FunctionInfo {
     s3TypeDispatch?: string;
     inferredType?: string;
 }
+/**
+ * This is a read-only interface to the {@link FlowrAnalyzerFunctionsContext}.
+ * It prevents you from modifying the functions, but allows you to inspect them (which is probably what you want when using the {@link FlowrAnalyzer}).
+ * If you are a {@link FlowrAnalyzerPackageVersionsPlugin} and want to modify the functions, you can use the {@link FlowrAnalyzerFunctionsContext} directly.
+ */
 export interface ReadOnlyFlowrAnalyzerFunctionsContext {
     readonly name: string;
+    /**
+     * Get the function information for the given function name and optional class name.
+     * @param name - The name of the function to get information for.
+     * @param className - The optional class name (e.g., for S3 generics).
+     */
     getFunctionInfo(name: string, className?: string): FunctionInfo | FunctionInfo[] | undefined;
 }
+/**
+ * This context is responsible for managing the functions identified in the project, including their origins, types, and other metadata.
+ * It works in conjunction with {@link FlowrAnalyzerPackageVersionsPlugin}s to gather and maintain this information.
+ *
+ * If you are interested in inspecting these functions, refer to {@link ReadOnlyFlowrAnalyzerFunctionsContext}.
+ */
 export declare class FlowrAnalyzerFunctionsContext extends AbstractFlowrAnalyzerContext<undefined, void, FlowrAnalyzerPackageVersionsPlugin> implements ReadOnlyFlowrAnalyzerFunctionsContext {
     readonly name = "flowr-analyzer-functions-context";
     private functionInfo;

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

@@ -10,6 +10,12 @@ var FunctionTypes;
     FunctionTypes["ExportTypes"] = "exportTypes";
     FunctionTypes["S3"] = "S3";
 })(FunctionTypes || (exports.FunctionTypes = FunctionTypes = {}));
+/**
+ * This context is responsible for managing the functions identified in the project, including their origins, types, and other metadata.
+ * It works in conjunction with {@link FlowrAnalyzerPackageVersionsPlugin}s to gather and maintain this information.
+ *
+ * If you are interested in inspecting these functions, refer to {@link ReadOnlyFlowrAnalyzerFunctionsContext}.
+ */
 class FlowrAnalyzerFunctionsContext extends abstract_flowr_analyzer_context_1.AbstractFlowrAnalyzerContext {
     name = 'flowr-analyzer-functions-context';
     functionInfo = new Map();

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

@@ -29,7 +29,7 @@ export interface ReadOnlyFlowrAnalyzerLoadingOrderContext {
     /**
      * Get the current guesses for the loading order, if any. These are populated by {@link FlowrAnalyzerLoadingOrderPlugin}s.
      */
-    currentGuesses(): readonly RParseRequest[][];
+    currentGuesses(): readonly (readonly RParseRequest[])[];
     /**
      * Get the current known loading order, if any. This is populated by {@link FlowrAnalyzerLoadingOrderPlugin}s if they have a source of identifying the order definitively.
      */
@@ -46,9 +46,9 @@ export declare class FlowrAnalyzerLoadingOrderContext extends AbstractFlowrAnaly
     private rerunRequired;
     constructor(ctx: FlowrAnalyzerContext, plugins: readonly FlowrAnalyzerLoadingOrderPlugin[] | undefined);
     private knownOrder?;
-    private guesses;
+    private readonly guesses;
     /** just the base collection of requests we know nothing about the order! */
-    private unordered;
+    private readonly unordered;
     reset(): void;
     /**
      * Add one or multiple requests to the context.
@@ -69,7 +69,7 @@ export declare class FlowrAnalyzerLoadingOrderContext extends AbstractFlowrAnaly
      * In case you have a certain order, use the `certain` flag to indicate this -- but please take care of *really* being certain!
      */
     addGuess(guess: readonly RParseRequest[], certain?: boolean): void;
-    currentGuesses(): readonly RParseRequest[][];
+    currentGuesses(): readonly (readonly RParseRequest[])[];
     currentKnownOrder(): readonly RParseRequest[] | undefined;
     peekLoadingOrder(): readonly RParseRequest[] | undefined;
     getUnorderedRequests(): readonly RParseRequest[];

package/project/context/flowr-analyzer-loading-order-context.js

@@ -65,12 +65,16 @@ class FlowrAnalyzerLoadingOrderContext extends abstract_flowr_analyzer_context_1
                 loadingOrderLog.warn(`Adding certain guess ${guess.map(g => g.request).join(', ')} after known order!`);
                 if (!(0, arrays_1.arrayEqual)(this.knownOrder, guess)) {
                     loadingOrderLog.error(`Certain guess ${guess.map(g => g.request).join(', ')} does not match known order ${this.knownOrder.map(g => g.request).join(', ')}`);
+                    this.guesses.push(guess);
                 }
             }
             else {
                 this.knownOrder = guess;
             }
         }
+        else {
+            this.guesses.push(guess);
+        }
     }
     currentGuesses() {
         return this.guesses;

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

@@ -1,9 +1,12 @@
 import { type FlowrFileProvider, type FileRole, FlowrFile } from '../../../context/flowr-file';
+import type { RAuthorInfo } from '../../../../util/r-author';
+import type { DeepReadonly } from 'ts-essentials';
+import type { RLicenseElementInfo } from '../../../../util/r-license';
 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.
  */
-export declare class FlowrDescriptionFile extends FlowrFile<DCF> {
+export declare class FlowrDescriptionFile extends FlowrFile<DeepReadonly<DCF>> {
     private readonly wrapped;
     /**
      * Prefer the static {@link FlowrDescriptionFile.from} method to create instances of this class as it will not re-create if already a description file
@@ -19,4 +22,18 @@ export declare class FlowrDescriptionFile extends FlowrFile<DCF> {
      * Description file lifter, this does not re-create if already a description file
      */
     static from(file: FlowrFileProvider | FlowrDescriptionFile, role?: FileRole): FlowrDescriptionFile;
+    /**
+     * Returns the parsed license information from the 'License' field in the DESCRIPTION file.
+     */
+    license(): RLicenseElementInfo[] | undefined;
+    /**
+     * Returns the parsed authors from the `Authors@R` field in the DESCRIPTION file.
+     */
+    authors(): RAuthorInfo[] | undefined;
 }
+/**
+ * Parses the 'License' field from an R DESCRIPTION file into SPDX license expressions.
+ * @param licenseField - The 'License' field from the DESCRIPTION file as an array of strings.
+ * @returns An array of SPDX license information objects if parsing was successful.
+ */
+export declare function parseRLicenseField(...licenseField: string[]): RLicenseElementInfo[];

package/project/plugins/file-plugins/files/flowr-description-file.js

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowrDescriptionFile = void 0;
+exports.parseRLicenseField = parseRLicenseField;
 const flowr_file_1 = require("../../../context/flowr-file");
+const r_author_1 = require("../../../../util/r-author");
+const args_1 = require("../../../../util/text/args");
+const r_license_1 = require("../../../../util/r-license");
 /**
  * This decorates a text file and provides access to its content as a DCF (Debian Control File)-like structure.
  */
@@ -31,8 +35,46 @@ class FlowrDescriptionFile extends flowr_file_1.FlowrFile {
         }
         return file instanceof FlowrDescriptionFile ? file : new FlowrDescriptionFile(file);
     }
+    /**
+     * Returns the parsed license information from the 'License' field in the DESCRIPTION file.
+     */
+    license() {
+        const licenses = this.content().get('License');
+        if (!licenses) {
+            return undefined;
+        }
+        return parseRLicenseField(...licenses);
+    }
+    /**
+     * Returns the parsed authors from the `Authors@R` field in the DESCRIPTION file.
+     */
+    authors() {
+        const authors = this.content().get('Authors@R');
+        return authors ? authors.flatMap(r_author_1.parseRAuthorString) : undefined;
+    }
 }
 exports.FlowrDescriptionFile = FlowrDescriptionFile;
+/**
+ * Parses the 'License' field from an R DESCRIPTION file into SPDX license expressions.
+ * @param licenseField - The 'License' field from the DESCRIPTION file as an array of strings.
+ * @returns An array of SPDX license information objects if parsing was successful.
+ */
+function parseRLicenseField(...licenseField) {
+    return licenseField.map(r_license_1.parseRLicense);
+}
+function emplaceDCF(key, val, result) {
+    if (!key) {
+        return;
+    }
+    let values = [];
+    if (key.includes('@')) {
+        values = [val.trim()];
+    }
+    else {
+        values = val ? cleanValues(val) : [];
+    }
+    result.set(key, values);
+}
 /**
  * Parses the given file in the 'Debian Control Format'.
  * @param file - The file to parse
@@ -49,27 +91,19 @@ function parseDCF(file) {
             currentValue += '\n' + line.trim();
         }
         else {
-            if (currentKey) {
-                const values = currentValue ? cleanValues(currentValue) : [];
-                result.set(currentKey, values);
-            }
+            emplaceDCF(currentKey, currentValue, result);
             const [key, rest] = line.split(firstColonRegex).map(s => s.trim());
             currentKey = key?.trim() ?? '';
             currentValue = rest?.trim() ?? '';
         }
     }
-    if (currentKey) {
-        const values = currentValue ? cleanValues(currentValue) : [];
-        result.set(currentKey, values);
-    }
+    emplaceDCF(currentKey, currentValue, result);
     return result;
 }
-const cleanSplitRegex = /[\n,]+/;
-const cleanQuotesRegex = /'/g;
+const splitRegex = /[\n\r]+/g;
 function cleanValues(values) {
-    return values
-        .split(cleanSplitRegex)
-        .map(s => s.trim().replace(cleanQuotesRegex, ''))
+    return values.split(splitRegex).flatMap(l => (0, args_1.splitAtEscapeSensitive)(l, false, ','))
+        .map(s => s.trim())
         .filter(s => s.length > 0);
 }
 //# sourceMappingURL=flowr-description-file.js.map

package/project/plugins/loading-order-plugins/flowr-analyzer-loading-order-description-file-plugin.js

@@ -5,6 +5,7 @@ const flowr_analyzer_description_file_plugin_1 = require("../file-plugins/flowr-
 const semver_1 = require("semver");
 const flowr_analyzer_loading_order_plugin_1 = require("./flowr-analyzer-loading-order-plugin");
 const flowr_file_1 = require("../../context/flowr-file");
+const retriever_1 = require("../../../r-bridge/retriever");
 /**
  * This plugin extracts loading order information from R `DESCRIPTION` files.
  * It looks at the `Collate` field to determine the order in which files should be loaded.
@@ -16,14 +17,18 @@ class FlowrAnalyzerLoadingOrderDescriptionFilePlugin extends flowr_analyzer_load
     version = new semver_1.SemVer('0.1.0');
     process(ctx) {
         const descFiles = ctx.files.getFilesByRole(flowr_file_1.FileRole.Description);
-        if (descFiles.length !== 1) {
-            flowr_analyzer_description_file_plugin_1.descriptionFileLog.warn(`Supporting only exactly one DESCRIPTION file, found ${descFiles.length}`);
+        if (descFiles.length === 0) {
+            flowr_analyzer_description_file_plugin_1.descriptionFileLog.warn('No description file found, cannot determine loading order from Collate field.');
             return;
         }
+        else if (descFiles.length > 1) {
+            flowr_analyzer_description_file_plugin_1.descriptionFileLog.warn(`Found ${descFiles.length} description files, expected exactly one.`);
+        }
         /** this will do the caching etc. for me */
         const deps = descFiles[0].content();
         if (deps.has('Collate')) {
-            const collate = deps.get('Collate') ?? [];
+            const collate = deps.get('Collate')?.map(f => (0, retriever_1.removeRQuotes)(f))
+                ?? [];
             /* we probably have to do some more guesswork here */
             const unordered = ctx.files.loadingOrder.getUnorderedRequests();
             // sort them by their path index in the Collate field

package/project/plugins/package-version-plugins/flowr-analyzer-package-versions-description-file-plugin.js

@@ -17,10 +17,13 @@ class FlowrAnalyzerPackageVersionsDescriptionFilePlugin extends flowr_analyzer_p
     version = new semver_1.SemVer('0.1.0');
     process(ctx) {
         const descFiles = ctx.files.getFilesByRole(flowr_file_1.FileRole.Description);
-        if (descFiles.length !== 1) {
-            flowr_analyzer_description_file_plugin_1.descriptionFileLog.warn(`Supporting only exactly one DESCRIPTION file, found ${descFiles.length}`);
+        if (descFiles.length === 0) {
+            flowr_analyzer_description_file_plugin_1.descriptionFileLog.warn('No description file found, cannot extract package versions.');
             return;
         }
+        else if (descFiles.length > 1) {
+            flowr_analyzer_description_file_plugin_1.descriptionFileLog.warn(`Found ${descFiles.length} description files, expected exactly one.`);
+        }
         /** this will do the caching etc. for me */
         const deps = descFiles[0].content();
         this.retrieveVersionsFromField(ctx, deps, 'Depends', 'r');