@eagleoutice/flowr 2.7.0 → 2.7.3

package/project/plugins/file-plugins/notebooks/flowr-analyzer-jupyter-file-plugin.js

@@ -4,7 +4,7 @@ exports.FlowrAnalyzerJupyterFilePlugin = void 0;
 const semver_1 = require("semver");
 const flowr_analyzer_file_plugin_1 = require("../flowr-analyzer-file-plugin");
 const built_in_source_1 = require("../../../../dataflow/internal/process/functions/call/built-in/built-in-source");
-const flowr_jupyter_file_1 = require("./flowr-jupyter-file");
+const flowr_jupyter_file_1 = require("../files/flowr-jupyter-file");
 const IpynbPattern = /\.ipynb$/i;
 /**
  * The plugin provides support for Jupyter (`.ipynb`) files

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

@@ -3,7 +3,7 @@ import { SemVer } from 'semver';
 import type { FlowrAnalyzerContext } from '../../../context/flowr-analyzer-context';
 import type { FlowrFileProvider } from '../../../context/flowr-file';
 import { FlowrAnalyzerFilePlugin } from '../flowr-analyzer-file-plugin';
-import { FlowrRMarkdownFile } from './flowr-rmarkdown-file';
+import { FlowrRMarkdownFile } from '../files/flowr-rmarkdown-file';
 /**
  * The plugin provides support for Quarto R Markdown (`.qmd`) files
  */

package/project/plugins/file-plugins/notebooks/flowr-analyzer-qmd-file-plugin.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowrAnalyzerQmdFilePlugin = void 0;
 const semver_1 = require("semver");
 const flowr_analyzer_file_plugin_1 = require("../flowr-analyzer-file-plugin");
-const flowr_rmarkdown_file_1 = require("./flowr-rmarkdown-file");
+const flowr_rmarkdown_file_1 = require("../files/flowr-rmarkdown-file");
 const built_in_source_1 = require("../../../../dataflow/internal/process/functions/call/built-in/built-in-source");
 const QmdPattern = /\.qmd$/i;
 /**

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

@@ -3,7 +3,7 @@ import { SemVer } from 'semver';
 import type { FlowrAnalyzerContext } from '../../../context/flowr-analyzer-context';
 import { type FlowrFileProvider } from '../../../context/flowr-file';
 import { FlowrAnalyzerFilePlugin } from '../flowr-analyzer-file-plugin';
-import { FlowrRMarkdownFile } from './flowr-rmarkdown-file';
+import { FlowrRMarkdownFile } from '../files/flowr-rmarkdown-file';
 /**
  * The plugin provides support for R Markdown (`.rmd`) files
  */

package/project/plugins/file-plugins/notebooks/flowr-analyzer-rmd-file-plugin.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowrAnalyzerRmdFilePlugin = void 0;
 const semver_1 = require("semver");
 const flowr_analyzer_file_plugin_1 = require("../flowr-analyzer-file-plugin");
-const flowr_rmarkdown_file_1 = require("./flowr-rmarkdown-file");
+const flowr_rmarkdown_file_1 = require("../files/flowr-rmarkdown-file");
 const built_in_source_1 = require("../../../../dataflow/internal/process/functions/call/built-in/built-in-source");
 const RmdPattern = /\.rmd$/i;
 /**

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

@@ -7,6 +7,8 @@ const flowr_analyzer_loading_order_description_file_plugin_1 = require("./loadin
 const flowr_analyzer_rmd_file_plugin_1 = require("./file-plugins/notebooks/flowr-analyzer-rmd-file-plugin");
 const flowr_analyzer_qmd_file_plugin_1 = require("./file-plugins/notebooks/flowr-analyzer-qmd-file-plugin");
 const flowr_analyzer_jupyter_file_plugin_1 = require("./file-plugins/notebooks/flowr-analyzer-jupyter-file-plugin");
+const flowr_analyzer_namespace_file_plugin_1 = require("./file-plugins/flowr-analyzer-namespace-file-plugin");
+const flowr_analyzer_news_file_plugin_1 = require("./file-plugins/flowr-analyzer-news-file-plugin");
 /**
  * Provides the default set of Flowr Analyzer plugins.
  */
