@eagleoutice/flowr 2.8.3 → 2.8.4

package/cli/repl/core.js

@@ -61,6 +61,7 @@ const repl_main_1 = require("./commands/repl-main");
 const log_1 = require("../../util/log");
 const query_1 = require("../../queries/query");
 const strings_1 = require("../../util/text/strings");
+const instrument_dataflow_count_1 = require("../../dataflow/instrument/instrument-dataflow-count");
 let _replCompleterKeywords = undefined;
 function replCompleterKeywords() {
     if (_replCompleterKeywords === undefined) {
@@ -146,6 +147,10 @@ function handleString(code) {
 }
 async function replProcessStatement(output, statement, analyzer, allowRSessionAccess) {
     const time = Date.now();
+    const heatMap = new Map();
+    if (analyzer.inspectContext().config.repl.dfProcessorHeat) {
+        analyzer.context().config.solver.instrument.dataflowExtractors = (0, instrument_dataflow_count_1.instrumentDataflowCount)(heatMap, map => map.clear());
+    }
     if (statement.startsWith(':')) {
         const command = statement.slice(1).split(' ')[0].toLowerCase();
         const processor = (0, repl_commands_1.getCommand)(command);
@@ -201,6 +206,23 @@ async function replProcessStatement(output, statement, analyzer, allowRSessionAc
             // do nothing, this is just a nice-to-have
         }
     }
+    if (heatMap.size > 0 && analyzer.inspectContext().config.repl.dfProcessorHeat) {
+        const sorted = Array.from(heatMap.entries()).sort((a, b) => b[1] - a[1]);
+        console.log(output.formatter.format('[REPL Stats] Dataflow Processor Heatmap:', {
+            style: 3 /* FontStyles.Italic */,
+            effect: ansi_1.ColorEffect.Foreground,
+            color: 7 /* Colors.White */
+        }));
+        const longestKey = Math.max(...Array.from(heatMap.keys(), k => k.length));
+        const longestValue = Math.max(...Array.from(heatMap.values(), v => v.toString().length));
+        for (const [rType, count] of sorted) {
+            console.log(output.formatter.format(` - ${(rType + ':').padEnd(longestKey + 1, ' ')} ${count.toString().padStart(longestValue, ' ')}`, {
+                style: 3 /* FontStyles.Italic */,
+                effect: ansi_1.ColorEffect.Foreground,
+                color: 7 /* Colors.White */
+            }));
+        }
+    }
 }
 /**
  * This function interprets the given `expr` as a REPL command (see {@link repl} for more on the semantics).

package/config.d.ts

@@ -3,6 +3,9 @@ import Joi from 'joi';
 import type { BuiltInDefinitions } from './dataflow/environments/built-in-config';
 import type { KnownParser } from './r-bridge/parser';
 import type { DeepWritable } from 'ts-essentials';
+import type { DataflowProcessors } from './dataflow/processor';
+import type { ParentInformation } from './r-bridge/lang-4.x/ast/model/processing/decorate';
+import type { FlowrAnalyzerContext } from './project/context/flowr-analyzer-context';
 export declare enum VariableResolve {
     /** Don't resolve constants at all */
     Disabled = "disabled",
@@ -102,6 +105,8 @@ export interface FlowrConfigOptions extends MergeableRecord {
     readonly repl: {
         /** Whether to show quick stats in the REPL after each evaluation */
         quickStats: boolean;
+        /** This instruments the dataflow processors to count how often each processor is called */
+        dfProcessorHeat: boolean;
     };
     readonly project: {
         /** Whether to resolve unknown paths loaded by the r project disk when trying to source/analyze files */
@@ -137,6 +142,15 @@ export interface FlowrConfigOptions extends MergeableRecord {
              */
             readonly maxIndexCount: number;
         };
+        /** These keys are only intended for use within code, allowing to instrument the dataflow analyzer! */
+        readonly instrument: {
+            /**
+             * Modify the dataflow processors used during dataflow analysis.
+             * Make sure that all processors required for correct analysis are still present!
+             * This may have arbitrary consequences on the analysis precision and performance, consider focusing on decorating existing processors instead of replacing them.
+             */
+            dataflowExtractors?: (extractor: DataflowProcessors<ParentInformation>, ctx: FlowrAnalyzerContext) => DataflowProcessors<ParentInformation>;
+        };
         /**
          * If lax source calls are active, flowR searches for sourced files much more freely,
          * based on the configurations you give it.

package/config.js

@@ -66,7 +66,8 @@ exports.defaultConfigOptions = {
         }
     },
     repl: {
-        quickStats: false
+        quickStats: false,
+        dfProcessorHeat: false
     },
     project: {
         resolveUnknownPathsOnDisk: true
@@ -84,6 +85,9 @@ exports.defaultConfigOptions = {
             searchPath: [],
             repeatedSourceLimit: 2
         },
+        instrument: {
+            dataflowExtractors: undefined
+        },
         slicer: {
             threshold: 50
         }
@@ -110,7 +114,8 @@ exports.flowrConfigFileSchema = joi_1.default.object({
         }).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.')
+        quickStats: joi_1.default.boolean().optional().description('Whether to show quick stats in the REPL after each evaluation.'),
+        dfProcessorHeat: joi_1.default.boolean().optional().description('This instruments the dataflow processors to count how often each processor is called.')
     }).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.')
@@ -131,6 +136,9 @@ exports.flowrConfigFileSchema = joi_1.default.object({
         pointerTracking: joi_1.default.alternatives(joi_1.default.boolean(), joi_1.default.object({
             maxIndexCount: joi_1.default.number().required().description('The maximum number of indices tracked per object with the pointer analysis.')
         })).description('Whether to track pointers in the dataflow graph, if not, the graph will be over-approximated wrt. containers and accesses.'),
+        instrument: joi_1.default.object({
+            dataflowExtractors: joi_1.default.any().optional().description('These keys are only intended for use within code, allowing to instrument the dataflow analyzer!')
+        }),
         resolveSource: joi_1.default.object({
             dropPaths: joi_1.default.string().valid(...Object.values(DropPathsOption)).description('Allow to drop the first or all parts of the sourced path, if it is relative.'),
             ignoreCapitalization: joi_1.default.boolean().description('Search for filenames matching in the lowercase.'),

package/control-flow/extract-cfg.js

@@ -148,8 +148,10 @@ function cfgIfThenElse(ifNode, condition, then, otherwise) {
     for (const entryPoint of condition.entryPoints) {
         graph.addEdge(entryPoint, ifId, { label: 0 /* CfgEdgeType.Fd */ });
     }
-    for (const exit of [...then.exitPoints, ...otherwise?.exitPoints ?? []]) {
-        graph.addEdge(ifId + '-exit', exit, { label: 0 /* CfgEdgeType.Fd */ });
+    for (const exits of [then.exitPoints, otherwise?.exitPoints ?? []]) {
+        for (const exit of exits) {
+            graph.addEdge(ifId + '-exit', exit, { label: 0 /* CfgEdgeType.Fd */ });
+        }
     }
     if (!otherwise) {
         for (const e of condition.exitPoints) {
@@ -173,8 +175,10 @@ function cfgRepeat(repeat, body) {
         graph.addEdge(entryPoint, repeat.info.id, { label: 0 /* CfgEdgeType.Fd */ });
     }
     // loops automatically
-    for (const next of [...body.nexts, ...body.exitPoints]) {
-        graph.addEdge(repeat.info.id, next, { label: 0 /* CfgEdgeType.Fd */ });
+    for (const nexts of [body.nexts, body.exitPoints]) {
+        for (const next of nexts) {
+            graph.addEdge(repeat.info.id, next, { label: 0 /* CfgEdgeType.Fd */ });
+        }
     }
     for (const breakPoint of body.breaks) {
         graph.addEdge(repeat.info.id + '-exit', breakPoint, { label: 0 /* CfgEdgeType.Fd */ });
@@ -195,8 +199,10 @@ function cfgWhile(whileLoop, condition, body) {
             graph.addEdge(entry, e, { label: 1 /* CfgEdgeType.Cd */, when: convert_values_1.RTrue, caused: whileId });
         }
     }
-    for (const next of [...body.nexts, ...body.exitPoints]) {
-        graph.addEdge(whileId, next, { label: 0 /* CfgEdgeType.Fd */ });
+    for (const nexts of [body.nexts, body.exitPoints]) {
+        for (const next of nexts) {
+            graph.addEdge(whileId, next, { label: 0 /* CfgEdgeType.Fd */ });
+        }
     }
     for (const breakPoint of body.breaks) {
         graph.addEdge(whileId + '-exit', breakPoint, { label: 0 /* CfgEdgeType.Fd */ });
@@ -230,8 +236,10 @@ function cfgFor(forLoop, variable, vector, body) {
             graph.addEdge(entry, e, { label: 1 /* CfgEdgeType.Cd */, when: convert_values_1.RTrue, caused: forLoopId });
         }
     }
-    for (const next of [...body.nexts, ...body.exitPoints]) {
-        graph.addEdge(forLoopId, next, { label: 0 /* CfgEdgeType.Fd */ });
+    for (const points of [body.nexts, body.exitPoints]) {
+        for (const next of points) {
+            graph.addEdge(forLoopId, next, { label: 0 /* CfgEdgeType.Fd */ });
+        }
     }
     for (const breakPoint of body.breaks) {
         graph.addEdge(forLoopId + '-exit', breakPoint, { label: 0 /* CfgEdgeType.Fd */ });
@@ -257,10 +265,14 @@ function cfgFunctionDefinition(fn, params, body) {
     graph.addVertex({ id: fnId + '-exit', type: control_flow_graph_1.CfgVertexType.EndMarker, root: fnId }, false);
     graph.addVertex({ id: fnId, children, type: identifyMayStatementType(fn), mid: paramExits, end: [fnId + '-exit'] });
     graph.mergeWith(body.graph, true);
-    children.push(...body.graph.rootIds());
+    for (const r of body.graph.rootIds()) {
+        children.push(r);
+    }
     for (const param of params) {
         graph.mergeWith(param.graph, true);
-        children.push(...param.graph.rootIds());
+        for (const r of param.graph.rootIds()) {
+            children.push(r);
+        }
         for (const entry of param.entryPoints) {
             graph.addEdge(entry, fnId, { label: 0 /* CfgEdgeType.Fd */ });
         }
@@ -282,7 +294,14 @@ function cfgFunctionDefinition(fn, params, body) {
 function cfgFunctionCall(call, name, args, exit = 'exit') {
     const callId = call.info.id;
     const graph = name.graph;
-    const info = { graph, breaks: [...name.breaks], nexts: [...name.nexts], returns: [...name.returns], exitPoints: [callId + '-' + exit], entryPoints: [callId] };
+    const info = {
+        graph,
+        breaks: Array.from(name.breaks),
+        nexts: Array.from(name.nexts),
+        returns: Array.from(name.returns),
+        exitPoints: [callId + '-' + exit],
+        entryPoints: [callId]
+    };
     graph.addVertex({ id: callId, type: identifyMayStatementType(call), mid: name.exitPoints, end: [callId + '-' + exit] });
     for (const entryPoint of name.entryPoints) {
         graph.addEdge(entryPoint, callId, { label: 0 /* CfgEdgeType.Fd */ });
@@ -333,8 +352,10 @@ function cfgFunctionCallWithDataflow(graph) {
                 type: control_flow_graph_1.CfgVertexType.EndMarker,
                 root: call.info.id
             });
-            for (const exit of [...baseCfg.exitPoints, ...exits]) {
-                baseCfg.graph.addEdge(call.info.id + exports.ResolvedCallSuffix, exit, { label: 0 /* CfgEdgeType.Fd */ });
+            for (const col of [baseCfg.exitPoints, exits]) {
+                for (const exit of col) {
+                    baseCfg.graph.addEdge(call.info.id + exports.ResolvedCallSuffix, exit, { label: 0 /* CfgEdgeType.Fd */ });
+                }
             }
             return {
                 ...baseCfg,
@@ -380,7 +401,7 @@ function cfgArgumentOrParameter(node, name, value) {
 }
 function cfgBinaryOp(binOp, lhs, rhs) {
     const graph = new control_flow_graph_1.ControlFlowGraph().mergeWith(lhs.graph).mergeWith(rhs.graph);
-    const result = { graph, breaks: [...lhs.breaks, ...rhs.breaks], nexts: [...lhs.nexts, ...rhs.nexts], returns: [...lhs.returns, ...rhs.returns], entryPoints: [binOp.info.id], exitPoints: [binOp.info.id + '-exit'] };
+    const result = { graph, breaks: lhs.breaks.concat(rhs.breaks), nexts: lhs.nexts.concat(rhs.nexts), returns: lhs.returns.concat(rhs.returns), entryPoints: [binOp.info.id], exitPoints: [binOp.info.id + '-exit'] };
     graph.addVertex({ id: binOp.info.id, type: binOp.flavor === 'assignment' ? control_flow_graph_1.CfgVertexType.Statement : control_flow_graph_1.CfgVertexType.Expression, end: [binOp.info.id + '-exit'] });
     graph.addVertex({ id: binOp.info.id + '-exit', type: control_flow_graph_1.CfgVertexType.EndMarker, root: binOp.info.id });
     for (const exitPoint of lhs.exitPoints) {

package/core/print/slice-diff-ansi.js

@@ -13,7 +13,7 @@ function mergeJointRangesInSorted(loc) {
             return [
                 ...acc.slice(0, -1), {
                     selected: curr.selected || acc[acc.length - 1].selected,
-                    location: (0, range_1.mergeRanges)(acc[acc.length - 1].location, curr.location)
+                    location: (0, range_1.mergeRanges)([acc[acc.length - 1].location, curr.location])
                 }
             ];
         }

package/dataflow/extractor.js

@@ -89,7 +89,7 @@ function resolveLinkToSideEffects(ast, graph) {
             continue;
         }
         /* this has to change whenever we add a new link to relations because we currently offer no abstraction for the type */
-        const potentials = (0, identify_link_to_last_call_relation_1.identifyLinkToLastCallRelation)(s.id, cf.graph, graph, s.linkTo, knownCalls);
+        const potentials = (0, identify_link_to_last_call_relation_1.identifyLinkToLastCallRelation)(s.id, cf?.graph, graph, s.linkTo, knownCalls);
         for (const pot of potentials) {
             graph.addEdge(s.id, pot, edge_1.EdgeType.Reads);
         }
@@ -113,7 +113,7 @@ function produceDataFlowGraph(parser, completeAst, ctx) {
         parser,
         completeAst,
         environment: ctx.env.makeCleanEnv(),
-        processors: exports.processors,
+        processors: ctx.config.solver.instrument.dataflowExtractors?.(exports.processors, ctx) ?? exports.processors,
         controlDependencies: undefined,
         referenceChain: [files[0].filePath],
         ctx

package/dataflow/graph/graph.js

@@ -5,7 +5,6 @@ exports.isPositionalArgument = isPositionalArgument;
 exports.isNamedArgument = isNamedArgument;
 exports.getReferenceOfArgument = getReferenceOfArgument;
 const assert_1 = require("../../util/assert");
-const diff_dataflow_graph_1 = require("./diff-dataflow-graph");
 const vertex_1 = require("./vertex");
 const arrays_1 = require("../../util/collections/arrays");
 const r_function_call_1 = require("../../r-bridge/lang-4.x/ast/model/nodes/r-function-call");
@@ -385,9 +384,6 @@ function mergeNodeInfos(current, next) {
     if (current.tag === vertex_1.VertexType.VariableDefinition) {
         (0, assert_1.guard)(current.scope === next.scope, 'nodes to be joined for the same id must have the same scope');
     }
-    else if (current.tag === vertex_1.VertexType.FunctionCall) {
-        (0, assert_1.guard)((0, diff_dataflow_graph_1.equalFunctionArguments)(current.id, current.args, next.args), 'nodes to be joined for the same id must have the same function call information');
-    }
     else if (current.tag === vertex_1.VertexType.FunctionDefinition) {
         (0, assert_1.guard)(current.scope === next.scope, 'nodes to be joined for the same id must have the same scope');
         current.exitPoints = (0, arrays_1.uniqueArrayMerge)(current.exitPoints, next.exitPoints);

package/dataflow/instrument/instrument-dataflow-count.d.ts

@@ -0,0 +1,9 @@
+import type { DataflowProcessors } from '../processor';
+import type { ParentInformation } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
+import type { FlowrAnalyzerContext } from '../../project/context/flowr-analyzer-context';
+import type { RType } from '../../r-bridge/lang-4.x/ast/model/type';
+/**
+ * This takes the out parameter `countMap` and fills it with the count of how many times each RType was processed.
+ * The accompanying `reset` function can be used to reset the map to an empty state.
+ */
+export declare function instrumentDataflowCount(countMap: Map<RType, number>, reset: (map: Map<RType, number>) => void): (extractor: DataflowProcessors<ParentInformation>, ctx: FlowrAnalyzerContext) => DataflowProcessors<ParentInformation>;

package/dataflow/instrument/instrument-dataflow-count.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instrumentDataflowCount = instrumentDataflowCount;
+/**
+ * This takes the out parameter `countMap` and fills it with the count of how many times each RType was processed.
+ * The accompanying `reset` function can be used to reset the map to an empty state.
+ */
+function instrumentDataflowCount(countMap, reset) {
+    return (extractor, _ctx) => {
+        reset(countMap);
+        const instrumented = {};
+        for (const [key, processor] of Object.entries(extractor)) {
+            instrumented[key] = ((...args) => {
+                const prev = countMap.get(key) ?? 0;
+                countMap.set(key, prev + 1);
+                return processor(...args);
+            });
+        }
+        return instrumented;
+    };
+}
+//# sourceMappingURL=instrument-dataflow-count.js.map

package/dataflow/internal/process/functions/call/built-in/built-in-assignment.js

@@ -221,13 +221,20 @@ function extractSourceAndTarget(args) {
  * Promotes the ingoing/unknown references of target (an assignment) to definitions
  */
 function produceWrittenNodes(rootId, target, referenceType, data, makeMaybe, value) {
-    return target.in.concat(target.unknownReferences).map(ref => ({
-        ...ref,
-        type: referenceType,
-        definedAt: rootId,
-        controlDependencies: data.controlDependencies ?? (makeMaybe ? [] : undefined),
-        value
-    }));
+    const written = [];
+    for (const refs of [target.in, target.unknownReferences]) {
+        for (const ref of refs) {
+            written.push({
+                nodeId: ref.nodeId,
+                name: ref.name,
+                type: referenceType,
+                definedAt: rootId,
+                controlDependencies: data.controlDependencies ?? (makeMaybe ? [] : undefined),
+                value
+            });
+        }
+    }
+    return written;
 }
 function processAssignmentToString(target, args, name, rootId, data, config, source) {
     const symbol = {

package/dataflow/internal/process/functions/call/built-in/built-in-expression-list.js

@@ -126,8 +126,10 @@ function processExpressionList(name, args, rootId, data) {
         }
         out = out.concat(processed.out);
         // all inputs that have not been written until now are read!
-        for (const read of processed.in.concat(processed.unknownReferences)) {
-            linkReadNameToWriteIfPossible(read, environment, listEnvironments, remainingRead, nextGraph);
+        for (const ls of [processed.in, processed.unknownReferences]) {
+            for (const read of ls) {
+                linkReadNameToWriteIfPossible(read, environment, listEnvironments, remainingRead, nextGraph);
+            }
         }
         const calledEnvs = (0, linker_1.linkFunctionCalls)(nextGraph, data.completeAst.idMap, processed.graph);
         for (const c of calledEnvs) {

package/documentation/wiki-interface.js

@@ -241,7 +241,8 @@ ${(0, doc_code_1.codeBlock)('json', JSON.stringify({
             }
         },
         repl: {
-            quickStats: false
+            quickStats: false,
+            dfProcessorHeat: false
         },
         project: {
             resolveUnknownPathsOnDisk: true
@@ -257,6 +258,7 @@ ${(0, doc_code_1.codeBlock)('json', JSON.stringify({
                 inferWorkingDirectory: config_1.InferWorkingDirectory.ActiveScript,
                 searchPath: []
             },
+            instrument: {},
             slicer: {
                 threshold: 50
             }

package/documentation/wiki-query.js

@@ -457,7 +457,7 @@ ${await (0, doc_repl_1.documentReplSession)(shell, [
         ])}
 
 One of the most useful options to change on-the-fly are probably those under \`repl\`. For example, setting \`repl.quickStats=true\`
-enables quick statistics after each REPL command.
+enables quick statistics after each REPL command. Likewise, setting \`repl.dfProcessorHeat=true\` enables the dataflow processor heatmap after each REPL command.
 `;
     }
 });

package/linter/rules/unused-definition.js

@@ -33,10 +33,11 @@ function buildQuickFix(variable, dfg, ast) {
     if (hasImportantArgs) {
         return undefined; // we can not remove this definition, it has important arguments
     }
-    const totalRangeToRemove = (0, range_1.mergeRanges)(...definedBys.map(d => {
-        const vertex = ast.idMap.get(d);
-        return vertex?.info.fullRange ?? vertex?.location;
-    }), variable.info.fullRange ?? variable.location);
+    const totalRangeToRemove = (0, range_1.mergeRanges)([...definedBys.map(d => {
+            const vertex = ast.idMap.get(d);
+            return vertex?.info.fullRange ?? vertex?.location;
+        }),
+        variable.info.fullRange ?? variable.location]);
     return [{
             type: 'remove',
             range: totalRangeToRemove,
@@ -52,7 +53,7 @@ function onlyKeepSupersetOfUnused(elements) {
         return elements; // nothing to filter, only one element
     }
     return elements.filter(e => {
-        const otherRange = (0, range_1.mergeRanges)(...(e.quickFix?.map(q => q.range) ?? [e.range]));
+        const otherRange = (0, range_1.mergeRanges)((e.quickFix?.map(q => q.range) ?? [e.range]));
         return !ranges.some(r => (0, range_1.rangeCompare)(r, otherRange) !== 0 && (0, range_1.rangeIsSubsetOf)(otherRange, r)); // there is no smaller remove
     });
 }

package/package.json

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

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

@@ -24,6 +24,7 @@ export type RoleBasedFiles = {
     [FileRole.Namespace]: FlowrNamespaceFile[];
     [FileRole.Vignette]: FlowrFileProvider[];
     [FileRole.Test]: FlowrFileProvider[];
+    [FileRole.License]: FlowrFileProvider[];
     [FileRole.Source]: FlowrFileProvider[];
     [FileRole.Data]: FlowrFileProvider[];
     [FileRole.Other]: FlowrFileProvider[];

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

@@ -23,6 +23,8 @@ export declare enum FileRole {
     Test = "test",
     /** Data files, e.g., `R/sysdata.rda`, currently not specially supported. */
     Data = "data",
+    /** Signals separate license files, but please note, that DESCRIPTION files may contain license info too */
+    License = "license",
     /**
      * Catch-all for any file that provides usable R source code to incorporate into the analysis.
      * Please note, that the loading order/inclusion and even potential relevance of these source files

package/project/context/flowr-file.js

@@ -24,6 +24,8 @@ var FileRole;
     FileRole["Test"] = "test";
     /** Data files, e.g., `R/sysdata.rda`, currently not specially supported. */
     FileRole["Data"] = "data";
+    /** Signals separate license files, but please note, that DESCRIPTION files may contain license info too */
+    FileRole["License"] = "license";
     /**
      * Catch-all for any file that provides usable R source code to incorporate into the analysis.
      * Please note, that the loading order/inclusion and even potential relevance of these source files

package/project/plugins/file-plugins/flowr-analyzer-license-file-plugin.d.ts

@@ -0,0 +1,24 @@
+import { FlowrAnalyzerFilePlugin } from './flowr-analyzer-file-plugin';
+import { SemVer } from 'semver';
+import type { PathLike } from 'fs';
+import type { FlowrAnalyzerContext } from '../../context/flowr-analyzer-context';
+import type { FlowrFileProvider } from '../../context/flowr-file';
+/**
+ * This plugin provides supports for the identification of license files.
+ */
+export declare class FlowrAnalyzerLicenseFilePlugin extends FlowrAnalyzerFilePlugin {
+    readonly name = "flowr-analyzer-license-files-plugin";
+    readonly description = "This plugin provides support for loading license files.";
+    readonly version: SemVer;
+    private readonly pathPattern;
+    /**
+     * Creates a new instance of the TEST file plugin.
+     * @param pathPattern - The pathPattern to identify TEST files, see {@link FileNamePattern} for the default pathPattern.
+     */
+    constructor(pathPattern?: RegExp);
+    applies(file: PathLike): boolean;
+    /**
+     * Processes the given file, assigning it the {@link FileRole.License} role.
+     */
+    process(_ctx: FlowrAnalyzerContext, file: FlowrFileProvider): FlowrFileProvider;
+}

package/project/plugins/file-plugins/flowr-analyzer-license-file-plugin.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowrAnalyzerLicenseFilePlugin = void 0;
+const flowr_analyzer_file_plugin_1 = require("./flowr-analyzer-file-plugin");
+const semver_1 = require("semver");
+const flowr_file_1 = require("../../context/flowr-file");
+const built_in_source_1 = require("../../../dataflow/internal/process/functions/call/built-in/built-in-source");
+const FileNamePattern = /license(\.md|\.txt)?$/i;
+/**
+ * This plugin provides supports for the identification of license files.
+ */
+class FlowrAnalyzerLicenseFilePlugin extends flowr_analyzer_file_plugin_1.FlowrAnalyzerFilePlugin {
+    name = 'flowr-analyzer-license-files-plugin';
+    description = 'This plugin provides support for loading license files.';
+    version = new semver_1.SemVer('0.1.0');
+    pathPattern;
+    /**
+     * Creates a new instance of the TEST file plugin.
+     * @param pathPattern - The pathPattern to identify TEST files, see {@link FileNamePattern} for the default pathPattern.
+     */
+    constructor(pathPattern = FileNamePattern) {
+        super();
+        this.pathPattern = pathPattern;
+    }
+    applies(file) {
+        return this.pathPattern.test((0, built_in_source_1.platformBasename)(file.toString()));
+    }
+    /**
+     * Processes the given file, assigning it the {@link FileRole.License} role.
+     */
+    process(_ctx, file) {
+        file.assignRole(flowr_file_1.FileRole.License);
+        return file;
+    }
+}
+exports.FlowrAnalyzerLicenseFilePlugin = FlowrAnalyzerLicenseFilePlugin;
+//# sourceMappingURL=flowr-analyzer-license-file-plugin.js.map

package/project/plugins/flowr-analyzer-plugin-defaults.js

@@ -11,6 +11,7 @@ const flowr_analyzer_namespace_files_plugin_1 = require("./file-plugins/flowr-an
 const flowr_analyzer_news_file_plugin_1 = require("./file-plugins/flowr-analyzer-news-file-plugin");
 const flowr_analyzer_vignette_file_plugin_1 = require("./file-plugins/flowr-analyzer-vignette-file-plugin");
 const flowr_analyzer_test_file_plugin_1 = require("./file-plugins/flowr-analyzer-test-file-plugin");
+const flowr_analyzer_license_file_plugin_1 = require("./file-plugins/flowr-analyzer-license-file-plugin");
 /**
  * Provides the default set of Flowr Analyzer plugins.
  */
@@ -23,6 +24,7 @@ function FlowrAnalyzerPluginDefaults() {
         new flowr_analyzer_loading_order_description_file_plugin_1.FlowrAnalyzerLoadingOrderDescriptionFilePlugin(),
         new flowr_analyzer_rmd_file_plugin_1.FlowrAnalyzerRmdFilePlugin(),
         new flowr_analyzer_qmd_file_plugin_1.FlowrAnalyzerQmdFilePlugin(),
+        new flowr_analyzer_license_file_plugin_1.FlowrAnalyzerLicenseFilePlugin(),
         new flowr_analyzer_jupyter_file_plugin_1.FlowrAnalyzerJupyterFilePlugin(),
         new flowr_analyzer_namespace_files_plugin_1.FlowrAnalyzerNamespaceFilesPlugin(),
         new flowr_analyzer_news_file_plugin_1.FlowrAnalyzerNewsFilePlugin()

package/project/plugins/plugin-registry.d.ts

@@ -9,10 +9,11 @@ import { FlowrAnalyzerNamespaceFilesPlugin } from './file-plugins/flowr-analyzer
 import { FlowrAnalyzerNewsFilePlugin } from './file-plugins/flowr-analyzer-news-file-plugin';
 import { FlowrAnalyzerMetaVignetteFilesPlugin } from './file-plugins/flowr-analyzer-vignette-file-plugin';
 import { FlowrAnalyzerMetaTestFilesPlugin } from './file-plugins/flowr-analyzer-test-file-plugin';
+import { FlowrAnalyzerLicenseFilePlugin } from './file-plugins/flowr-analyzer-license-file-plugin';
 /**
  * The built-in Flowr Analyzer plugins that are always available.
  */
-export declare const BuiltInPlugins: [["file:description", typeof FlowrAnalyzerDescriptionFilePlugin], ["versions:description", typeof FlowrAnalyzerPackageVersionsDescriptionFilePlugin], ["loading-order:description", typeof FlowrAnalyzerLoadingOrderDescriptionFilePlugin], ["files:vignette", typeof FlowrAnalyzerMetaVignetteFilesPlugin], ["files:test", typeof FlowrAnalyzerMetaTestFilesPlugin], ["file:rmd", typeof FlowrAnalyzerRmdFilePlugin], ["file:qmd", typeof FlowrAnalyzerQmdFilePlugin], ["file:ipynb", typeof FlowrAnalyzerJupyterFilePlugin], ["file:namespace", typeof FlowrAnalyzerNamespaceFilesPlugin], ["file:news", typeof FlowrAnalyzerNewsFilePlugin]];
+export declare const BuiltInPlugins: [["file:description", typeof FlowrAnalyzerDescriptionFilePlugin], ["versions:description", typeof FlowrAnalyzerPackageVersionsDescriptionFilePlugin], ["loading-order:description", typeof FlowrAnalyzerLoadingOrderDescriptionFilePlugin], ["files:vignette", typeof FlowrAnalyzerMetaVignetteFilesPlugin], ["files:test", typeof FlowrAnalyzerMetaTestFilesPlugin], ["file:rmd", typeof FlowrAnalyzerRmdFilePlugin], ["file:qmd", typeof FlowrAnalyzerQmdFilePlugin], ["file:ipynb", typeof FlowrAnalyzerJupyterFilePlugin], ["file:namespace", typeof FlowrAnalyzerNamespaceFilesPlugin], ["file:news", typeof FlowrAnalyzerNewsFilePlugin], ["file:license", typeof FlowrAnalyzerLicenseFilePlugin]];
 export type BuiltInFlowrPluginName = typeof BuiltInPlugins[number][0];
 export type BuiltInFlowrPluginArgs<N extends BuiltInFlowrPluginName> = N extends typeof BuiltInPlugins[number][0] ? ConstructorParameters<Extract<typeof BuiltInPlugins[number], [N, PluginProducer]>[1]> : never;
 type PluginProducer = new (...args: never[]) => FlowrAnalyzerPlugin;

package/project/plugins/plugin-registry.js

@@ -15,6 +15,7 @@ const flowr_analyzer_namespace_files_plugin_1 = require("./file-plugins/flowr-an
 const flowr_analyzer_news_file_plugin_1 = require("./file-plugins/flowr-analyzer-news-file-plugin");
 const flowr_analyzer_vignette_file_plugin_1 = require("./file-plugins/flowr-analyzer-vignette-file-plugin");
 const flowr_analyzer_test_file_plugin_1 = require("./file-plugins/flowr-analyzer-test-file-plugin");
+const flowr_analyzer_license_file_plugin_1 = require("./file-plugins/flowr-analyzer-license-file-plugin");
 /**
  * The built-in Flowr Analyzer plugins that are always available.
  */
@@ -28,7 +29,8 @@ exports.BuiltInPlugins = [
     ['file:qmd', flowr_analyzer_qmd_file_plugin_1.FlowrAnalyzerQmdFilePlugin],
     ['file:ipynb', flowr_analyzer_jupyter_file_plugin_1.FlowrAnalyzerJupyterFilePlugin],
     ['file:namespace', flowr_analyzer_namespace_files_plugin_1.FlowrAnalyzerNamespaceFilesPlugin],
-    ['file:news', flowr_analyzer_news_file_plugin_1.FlowrAnalyzerNewsFilePlugin]
+    ['file:news', flowr_analyzer_news_file_plugin_1.FlowrAnalyzerNewsFilePlugin],
+    ['file:license', flowr_analyzer_license_file_plugin_1.FlowrAnalyzerLicenseFilePlugin]
 ];
 /**
  * The registry of built-in and user-registered Flowr Analyzer plugins.

package/project/plugins/project-discovery/flowr-analyzer-project-discovery-plugin.js

@@ -57,7 +57,6 @@ class DefaultFlowrAnalyzerProjectDiscoveryPlugin extends FlowrAnalyzerProjectDis
         const requests = [];
         /* the dummy approach of collecting all files, group R and Rmd files, and be done with it */
         for (const file of (0, files_1.getAllFilesSync)(args.content, /.*/, this.ignorePathsRegex)) {
-            console.log(`Discovered file: ${file}`);
             const relativePath = path_1.default.relative(args.content, file);
             if (this.supportedExtensions.test(relativePath) && (!this.onlyTraversePaths || this.onlyTraversePaths.test(relativePath)) && !this.excludePathsRegex.test((0, built_in_source_1.platformDirname)(relativePath))) {
                 requests.push({ content: file, request: 'file' });

package/queries/catalog/config-query/config-query-format.d.ts

@@ -4,7 +4,7 @@ import { type OutputFormatter } from '../../../util/text/ansi';
 import Joi from 'joi';
 import type { FlowrConfigOptions } from '../../../config';
 import type { DeepPartial } from 'ts-essentials';
-import type { ParsedQueryLine } from '../../query';
+import type { ParsedQueryLine, Query } from '../../query';
 import type { ReplOutput } from '../../../cli/repl/commands/repl-main';
 import type { CommandCompletions } from '../../../cli/repl/core';
 export interface ConfigQuery extends BaseQueryFormat {
@@ -18,7 +18,7 @@ declare function configReplCompleter(partialLine: readonly string[], _startingNe
 declare function configQueryLineParser(output: ReplOutput, line: readonly string[], _config: FlowrConfigOptions): ParsedQueryLine<'config'>;
 export declare const ConfigQueryDefinition: {
     readonly executor: typeof executeConfigQuery;
-    readonly asciiSummarizer: (formatter: OutputFormatter, _analyzer: unknown, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly asciiSummarizer: (formatter: OutputFormatter, _analyzer: unknown, queryResults: BaseQueryResult, result: string[], queries: readonly Query[]) => true;
     readonly completer: typeof configReplCompleter;
     readonly fromLine: typeof configQueryLineParser;
     readonly schema: Joi.ObjectSchema<any>;