@eagleoutice/flowr 2.7.0 → 2.7.2

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

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowrDescriptionFile = void 0;
+const flowr_file_1 = require("../../../context/flowr-file");
+/**
+ * This decorates a text file and provides access to its content as a DCF (Debian Control File)-like structure.
+ */
+class FlowrDescriptionFile extends flowr_file_1.FlowrFile {
+    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
+     * and handle role assignments.
+     */
+    constructor(file) {
+        super(file.path(), file.role);
+        this.wrapped = file;
+    }
+    /**
+     * Loads and parses the content of the wrapped file as a DCF structure.
+     * @see {@link parseDCF} for details on the parsing logic.
+     */
+    loadContent() {
+        return parseDCF(this.wrapped);
+    }
+    /**
+     * Description file lifter, this does not re-create if already a description file
+     */
+    static from(file, role) {
+        if (role) {
+            file.assignRole(role);
+        }
+        return file instanceof FlowrDescriptionFile ? file : new FlowrDescriptionFile(file);
+    }
+}
+exports.FlowrDescriptionFile = FlowrDescriptionFile;
+/**
+ * Parses the given file in the 'Debian Control Format'.
+ * @param file - The file to parse
+ */
+function parseDCF(file) {
+    const result = new Map();
+    let currentKey = '';
+    let currentValue = '';
+    const indentRegex = new RegExp(/^\s/);
+    const firstColonRegex = new RegExp(/:(.*)/s);
+    const fileContent = file.content().toString().split(/\r?\n/);
+    for (const line of fileContent) {
+        if (indentRegex.test(line)) {
+            currentValue += '\n' + line.trim();
+        }
+        else {
+            if (currentKey) {
+                const values = currentValue ? cleanValues(currentValue) : [];
+                result.set(currentKey, values);
+            }
+            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);
+    }
+    return result;
+}
+const cleanSplitRegex = /[\n,]+/;
+const cleanQuotesRegex = /'/g;
+function cleanValues(values) {
+    return values
+        .split(cleanSplitRegex)
+        .map(s => s.trim().replace(cleanQuotesRegex, ''))
+        .filter(s => s.length > 0);
+}
+//# sourceMappingURL=flowr-description-file.js.map

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