@@ -18,6 +20,8 @@ function FlowrAnalyzerPluginDefaults() {
         new flowr_analyzer_rmd_file_plugin_1.FlowrAnalyzerRmdFilePlugin(),
         new flowr_analyzer_qmd_file_plugin_1.FlowrAnalyzerQmdFilePlugin(),
         new flowr_analyzer_jupyter_file_plugin_1.FlowrAnalyzerJupyterFilePlugin(),
+        new flowr_analyzer_namespace_file_plugin_1.FlowrAnalyzerNamespaceFilePlugin(),
+        new flowr_analyzer_news_file_plugin_1.FlowrAnalyzerNewsFilePlugin()
     ];
 }
 //# sourceMappingURL=flowr-analyzer-plugin-defaults.js.map

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

@@ -32,7 +32,11 @@ class FlowrAnalyzerPackageVersionsDescriptionFilePlugin extends flowr_analyzer_p
             if (match) {
                 const [, name, operator, version] = match;
                 const range = package_1.Package.parsePackageVersionRange(operator, version);
-                ctx.deps.addDependency(new package_1.Package(name, type, undefined, range));
+                ctx.deps.addDependency(new package_1.Package({
+                    name: name,
+                    type: type,
+                    versionConstraints: range ? [range] : undefined
+                }));
             }
         }
     }

package/project/plugins/package-version-plugins/flowr-analyzer-package-versions-namespace-file-plugin.d.ts

@@ -0,0 +1,10 @@
+import { FlowrAnalyzerPackageVersionsPlugin } from './flowr-analyzer-package-versions-plugin';
+import { SemVer } from 'semver';
+import type { FlowrAnalyzerContext } from '../../context/flowr-analyzer-context';
+export declare const namespaceFileLog: import("tslog").Logger<import("tslog").ILogObj>;
+export declare class FlowrAnalyzerPackageVersionsNamespaceFilePlugin extends FlowrAnalyzerPackageVersionsPlugin {
+    readonly name = "flowr-analyzer-package-version-namespace-file-plugin";
+    readonly description = "This plugin does...";
+    readonly version: SemVer;
+    process(ctx: FlowrAnalyzerContext): void;
+}

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

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowrAnalyzerPackageVersionsNamespaceFilePlugin = exports.namespaceFileLog = void 0;
+const flowr_analyzer_package_versions_plugin_1 = require("./flowr-analyzer-package-versions-plugin");
+const semver_1 = require("semver");
+const package_1 = require("./package");
+const flowr_file_1 = require("../../context/flowr-file");
+const log_1 = require("../../../util/log");
+exports.namespaceFileLog = log_1.log.getSubLogger({ name: 'flowr-analyzer-package-versions-namespace-file-plugin' });
+class FlowrAnalyzerPackageVersionsNamespaceFilePlugin extends flowr_analyzer_package_versions_plugin_1.FlowrAnalyzerPackageVersionsPlugin {
+    name = 'flowr-analyzer-package-version-namespace-file-plugin';
+    description = 'This plugin does...';
+    version = new semver_1.SemVer('0.1.0');
+    process(ctx) {
+        const nmspcFiles = ctx.files.getFilesByRole(flowr_file_1.FileRole.Namespace);
+        exports.namespaceFileLog.info(`Found ${nmspcFiles.length} namespace files!`);
+        /** this will do the caching etc. for me */
+        const deps = nmspcFiles[0].content();
+        for (const pkg in deps) {
+            const info = deps[pkg];
+            ctx.deps.addDependency(new package_1.Package({
+                name: pkg,
+                namespaceInfo: info
+            }));
+            for (const exportedSymbol of info.exportedSymbols) {
+                ctx.deps.functionsContext.addFunctionInfo({
+                    name: exportedSymbol,
+                    packageOrigin: pkg,
+                    isExported: true,
+                    isS3Generic: false,
+                });
+            }
+            for (const exportedFunction of info.exportedFunctions) {
+                ctx.deps.functionsContext.addFunctionInfo({
+                    name: exportedFunction,
+                    packageOrigin: pkg,
+                    isExported: true,
+                    isS3Generic: false,
+                });
+            }
+            for (const [genericName, classes] of info.exportS3Generics.entries()) {
+                for (const s3TypeDispatch of classes) {
+                    ctx.deps.functionsContext.addFunctionInfo({
+                        name: genericName,
+                        packageOrigin: pkg,
+                        isExported: true,
+                        isS3Generic: true,
+                        s3TypeDispatch: s3TypeDispatch,
+                    });
+                }
+            }
+        }
+    }
+}
+exports.FlowrAnalyzerPackageVersionsNamespaceFilePlugin = FlowrAnalyzerPackageVersionsNamespaceFilePlugin;
+//# sourceMappingURL=flowr-analyzer-package-versions-namespace-file-plugin.js.map

package/project/plugins/package-version-plugins/package.d.ts

@@ -1,14 +1,27 @@
 import { Range } from 'semver';
+import type { NamespaceInfo } from '../file-plugins/files/flowr-namespace-file';
 export type PackageType = 'package' | 'system' | 'r';
+export type PackageOptions = {
+    derivedVersion?: Range;
+    type?: PackageType;
+    dependencies?: Package[];
+    namespaceInfo?: NamespaceInfo;
+    versionConstraints?: Range[];
+};
 export declare class Package {
     name: string;
     derivedVersion?: Range;
     type?: PackageType;
     dependencies?: Package[];
+    namespaceInfo?: NamespaceInfo;
     versionConstraints: Range[];
-    constructor(name: string, type?: PackageType, dependencies?: Package[], ...versionConstraints: readonly (Range | undefined)[]);
+    constructor(info: {
+        name: string;
+    } & PackageOptions);
+    has(name: string, className?: string): boolean;
+    s3For(generic: string): string[];
     mergeInPlace(other: Package): void;
-    addInfo(type?: PackageType, dependencies?: Package[], ...versionConstraints: readonly Range[]): void;
+    addInfo(info: PackageOptions): void;
     getInfo(): this;
     deriveVersion(): Range | undefined;
     static parsePackageVersionRange(constraint?: string, version?: string): Range | undefined;

package/project/plugins/package-version-plugins/package.js

@@ -8,22 +8,50 @@ class Package {
     derivedVersion;
     type;
     dependencies;
+    namespaceInfo;
     versionConstraints = [];
-    constructor(name, type, dependencies, ...versionConstraints) {
-        this.name = name;
-        this.addInfo(type, dependencies, ...(versionConstraints ?? []).filter(assert_1.isNotUndefined));
+    constructor(info) {
+        this.name = info.name;
+        this.addInfo(info);
+    }
+    has(name, className) {
+        if (!this.namespaceInfo) {
+            return false;
+        }
+        if (name.includes('.')) {
+            const [genericSplit, classSplit] = name.split('.');
+            const classes = this.namespaceInfo.exportS3Generics.get(genericSplit);
+            return classes ? classes.includes(classSplit) : false;
+        }
+        if (className) {
+            const classes = this.namespaceInfo.exportS3Generics.get(name);
+            return classes ? classes.includes(className) : false;
+        }
+        return this.namespaceInfo.exportedFunctions.includes(name) || this.namespaceInfo.exportedSymbols.includes(name);
+    }
+    s3For(generic) {
+        return this.namespaceInfo?.exportS3Generics.get(generic) ?? [];
     }
     mergeInPlace(other) {
         (0, assert_1.guard)(this.name === other.name, 'Can only merge packages with the same name');
-        this.addInfo(other.type, other.dependencies, ...other.versionConstraints);
+        this.addInfo({
+            type: other.type,
+            dependencies: other.dependencies,
+            namespaceInfo: other.namespaceInfo,
+            versionConstraints: other.versionConstraints
+        });
     }
-    addInfo(type, dependencies, ...versionConstraints) {
+    addInfo(info) {
+        const { type, dependencies, namespaceInfo, versionConstraints } = info;
         if (type !== undefined) {
             this.type = type;
         }
         if (dependencies !== undefined) {
             this.dependencies = dependencies;
         }
+        if (namespaceInfo !== undefined) {
+            this.namespaceInfo = namespaceInfo;
+        }
         if (versionConstraints !== undefined) {
             this.derivedVersion ??= versionConstraints[0];
             for (const constraint of versionConstraints) {

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

@@ -5,10 +5,12 @@ import { FlowrAnalyzerLoadingOrderDescriptionFilePlugin } from './loading-order-
 import { FlowrAnalyzerRmdFilePlugin } from './file-plugins/notebooks/flowr-analyzer-rmd-file-plugin';
 import { FlowrAnalyzerQmdFilePlugin } from './file-plugins/notebooks/flowr-analyzer-qmd-file-plugin';
 import { FlowrAnalyzerJupyterFilePlugin } from './file-plugins/notebooks/flowr-analyzer-jupyter-file-plugin';
+import { FlowrAnalyzerNamespaceFilePlugin } from './file-plugins/flowr-analyzer-namespace-file-plugin';
+import { FlowrAnalyzerNewsFilePlugin } from './file-plugins/flowr-analyzer-news-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], ["file:rmd", typeof FlowrAnalyzerRmdFilePlugin], ["file:qmd", typeof FlowrAnalyzerQmdFilePlugin], ["file:ipynb", typeof FlowrAnalyzerJupyterFilePlugin]];
+export declare const BuiltInPlugins: [["file:description", typeof FlowrAnalyzerDescriptionFilePlugin], ["versions:description", typeof FlowrAnalyzerPackageVersionsDescriptionFilePlugin], ["loading-order:description", typeof FlowrAnalyzerLoadingOrderDescriptionFilePlugin], ["file:rmd", typeof FlowrAnalyzerRmdFilePlugin], ["file:qmd", typeof FlowrAnalyzerQmdFilePlugin], ["file:ipynb", typeof FlowrAnalyzerJupyterFilePlugin], ["file:namespace", typeof FlowrAnalyzerNamespaceFilePlugin], ["file:news", typeof FlowrAnalyzerNewsFilePlugin]];
 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

@@ -11,6 +11,8 @@ const flowr_analyzer_rmd_file_plugin_1 = require("./file-plugins/notebooks/flowr
 const flowr_analyzer_qmd_file_plugin_1 = require("./file-plugins/notebooks/flowr-analyzer-qmd-file-plugin");
 const assert_1 = require("../../util/assert");
 const flowr_analyzer_jupyter_file_plugin_1 = require("./file-plugins/notebooks/flowr-analyzer-jupyter-file-plugin");
+const flowr_analyzer_namespace_file_plugin_1 = require("./file-plugins/flowr-analyzer-namespace-file-plugin");
+const flowr_analyzer_news_file_plugin_1 = require("./file-plugins/flowr-analyzer-news-file-plugin");
 /**
  * The built-in Flowr Analyzer plugins that are always available.
  */
@@ -21,6 +23,8 @@ exports.BuiltInPlugins = [
     ['file:rmd', flowr_analyzer_rmd_file_plugin_1.FlowrAnalyzerRmdFilePlugin],
     ['file:qmd', flowr_analyzer_qmd_file_plugin_1.FlowrAnalyzerQmdFilePlugin],
     ['file:ipynb', flowr_analyzer_jupyter_file_plugin_1.FlowrAnalyzerJupyterFilePlugin],
+    ['file:namespace', flowr_analyzer_namespace_file_plugin_1.FlowrAnalyzerNamespaceFilePlugin],
+    ['file:news', flowr_analyzer_news_file_plugin_1.FlowrAnalyzerNewsFilePlugin]
 ];
 /**
  * The registry of built-in and user-registered Flowr Analyzer plugins.

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

@@ -20,6 +20,7 @@ class FlowrAnalyzerProjectDiscoveryPlugin extends flowr_analyzer_plugin_1.FlowrA
 }
 exports.FlowrAnalyzerProjectDiscoveryPlugin = FlowrAnalyzerProjectDiscoveryPlugin;
 const discoverRSourcesRegex = /\.(r|rmd|ipynb|qmd)$/i;
+const ignorePathsWith = /(\.git|\.svn|\.hg|renv|packrat|node_modules|__pycache__|\.Rproj\.user)/i;
 /**
  * This is the default dummy implementation of the {@link FlowrAnalyzerProjectDiscoveryPlugin}.
  * It simply collects all files in the given folder and returns them as either {@link RParseRequest} (for R and Rmd files) or {@link FlowrTextFile} (for all other files).
@@ -29,14 +30,19 @@ class DefaultFlowrAnalyzerProjectDiscoveryPlugin extends FlowrAnalyzerProjectDis
     description = 'This is the default project discovery plugin that does nothing.';
     version = new semver_1.SemVer('0.0.0');
     supportedExtensions;
-    constructor(triggerOnExtensions = discoverRSourcesRegex) {
+    ignorePathsRegex;
+    constructor(triggerOnExtensions = discoverRSourcesRegex, ignorePathsRegex = ignorePathsWith) {
         super();
         this.supportedExtensions = triggerOnExtensions;
+        this.ignorePathsRegex = ignorePathsRegex;
     }
     process(_context, args) {
         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)) {
+            if (this.ignorePathsRegex.test(file)) {
+                continue;
+            }
             if (this.supportedExtensions.test(file)) {
                 requests.push({ content: file, request: 'file' });
             }

package/queries/catalog/dependencies-query/dependencies-query-executor.js

@@ -119,7 +119,8 @@ function getResults(queries, { dataflow, config, normalize }, results, kind, fun
                     linkedIds: linked?.length ? linked : undefined,
                     value: value ?? defaultValue,
                     versionConstraints: dep?.versionConstraints,
-                    derivedVersion: dep?.derivedVersion
+                    derivedVersion: dep?.derivedVersion,
+                    namespaceInfo: dep?.namespaceInfo
                 });
                 if (result) {
                     results.push(result);

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

@@ -6,6 +6,7 @@ import type { FunctionInfo } from './function-info/function-info';
 import type { CallContextQueryResult } from '../call-context-query/call-context-query-format';
 import type { Range } from 'semver';
 import type { AsyncOrSync } from 'ts-essentials';
+import type { NamespaceInfo } from '../../../project/plugins/file-plugins/files/flowr-namespace-file';
 export declare const Unknown = "unknown";
 export interface DependencyCategorySettings {
     queryDisplayName?: string;
@@ -63,6 +64,7 @@ export interface DependencyInfo extends Record<string, unknown> {
     value?: string;
     versionConstraints?: Range[];
     derivedVersion?: Range;
+    namespaceInfo?: NamespaceInfo;
 }
 /**
  * Gets all dependency categories, including user-defined additional categories.

package/queries/catalog/dependencies-query/dependencies-query-format.js

@@ -34,7 +34,8 @@ exports.DefaultDependencyCategories = {
                             functionName: (n.info.fullLexeme ?? n.lexeme).includes(':::') ? ':::' : '::',
                             value: n.namespace,
                             versionConstraints: dep?.versionConstraints,
-                            derivedVersion: dep?.derivedVersion
+                            derivedVersion: dep?.derivedVersion,
+                            namespaceInfo: dep?.namespaceInfo
                         });
                     }
                 });

package/queries/catalog/df-shape-query/df-shape-query-executor.js

@@ -16,7 +16,9 @@ async function executeDfShapeQuery({ analyzer }, queries) {
     const dfg = (await analyzer.dataflow()).graph;
     const cfg = await analyzer.controlflow();
     const start = Date.now();
-    const domains = (0, shape_inference_1.inferDataFrameShapes)(cfg, dfg, ast, analyzer.inspectContext());
+    const inference = new shape_inference_1.DataFrameShapeInferenceVisitor({ controlFlow: cfg, dfg, normalizedAst: ast, ctx: analyzer.inspectContext() });
+    inference.start();
+    const domains = inference.getEndState();
     if (queries.length === 1 && queries[0].criterion === undefined) {
         return {
             '.meta': {
@@ -37,7 +39,7 @@ async function executeDfShapeQuery({ analyzer }, queries) {
         }
         const nodeId = (0, parse_1.slicingCriterionToId)(query.criterion, ast.idMap);
         const node = ast.idMap.get(nodeId);
-        const value = (0, shape_inference_1.resolveIdToDataFrameShape)(node?.info.id, dfg);
+        const value = inference.getAbstractValue(node?.info.id);
         result.set(query.criterion, value);
     }
     return {

package/queries/catalog/files-query/files-query-executor.d.ts

@@ -0,0 +1,6 @@
+import type { FilesQuery, FilesQueryResult } from './files-query-format';
+import type { BasicQueryData } from '../../base-query-format';
+/**
+ * Executes the given files queries using the provided analyzer.
+ */
+export declare function executeFileQuery({ analyzer }: BasicQueryData, queries: readonly FilesQuery[]): Promise<FilesQueryResult>;

package/queries/catalog/files-query/files-query-executor.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeFileQuery = executeFileQuery;
+/**
+ * Executes the given files queries using the provided analyzer.
+ */
+function executeFileQuery({ analyzer }, queries) {
+    const start = Date.now();
+    analyzer.inspectContext().resolvePreAnalysis();
+    const base = analyzer.inspectContext().files.getAllFiles();
+    let files = [];
+    const foundFingerprints = new Set();
+    for (const query of queries) {
+        if (query.matchesPathRegex === undefined && query.roles === undefined) {
+            files = base.map(l => ({
+                role: l.role,
+                content: l.content(),
+                path: l.path()
+            }));
+            break;
+        }
+        const pathRegex = query.matchesPathRegex ? new RegExp(query.matchesPathRegex) : undefined;
+        for (const file of base) {
+            const fingerprint = `${file.role}:::${file.path()}`;
+            if (foundFingerprints.has(fingerprint)) {
+                continue;
+            }
+            if (pathRegex && !pathRegex.test(file.path())) {
+                continue;
+            }
+            if (query.roles && !query.roles.includes(file.role ?? '')) {
+                continue;
+            }
+            foundFingerprints.add(fingerprint);
+            files.push({
+                role: file.role,
+                content: file.content(),
+                path: file.path()
+            });
+        }
+    }
+    return Promise.resolve({
+        '.meta': {
+            timing: Date.now() - start
+        },
+        files
+    });
+}
+//# sourceMappingURL=files-query-executor.js.map

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

@@ -0,0 +1,36 @@
+import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
+import Joi from 'joi';
+import type { ParsedQueryLine } from '../../query';
+import { executeFileQuery } from './files-query-executor';
+import type { NodeId } from '../../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import { FileRole } from '../../../project/context/flowr-file';
+import type { ReplOutput } from '../../../cli/repl/commands/repl-main';
+import type { FlowrConfigOptions } from '../../../config';
+import type { CommandCompletions } from '../../../cli/repl/core';
+/**
+ * Returns the content(s) of all files matching the given pattern.
+ */
+export interface FilesQuery extends BaseQueryFormat {
+    readonly type: 'files';
+    readonly roles?: FileRole[];
+    readonly matchesPathRegex?: string;
+}
+export interface FileQueryInfo<T = object> {
+    role?: FileRole;
+    path: string;
+    content: T;
+}
+export interface FilesQueryResult extends BaseQueryResult {
+    files: FileQueryInfo[];
+}
+declare function filesQueryLineParser(output: ReplOutput, line: readonly string[], _config: FlowrConfigOptions): ParsedQueryLine<'files'>;
+declare function filesQueryCompleter(line: readonly string[], startingNewArg: boolean, _config: FlowrConfigOptions): CommandCompletions;
+export declare const FilesQueryDefinition: {
+    readonly executor: typeof executeFileQuery;
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _analyzer: import("../../../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider<import("../../../r-bridge/parser").KnownParser>, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly completer: typeof filesQueryCompleter;
+    readonly fromLine: typeof filesQueryLineParser;
+    readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: (_: BaseQueryResult) => NodeId[];
+};
+export {};

package/queries/catalog/files-query/files-query-format.js

@@ -0,0 +1,114 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilesQueryDefinition = void 0;
+const ansi_1 = require("../../../util/text/ansi");
+const joi_1 = __importDefault(require("joi"));
+const files_query_executor_1 = require("./files-query-executor");
+const flowr_file_1 = require("../../../project/context/flowr-file");
+const json_1 = require("../../../util/json");
+const retriever_1 = require("../../../r-bridge/retriever");
+function summarizeObjectWithLimit(obj, limitChars = 500, limitLines = 10) {
+    const str = JSON.stringify(obj, json_1.jsonReplacer, 2);
+    if (str.split('\n').length > limitLines) {
+        const lines = str.split('\n').slice(0, limitLines);
+        return lines.join('\n') + '\n... (truncated)';
+    }
+    else if (str.length > limitChars) {
+        return str.slice(0, limitChars) + '... (truncated)';
+    }
+    else {
+        return str;
+    }
+}
+function rolesFromInput(rolesPart) {
+    return rolesPart
+        .reduce((acc, roleName) => {
+        roleName = roleName.trim();
+        // check if it is one of the values
+        if (Object.values(flowr_file_1.FileRole).includes(roleName)) {
+            acc.valid.push(roleName);
+        }
+        else {
+            acc.invalid.push(roleName);
+        }
+        return acc;
+    }, { valid: [], invalid: [] });
+}
+const rolePrefix = 'role:';
+function filesQueryLineParser(output, line, _config) {
+    let roles = undefined;
+    let input = undefined;
+    if (line.length > 0 && line[0].startsWith(rolePrefix)) {
+        const rolesPart = line[0].slice(rolePrefix.length).split(',');
+        const parseResult = rolesFromInput(rolesPart);
+        if (parseResult.invalid.length > 0) {
+            output.stderr(`Invalid roles: ${parseResult.invalid.map(r => (0, ansi_1.bold)(r, output.formatter)).join(', ')}`
+                + `\nValid roles are: ${Object.values(flowr_file_1.FileRole).map(r => (0, ansi_1.bold)(r, output.formatter)).join(', ')}`);
+        }
+        roles = parseResult.valid;
+        input = line[1];
+    }
+    else if (line.length > 0) {
+        input = line[0];
+    }
+    return { query: [{ type: 'files', roles }], rCode: input };
+}
+function filesQueryCompleter(line, startingNewArg, _config) {
+    const rolesPrefixNotPresent = line.length == 0 || (line.length == 1 && line[0].length < rolePrefix.length);
+    const rolesNotFinished = line.length == 1 && line[0].startsWith(rolePrefix) && !startingNewArg;
+    const endOfRoles = line.length == 1 && startingNewArg || line.length == 2;
+    if (rolesPrefixNotPresent) {
+        return { completions: [`${rolePrefix}`] };
+    }
+    else if (endOfRoles) {
+        return { completions: [retriever_1.fileProtocol] };
+    }
+    else if (rolesNotFinished) {
+        const rolesWithoutPrefix = line[0].slice(rolePrefix.length);
+        const usedRoles = rolesWithoutPrefix.split(',').map(r => r.trim());
+        const allRoles = Object.values(flowr_file_1.FileRole);
+        const unusedRoles = allRoles.filter(r => !usedRoles.includes(r));
+        const lastRole = usedRoles[usedRoles.length - 1];
+        const lastRoleIsUnfinished = !allRoles.includes(lastRole);
+        if (lastRoleIsUnfinished) {
+            return { completions: unusedRoles, argumentPart: lastRole };
+        }
+        else if (unusedRoles.length > 0) {
+            return { completions: [','], argumentPart: '' };
+        }
+        else {
+            return { completions: [' '], argumentPart: '' };
+        }
+    }
+    return { completions: [] };
+}
+exports.FilesQueryDefinition = {
+    executor: files_query_executor_1.executeFileQuery,
+    asciiSummarizer: (formatter, _analyzer, queryResults, result) => {
+        const out = queryResults;
+        result.push(`Query: ${(0, ansi_1.bold)('files', formatter)} (${out['.meta'].timing.toFixed(0)}ms)`);
+        result.push(`   ╰ Found ${out.files.length} file${out.files.length === 1 ? '' : 's'}`);
+        for (const f of out.files) {
+            result.push(`      ╰ ${(0, ansi_1.bold)(f.path, formatter)}${f.role ? ` [role: ${f.role}]` : ''}:`);
+            const summary = summarizeObjectWithLimit(f.content);
+            for (const line of summary.split('\n')) {
+                result.push(`          ${line}`);
+            }
+        }
+        return true;
+    },
+    completer: filesQueryCompleter,
+    fromLine: filesQueryLineParser,
+    schema: joi_1.default.object({
+        type: joi_1.default.string().valid('files').required().description('The type of the query.'),
+        roles: joi_1.default.array().optional().items(joi_1.default.string().valid(...Object.values(flowr_file_1.FileRole))).description('Optional roles of the files to query. If not provided, all roles are considered.'),
+        matchesPathRegex: joi_1.default.string().optional().description('An optional regular expression to match the file paths against.')
+    }).description('The file query finds files in the project based on their roles and path patterns.'),
+    flattenInvolvedNodes: (_) => {
+        return [];
+    }
+};
+//# sourceMappingURL=files-query-format.js.map

package/queries/catalog/linter-query/linter-query-format.js

@@ -34,7 +34,7 @@ function linterQueryLineParser(output, line, _config) {
         const rulesPart = line[0].slice(rulesPrefix.length).split(',');
         const parseResult = rulesFromInput(output, rulesPart);
         if (parseResult.invalid.length > 0) {
-            output.stdout(`Invalid linting rule name(s): ${parseResult.invalid.map(r => (0, ansi_1.bold)(r, output.formatter)).join(', ')}`
+            output.stderr(`Invalid linting rule name(s): ${parseResult.invalid.map(r => (0, ansi_1.bold)(r, output.formatter)).join(', ')}`
                 + `\nValid rule names are: ${Object.keys(linter_rules_1.LintingRules).map(r => (0, ansi_1.bold)(r, output.formatter)).join(', ')}`);
         }
         rules = parseResult.valid;

package/queries/query.d.ts

@@ -28,10 +28,11 @@ import { type InspectHigherOrderQuery } from './catalog/inspect-higher-order-que
 import type { ReadonlyFlowrAnalysisProvider } from '../project/flowr-analyzer';
 import type { ReplOutput } from '../cli/repl/commands/repl-main';
 import type { CommandCompletions } from '../cli/repl/core';
+import type { FilesQuery } from './catalog/files-query/files-query-format';
 /**
  * These are all queries that can be executed from within flowR
  */
-export type Query = CallContextQuery | ConfigQuery | SearchQuery | DataflowQuery | ControlFlowQuery | DataflowLensQuery | DfShapeQuery | NormalizedAstQuery | IdMapQuery | DataflowClusterQuery | StaticSliceQuery | DependenciesQuery | LocationMapQuery | HappensBeforeQuery | InspectHigherOrderQuery | ResolveValueQuery | ProjectQuery | OriginQuery | LinterQuery;
+export type Query = CallContextQuery | ConfigQuery | SearchQuery | DataflowQuery | ControlFlowQuery | DataflowLensQuery | FilesQuery | DfShapeQuery | NormalizedAstQuery | IdMapQuery | DataflowClusterQuery | StaticSliceQuery | DependenciesQuery | LocationMapQuery | HappensBeforeQuery | InspectHigherOrderQuery | ResolveValueQuery | ProjectQuery | OriginQuery | LinterQuery;
 export type QueryArgumentsWithType<QueryType extends BaseQueryFormat['type']> = Query & {
     type: QueryType;
 };
@@ -105,6 +106,14 @@ export declare const SupportedQueries: {
         readonly schema: Joi.ObjectSchema<any>;
         readonly flattenInvolvedNodes: () => never[];
     };
+    readonly files: {
+        readonly executor: typeof import("./catalog/files-query/files-query-executor").executeFileQuery;
+        readonly asciiSummarizer: (formatter: OutputFormatter, _analyzer: ReadonlyFlowrAnalysisProvider<import("../r-bridge/parser").KnownParser>, queryResults: BaseQueryResult, result: string[]) => true;
+        readonly completer: (line: readonly string[], startingNewArg: boolean, _config: FlowrConfigOptions) => CommandCompletions;
+        readonly fromLine: (output: ReplOutput, line: readonly string[], _config: FlowrConfigOptions) => ParsedQueryLine<"files">;
+        readonly schema: Joi.ObjectSchema<any>;
+        readonly flattenInvolvedNodes: (_: BaseQueryResult) => NodeId[];
+    };
     readonly 'id-map': {
         readonly executor: typeof import("./catalog/id-map-query/id-map-query-executor").executeIdMapQuery;
         readonly asciiSummarizer: (formatter: OutputFormatter, _analyzer: ReadonlyFlowrAnalysisProvider<import("../r-bridge/parser").KnownParser>, queryResults: BaseQueryResult, result: string[]) => true;

package/queries/query.js

@@ -35,6 +35,7 @@ const control_flow_query_format_1 = require("./catalog/control-flow-query/contro
 const df_shape_query_format_1 = require("./catalog/df-shape-query/df-shape-query-format");
 const inspect_higher_order_query_format_1 = require("./catalog/inspect-higher-order-query/inspect-higher-order-query-format");
 const log_1 = require("../util/log");
+const files_query_format_1 = require("./catalog/files-query/files-query-format");
 exports.SupportedQueries = {
     'call-context': call_context_query_format_1.CallContextQueryDefinition,
     'config': config_query_format_1.ConfigQueryDefinition,
@@ -42,6 +43,7 @@ exports.SupportedQueries = {
     'dataflow': dataflow_query_format_1.DataflowQueryDefinition,
     'dataflow-lens': dataflow_lens_query_format_1.DataflowLensQueryDefinition,
     'df-shape': df_shape_query_format_1.DfShapeQueryDefinition,
+    'files': files_query_format_1.FilesQueryDefinition,
     'id-map': id_map_query_format_1.IdMapQueryDefinition,
     'normalized-ast': normalized_ast_query_format_1.NormalizedAstQueryDefinition,
     'dataflow-cluster': cluster_query_format_1.ClusterQueryDefinition,
@@ -103,7 +105,7 @@ async function executeQueries(data, queries) {
     const results = [];
     for (const [type, group] of entries) {
         try {
-            const result = await Promise.resolve(executeQueriesOfSameType(data, group));
+            const result = await executeQueriesOfSameType(data, group);
             results.push([type, result]);
         }
         catch (e) {