@@ -0,0 +1,27 @@
+import { type FlowrFileProvider, type FileRole, FlowrFile } from '../../../context/flowr-file';
+export interface NewsChunk {
+    header?: string;
+    version?: string;
+    date?: string;
+    entries: string[] | NewsChunk[];
+}
+/**
+ * This decorates a text file and provides access to its content following R's NEWS file structure.
+ */
+export declare class FlowrNewsFile extends FlowrFile<NewsChunk[]> {
+    private readonly wrapped;
+    /**
+     * Prefer the static {@link FlowrNewsFile.from} method to create instances of this class as it will not re-create if already a news file
+     * and handle role assignments.
+     */
+    constructor(file: FlowrFileProvider);
+    /**
+     * Loads and parses the content of the wrapped file as news chunks.
+     * @see {@link parseNews} for details on the parsing logic.
+     */
+    protected loadContent(): NewsChunk[];
+    /**
+     * News file lifter, this does not re-create if already a news file
+     */
+    static from(file: FlowrFileProvider | FlowrNewsFile, role?: FileRole): FlowrNewsFile;
+}

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

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowrNewsFile = void 0;
+const flowr_file_1 = require("../../../context/flowr-file");
+const r_regex_1 = require("../../../../util/r-regex");
+const objects_1 = require("../../../../util/objects");
+/**
+ * This decorates a text file and provides access to its content following R's NEWS file structure.
+ */
+class FlowrNewsFile extends flowr_file_1.FlowrFile {
+    wrapped;
+    /**
+     * Prefer the static {@link FlowrNewsFile.from} method to create instances of this class as it will not re-create if already a news file
+     * and handle role assignments.
+     */
+    constructor(file) {
+        super(file.path(), file.role);
+        this.wrapped = file;
+    }
+    /**
+     * Loads and parses the content of the wrapped file as news chunks.
+     * @see {@link parseNews} for details on the parsing logic.
+     */
+    loadContent() {
+        return parseNews(this.wrapped);
+    }
+    /**
+     * News file lifter, this does not re-create if already a news file
+     */
+    static from(file, role) {
+        if (role) {
+            file.assignRole(role);
+        }
+        return file instanceof FlowrNewsFile ? file : new FlowrNewsFile(file);
+    }
+}
+exports.FlowrNewsFile = FlowrNewsFile;
+function makeRversionRegex() {
+    // ^([[:space:]]*(%s)|(%s))(%s).*$
+    const fst = 'CHANGES? *(IN|FOR).*VERSION *|CHANGES? *(IN|FOR|TO) *';
+    const pVersion = r_regex_1.RStandardRegexp.ValidPackageVersion.source;
+    const pName = r_regex_1.RStandardRegexp.ValidPackageName.source;
+    const teachingDemos = [
+        // TeachingDemos pomp ouch
+        'NEW IN .*',
+        // HyperbolicDist nls2 proto
+        'VERSION:? *',
+        `${pName} +`,
+        // E.g., lattice:
+        //   Changes in lattice 0.17
+        `CHANGES IN ${pName} +`,
+        // sv*
+        `== Changes in ${pName} +`,
+        // tcltk2
+        '== Version +',
+        // R2WinBUGS
+        'update *',
+        'v *',
+        '',
+    ].join('|');
+    const weAreNicerFlags = 'i';
+    const pkgVersionLine = `\\s*(${pName})\\s+version\\s+(${pVersion})\\s*|\\s*#+\\s*${pName} (\\([^)]*\\)|${pVersion}).*`;
+    return new RegExp(`^(\\s*(${fst})|(${teachingDemos}))((${pVersion}).*)|${pkgVersionLine}$`, weAreNicerFlags);
+}
+//"^.*([[:digit:]]{4}-[[:digit:]]{2}-[[:digit:]]{2})[[:punct:][:space:]]*$",
+const RDateRegex = new RegExp(`^.*(\\d{4}-\\d{2}-\\d{2})[${r_regex_1.RPunctuationChars}\\s]*$`);
+// ^[[:space:]]*([o*+-])
+const RBulletPointRegex = /^\s*(?<bullet>[o*+-])/;
+// ^([[:alpha:]].*)[[:space:]]*$"
+const RCategoryRegex = /^((#+\s*)?([A-Za-z].*))\s*$/;
+const AnyVersionRegex = new RegExp(r_regex_1.RStandardRegexp.ValidPackageVersion.source + '|dev(e(l(opment)?)?)? (ver(sion)?)?|(?<=\\()[^)]*(?=\\))', 'i');
+function splitLinesRegex(relevantLines, regex) {
+    const lineChunks = [];
+    let currentChunk = [];
+    for (const line of relevantLines) {
+        if (regex.test(line)) {
+            if (currentChunk.length > 0) {
+                lineChunks.push(currentChunk);
+            }
+            currentChunk = [line];
+        }
+        else {
+            currentChunk.push(line);
+        }
+    }
+    if (currentChunk.length > 0) {
+        lineChunks.push(currentChunk);
+    }
+    return lineChunks;
+}
+/**
+ * Parses the given file into news chunks.
+ * @param file - The file to parse
+ * @see https://github.com/r-devel/r-svn/blob/44474af03ae77fd3b9a340279fa10cb698d106c3/src/library/tools/R/news.R#L91-L92
+ */
+function parseNews(file) {
+    // ^[[:space:]]*[[:punct:]]*[[:space:]]*
+    const noiseRegex = new RegExp(`^\\s*[${r_regex_1.RPunctuationChars}]*\\s*$`);
+    const lines = file.content().toString().split(/\r?\n/)
+        // first we clean underlines and friends (according to the R impl)
+        .filter(l => !noiseRegex.test(l));
+    // this is a port of the incredible complex R NEWS regex, but luckily it is  not too liberal :D
+    const regexVersion = makeRversionRegex();
+    // filter lines that match the version regex
+    const versionLines = lines.map(line => regexVersion.test(line));
+    // drop the header by removing everything before the first match
+    const firstVersionIndex = versionLines.findIndex(v => v);
+    const relevantLines = lines.slice(firstVersionIndex);
+    // split at every version line
+    const lineChunks = splitLinesRegex(relevantLines, regexVersion);
+    /**
+     * @see https://github.com/r-devel/r-svn/blob/44474af03ae77fd3b9a340279fa10cb698d106c3/src/library/tools/R/news.R#L183
+     */
+    function processChunk(lines, header) {
+        let date;
+        let head;
+        if (header) {
+            head = AnyVersionRegex.exec(header)?.[0];
+            date = RDateRegex.exec(header)?.[1];
+        }
+        const content = lines.join('\n').trim();
+        const hasBullets = RBulletPointRegex.exec(content);
+        if (hasBullets) {
+            const separator = hasBullets.groups?.bullet ?? '-';
+            const lineChunks = splitLinesRegex(lines, new RegExp(`^\\s*[${separator}]\\s+`)).map(
+            // apparently we have to trim leading '\tab' indentations
+            chunkLines => chunkLines.map(l => {
+                return l.replace(new RegExp(`^\\s*[${separator}]\\s+`), '').replace(/^\t?/gm, '').trim();
+            }).join('\n'));
+            return (0, objects_1.compactRecord)({
+                header,
+                version: head,
+                date,
+                entries: lineChunks
+            });
+        }
+        else {
+            // from the spec: "Categories should be non-empty starting in column 1."
+            const categoryChunks = splitLinesRegex(lines, RCategoryRegex);
+            // different to R we may accept no category blobs here
+            return (0, objects_1.compactRecord)({
+                header,
+                version: head,
+                date,
+                entries: categoryChunks.length > 1 ?
+                    categoryChunks.map(chunkLines => processChunk(chunkLines, header = RCategoryRegex.exec(chunkLines[0])?.[1])) : [content]
+            });
+        }
+    }
+    return lineChunks.map(l => processChunk(l.slice(1), l[0]));
+}
+//# sourceMappingURL=flowr-news-file.js.map

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

@@ -2,7 +2,7 @@ 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 { FlowrDescriptionFile } from './flowr-description-file';
+import { FlowrDescriptionFile } from './files/flowr-description-file';
 import { type FlowrFileProvider } from '../../context/flowr-file';
 export declare const descriptionFileLog: import("tslog").Logger<import("tslog").ILogObj>;
 /**

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

@@ -4,7 +4,7 @@ exports.FlowrAnalyzerDescriptionFilePlugin = exports.descriptionFileLog = void 0
 const flowr_analyzer_file_plugin_1 = require("./flowr-analyzer-file-plugin");
 const semver_1 = require("semver");
 const log_1 = require("../../../util/log");
-const flowr_description_file_1 = require("./flowr-description-file");
+const flowr_description_file_1 = require("./files/flowr-description-file");
 const flowr_file_1 = require("../../context/flowr-file");
 const built_in_source_1 = require("../../../dataflow/internal/process/functions/call/built-in/built-in-source");
 exports.descriptionFileLog = log_1.log.getSubLogger({ name: 'flowr-analyzer-loading-order-description-file-plugin' });

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

@@ -0,0 +1,23 @@
+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';
+import { FlowrNewsFile } from './files/flowr-news-file';
+/**
+ * This plugin provides support for R `NEWS` files.
+ * @see https://rdrr.io/r/utils/news.html
+ */
+export declare class FlowrAnalyzerNewsFilePlugin extends FlowrAnalyzerFilePlugin {
+    readonly name = "flowr-analyzer-news-file-plugin";
+    readonly description = "This plugin provides support for NEWS files and extracts their content into version chunks.";
+    readonly version: SemVer;
+    private readonly pattern;
+    /**
+     * Creates a new instance of the NEWS file plugin.
+     * @param filePattern - The pattern to identify NEWS files, see {@link NewsFilePattern} for the default pattern.
+     */
+    constructor(filePattern?: RegExp);
+    applies(file: PathLike): boolean;
+    process(_ctx: FlowrAnalyzerContext, file: FlowrFileProvider): FlowrNewsFile;
+}

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

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowrAnalyzerNewsFilePlugin = 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 flowr_news_file_1 = require("./files/flowr-news-file");
+const NewsFilePattern = /^NEWS(\.(rd|md))?$/i;
+/**
+ * This plugin provides support for R `NEWS` files.
+ * @see https://rdrr.io/r/utils/news.html
+ */
+class FlowrAnalyzerNewsFilePlugin extends flowr_analyzer_file_plugin_1.FlowrAnalyzerFilePlugin {
+    name = 'flowr-analyzer-news-file-plugin';
+    description = 'This plugin provides support for NEWS files and extracts their content into version chunks.';
+    version = new semver_1.SemVer('0.1.0');
+    pattern;
+    /**
+     * Creates a new instance of the NEWS file plugin.
+     * @param filePattern - The pattern to identify NEWS files, see {@link NewsFilePattern} for the default pattern.
+     */
+    constructor(filePattern = NewsFilePattern) {
+        super();
+        this.pattern = filePattern;
+    }
+    applies(file) {
+        return this.pattern.test((0, built_in_source_1.platformBasename)(file.toString()));
+    }
+    process(_ctx, file) {
+        return flowr_news_file_1.FlowrNewsFile.from(file, flowr_file_1.FileRole.News);
+    }
+}
+exports.FlowrAnalyzerNewsFilePlugin = FlowrAnalyzerNewsFilePlugin;
+//# sourceMappingURL=flowr-analyzer-news-file-plugin.js.map

package/project/plugins/file-plugins/notebooks/flowr-analyzer-jupyter-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 { FlowrJupyterFile } from './flowr-jupyter-file';
+import { FlowrJupyterFile } from '../files/flowr-jupyter-file';
 /**
  * The plugin provides support for Jupyter (`.ipynb`) files
  */

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,7 @@ 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_news_file_plugin_1 = require("./file-plugins/flowr-analyzer-news-file-plugin");
 /**
  * Provides the default set of Flowr Analyzer plugins.
  */
@@ -18,6 +19,7 @@ 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_news_file_plugin_1.FlowrAnalyzerNewsFilePlugin()
     ];
 }
 //# sourceMappingURL=flowr-analyzer-plugin-defaults.js.map

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

@@ -5,10 +5,11 @@ 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 { 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: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,7 @@ 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_news_file_plugin_1 = require("./file-plugins/flowr-analyzer-news-file-plugin");
 /**
  * The built-in Flowr Analyzer plugins that are always available.
  */
@@ -21,6 +22,7 @@ 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: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/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 {};