@eagleoutice/flowr 2.6.1 → 2.6.3

package/documentation/{print-query-wiki.js → wiki-query.js}

@@ -1,11 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const shell_1 = require("../r-bridge/shell");
+exports.WikiQuery = void 0;
 const doc_dfg_1 = require("./doc-util/doc-dfg");
-const log_1 = require("../../test/functionality/_helper/log");
 const query_1 = require("../queries/query");
 const doc_files_1 = require("./doc-util/doc-files");
 const doc_query_1 = require("./doc-util/doc-query");
@@ -13,7 +9,6 @@ const schema_1 = require("../util/schema");
 const ansi_1 = require("../util/text/ansi");
 const call_context_query_executor_1 = require("../queries/catalog/call-context-query/call-context-query-executor");
 const compound_query_1 = require("../queries/virtual-query/compound-query");
-const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
 const example_query_code_1 = require("./data/query/example-query-code");
 const doc_structure_1 = require("./doc-util/doc-structure");
 const doc_code_1 = require("./doc-util/doc-code");
@@ -22,7 +17,6 @@ const id_map_query_executor_1 = require("../queries/catalog/id-map-query/id-map-
 const normalized_ast_query_executor_1 = require("../queries/catalog/normalized-ast-query/normalized-ast-query-executor");
 const cluster_query_executor_1 = require("../queries/catalog/cluster-query/cluster-query-executor");
 const static_slice_query_executor_1 = require("../queries/catalog/static-slice-query/static-slice-query-executor");
-const lineage_query_executor_1 = require("../queries/catalog/lineage-query/lineage-query-executor");
 const dependencies_query_executor_1 = require("../queries/catalog/dependencies-query/dependencies-query-executor");
 const doc_cli_option_1 = require("./doc-util/doc-cli-option");
 const doc_issue_1 = require("./doc-util/doc-issue");
@@ -32,14 +26,14 @@ const config_query_executor_1 = require("../queries/catalog/config-query/config-
 const search_query_executor_1 = require("../queries/catalog/search-query/search-query-executor");
 const flowr_search_builder_1 = require("../search/flowr-search-builder");
 const vertex_1 = require("../dataflow/graph/vertex");
-const doc_types_1 = require("./doc-util/doc-types");
-const path_1 = __importDefault(require("path"));
 const control_flow_query_executor_1 = require("../queries/catalog/control-flow-query/control-flow-query-executor");
 const doc_cfg_1 = require("./doc-util/doc-cfg");
 const df_shape_query_executor_1 = require("../queries/catalog/df-shape-query/df-shape-query-executor");
 const _00_slice_1 = require("../core/steps/all/static-slicing/00-slice");
 const doc_repl_1 = require("./doc-util/doc-repl");
 const inspect_higher_order_query_executor_1 = require("../queries/catalog/inspect-higher-order-query/inspect-higher-order-query-executor");
+const doc_escape_1 = require("./doc-util/doc-escape");
+const doc_maker_1 = require("./wiki-mk/doc-maker");
 (0, doc_query_1.registerQueryDocumentation)('call-context', {
     name: 'Call-Context Query',
     type: 'active',
@@ -166,37 +160,6 @@ ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
 		`;
     }
 });
-(0, doc_query_1.registerQueryDocumentation)('lineage', {
-    name: 'Lineage Query',
-    type: 'active',
-    shortDescription: 'Returns lineage of a criteria.',
-    functionName: lineage_query_executor_1.executeLineageQuery.name,
-    functionFile: '../queries/catalog/lineage-query/lineage-query-executor.ts',
-    buildExplanation: async (shell) => {
-        const exampleCode = 'x <- 1\nx';
-        return `
-This query calculates the _lineage_ of a given slicing criterion. The lineage traces back all parts that the
-respective variables stems from given the reads, definitions, and returns in the dataflow graph.
-
-To understand this, let's start with a simple example query, to get the lineage of the second use of \`x\` in the following code:
-${(0, doc_code_1.codeBlock)('r', exampleCode)}
- 
-For this, we use the criterion \`2@x\` (which is the first use of \`x\` in the second line).
- 
-${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
-                type: 'lineage',
-                criterion: '2@x'
-            }], { showCode: false })}
-
-In this simple scenario, the _lineage_ is equivalent to the slice (and in-fact the complete code). 
-In general the lineage is smaller and makes no guarantees on executability. 
-It is just a quick and neither complete nor sound way to get information on where the variable originates from.
-
-This query replaces the old [\`request-lineage\`](${doc_files_1.FlowrWikiBaseRef}/Interface#message-request-lineage) message.
-
-		`;
-    }
-});
 (0, doc_query_1.registerQueryDocumentation)('dataflow-cluster', {
     name: 'Dataflow Cluster Query',
     type: 'active',
@@ -231,16 +194,17 @@ ${await (0, doc_query_1.showQuery)(shell, example_query_code_1.exampleQueryCode,
     functionName: search_query_executor_1.executeSearch.name,
     functionFile: '../queries/catalog/resolve-value-query/resolve-value-query-executor.ts',
     buildExplanation: async (shell) => {
-        const exampleCode = 'x <- 1\nprint(x)';
+        const exampleCode = 'x <- 1\ny <-2\nprint(x)\nprint(y)';
+        const criteria = ['3@x', '4@y'];
         return `
 With this query you can use flowR's value-tracking capabilities to resolve identifiers to all potential values they may have at runtime (if possible).
 The extent to which flowR traces values (e.g., built-ins vs. constants) can be configured in flowR's Configuration file (see the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more information).
 
-Using the example code \`${exampleCode}\` (with the \`print(x)\` in the second line), the following query returns all values of \`x\` in the code:
+Using the example code \`${exampleCode}\` (with newlines), the following query returns all values of \`x\` in the code:
 ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 type: 'resolve-value',
-                criteria: ['2@x']
-            }], { showCode: true })}
+                criteria: criteria
+            }], { showCode: true, shorthand: (0, doc_query_1.sliceQueryShorthand)(criteria, (0, doc_escape_1.escapeNewline)(exampleCode)) })}
 		`;
     }
 });
@@ -271,6 +235,7 @@ ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
     functionFile: '../queries/catalog/origin-query/origin-query-executor.ts',
     buildExplanation: async (shell) => {
         const exampleCode = 'x <- 1\nprint(x)';
+        const criterion = '2@x';
         return `
 With this query you can use flowR's origin tracking to find out the read origins of a variable,
 the functions called by a call, and more.
@@ -278,8 +243,8 @@ the functions called by a call, and more.
 Using the example code \`${exampleCode}\` (with the \`print(x)\` in the second line), the following query returns the origins of \`x\` in the code:
 ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 type: 'origin',
-                criterion: '2@x'
-            }], { showCode: true })}
+                criterion: criterion
+            }], { showCode: true, shorthand: (0, doc_query_1.sliceQueryShorthand)([criterion], (0, doc_escape_1.escapeNewline)(exampleCode)) })}
 		`;
     }
 });
@@ -361,7 +326,7 @@ ${await (0, doc_query_1.showQuery)(shell, '', [{
                 }
             }], { showCode: false, collapseQuery: true, collapseResult: true })}
 
-Please note that, in the repl, a special syntax starting with \`+\` (which should be autocompleted) can be used to update the configuration on the fly:
+Please note that, in the REPL, a special syntax starting with \`+\` (which should be autocompleted) can be used to update the configuration on the fly:
 
 ${await (0, doc_repl_1.documentReplSession)(shell, [
             {
@@ -380,11 +345,18 @@ ${await (0, doc_repl_1.documentReplSession)(shell, [
     functionFile: '../queries/catalog/df-shape-query/df-shape-query-format.ts',
     buildExplanation: async (shell) => {
         const exampleCode = 'x <- data.frame(a=1:3)\nfilter(x, FALSE)';
+        const criterion = '2@x';
         return `
 This query infers all shapes of dataframes within the code. For example, you can use:
 ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 type: 'df-shape'
             }], { showCode: true, collapseQuery: true })}
+
+The query also accepts an optional slice criterion to narrow the results to a specific node. For example:
+${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
+                type: 'df-shape',
+                criterion: criterion
+            }], { showCode: true, collapseQuery: true, shorthand: (0, doc_query_1.sliceQueryShorthand)([criterion], (0, doc_escape_1.escapeNewline)(exampleCode)) })}
 `;
     }
 });
@@ -449,7 +421,8 @@ Now, the results no longer contain calls to \`plot\` that are not defined locall
     functionName: static_slice_query_executor_1.executeStaticSliceQuery.name,
     functionFile: '../queries/catalog/static-slice-query/static-slice-query-executor.ts',
     buildExplanation: async (shell) => {
-        const exampleCode = 'x <- 1\ny <- 2\nx';
+        const exampleCode = 'x <- 1\ny <- 2\nz <- 3\nx';
+        const criteria = ['3@z', '4@x'];
         return `
 To slice, _flowR_ needs one thing from you: a variable or a list of variables (function calls are supported to, referring to the anonymous
 return of the call) that you want to slice the dataflow graph for (additionally, you have to tell flowR if you want to have a forward slice). 
@@ -462,15 +435,15 @@ If you are interested in the parts required for the use of \`x\` in the last lin
 
 ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 type: 'static-slice',
-                criteria: ['3@x']
-            }], { showCode: false })}
+                criteria: criteria
+            }], { showCode: false, shorthand: (0, doc_query_1.sliceQueryShorthand)(criteria, (0, doc_escape_1.escapeNewline)(exampleCode)) })}
 
 In general, you may be uninterested in seeing the reconstructed version and want to save some computation time, for this,
 you can use the \`noReconstruction\` flag.
 
 ${(0, doc_structure_1.details)('No Reconstruction Example', await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 type: 'static-slice',
-                criteria: ['3@x'],
+                criteria: ['4@x'],
                 noReconstruction: true
             }], { showCode: false }))}
 
@@ -480,7 +453,7 @@ ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 type: 'static-slice',
                 criteria: ['1@x'],
                 direction: _00_slice_1.SliceDirection.Forward
-            }], { showCode: false })}
+            }], { showCode: false, shorthand: (0, doc_query_1.sliceQueryShorthand)(['1@x'], (0, doc_escape_1.escapeNewline)(exampleCode), true) })}
 
 You can disable [magic comments](${doc_files_1.FlowrWikiBaseRef}/Interface#slice-magic-comments) using the \`noMagicComments\` flag.
 This query replaces the old [\`request-slice\`](${doc_files_1.FlowrWikiBaseRef}/Interface#message-request-slice) message.
@@ -556,7 +529,16 @@ ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 type: 'linter'
             }], { showCode: false, collapseQuery: true })}
 
-You can also configure which rules to apply and what settings to use for these rules. 
+You can also configure which rules to apply and what settings to use for these rules:
+${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
+                type: 'linter',
+                rules: ['file-path-validity'],
+            }], {
+            showCode: false,
+            collapseQuery: true,
+            shorthand: `rules:file-path-validity "${exampleCode}"`
+        })}
+
 We welcome any feedback and suggestions for new rules on this (consider opening a [new issue](${doc_issue_1.NewIssueUrl})).
 		`;
     }
@@ -624,11 +606,9 @@ ${await (0, doc_cfg_1.printCfgCode)(shell, exampleCode, { showCode: false, prefi
     shortDescription: 'Returns a simple mapping of ids to their location in the source file',
     functionName: location_map_query_executor_1.executeLocationMapQuery.name,
     functionFile: '../queries/catalog/location-map-query/location-map-query-executor.ts',
-    buildExplanation: async (shell) => {
-        const types = (0, doc_types_1.getTypesFromFolder)({
-            files: [path_1.default.resolve('./src/util/range.ts')],
-        });
+    buildExplanation: async (shell, ctx) => {
         const exampleCode = 'x + 1\nx * 2';
+        const criteria = ['1@x', '2@x'];
         return `
 A query like the ${(0, doc_query_1.linkToQueryOfName)('id-map')} query can return a huge result, especially for larger scripts.
 If you are not interested in all of the information contained within the full map, you can use the location map query to get a simple mapping of ids to their location in the source file.   
@@ -643,26 +623,40 @@ ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 type: 'location-map'
             }], { showCode: false, collapseQuery: true })}
 
-All locations are given as a ${(0, doc_types_1.shortLink)('SourceRange', types.info)} paired with the file id in the format \`[file-id, [start-line, start-column, end-line, end-column]]\`.	
+The query also accepts a list of slice criteria to filter the results to only include the locations of specific nodes. For example:
+
+${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
+                type: 'location-map',
+                ids: criteria
+            }], { showCode: false, collapseQuery: true, shorthand: (0, doc_query_1.sliceQueryShorthand)(criteria, (0, doc_escape_1.escapeNewline)(exampleCode)) })}
+
+All locations are given as a ${ctx.link('SourceRange')} paired with the file id in the format \`[file-id, [start-line, start-column, end-line, end-column]]\`.
 
 		`;
     }
 });
-async function getText(shell) {
-    const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';
-    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'query API', rVersion: rversion })}
-
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Query-API
+ */
+class WikiQuery extends doc_maker_1.DocMaker {
+    constructor() {
+        super('wiki/Query API.md', module.filename, 'query API');
+    }
+    async text({ ctx, shell }) {
+        return `
 This page briefly summarizes flowR's query API, represented by the ${query_1.executeQueries.name} function in ${(0, doc_files_1.getFilePathMd)('../queries/query.ts')}.
 Please see the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more information on how to access this API.
 
 ${(0, doc_structure_1.block)({
-        type: 'NOTE',
-        content: `
+            type: 'NOTE',
+            content: `
 There are many ways to query a dataflow graph created by flowR.
 For example, you can use the [\`request-query\`](${doc_files_1.FlowrWikiBaseRef}/Interface#message-request-query) message
-with a running flowR server, or the ${(0, doc_cli_option_1.getReplCommand)('query')} command in the flowR [REPL](${doc_files_1.FlowrWikiBaseRef}/Interface#repl).	
+with a running flowR server, or the ${(0, doc_cli_option_1.getReplCommand)('query')} command in the flowR [REPL](${doc_files_1.FlowrWikiBaseRef}/Interface#repl).
+
+Also, check out the [${doc_files_1.FlowrGithubGroupName}/sample-analyzer-project-query](${doc_files_1.FlowrGithubBaseRef}/sample-analyzer-project-query) repository for a complete example project using the query API.
 			`.trim()
-    })}
+        })}
 
 ## The Query Format
 
@@ -723,20 +717,11 @@ Just as an example, the following ${(0, doc_query_1.linkToQueryOfName)('call-con
 
 ${await (0, doc_query_1.showQuery)(shell, example_query_code_1.exampleQueryCode, [{ type: 'call-context', callName: '^read_csv$', callTargets: identify_link_to_last_call_relation_1.CallTargets.OnlyGlobal, kind: 'input', subkind: 'csv-file' }], { showCode: false })}
 
-${await (0, doc_query_1.explainQueries)(shell, 'active')}
-
-${await (0, doc_query_1.explainQueries)(shell, 'virtual')}
+${await (0, doc_query_1.explainQueries)(shell, ctx, 'active')}
 
+${await (0, doc_query_1.explainQueries)(shell, ctx, 'virtual')}
 `;
+    }
 }
-/** if we run this script, we want a Markdown representation of the capabilities */
-if (require.main === module) {
-    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
-    const shell = new shell_1.RShell();
-    void getText(shell).then(str => {
-        console.log(str);
-    }).finally(() => {
-        shell.close();
-    });
-}
-//# sourceMappingURL=print-query-wiki.js.map
+exports.WikiQuery = WikiQuery;
+//# sourceMappingURL=wiki-query.js.map

package/documentation/wiki-search.d.ts

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

package/documentation/wiki-search.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WikiSearch = void 0;
+const doc_files_1 = require("./doc-util/doc-files");
+const doc_search_1 = require("./doc-util/doc-search");
+const flowr_search_builder_1 = require("../search/flowr-search-builder");
+const vertex_1 = require("../dataflow/graph/vertex");
+const flowr_search_executor_1 = require("../search/flowr-search-executor");
+const doc_maker_1 = require("./wiki-mk/doc-maker");
+const flowr_search_1 = require("../search/flowr-search");
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Search-API
+ */
+class WikiSearch extends doc_maker_1.DocMaker {
+    constructor() {
+        super('wiki/Search API.md', module.filename, 'search API');
+    }
+    async text({ ctx, shell }) {
+        return `
+This page briefly summarizes flowR's search API which provides a set of functions to search for nodes in the [Dataflow Graph](${doc_files_1.FlowrWikiBaseRef}/Dataflow-Graph) and the 
+[Normalized AST](${doc_files_1.FlowrWikiBaseRef}/Normalized-AST) of a given R code (the search will always consider both, with respect to your search query).
+Please see the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more information on how to access this API.
+Within code, you can execute a search using the ${ctx.link(flowr_search_executor_1.runSearch)} function.
+
+For an initial motivation, let's have a look at the following example:
+
+${await (0, doc_search_1.showSearch)(shell, 'x <- x * x', flowr_search_builder_1.Q.var('x'))}
+
+This returns all references to the variable \`x\` in the code.
+However, the search API is not limited to simple variable references and can do much more.
+
+For example, let's have every definition of \`x\` in the code but the first one:
+
+${await (0, doc_search_1.showSearch)(shell, 'x <- x * x\nprint(x)\nx <- y <- 3\nprint(x)\nx <- 2', flowr_search_builder_1.Q.var('x').filter(vertex_1.VertexType.VariableDefinition).skip(1))}
+
+In summary, every search has two parts. It is initialized with a _generator_ (such as \`Q.var('x')\`)
+and can be further refined with _transformers_ or _modifiers_.
+Such queries can be constructed starting from the ${ctx.link('Q')} object (backed by ${ctx.link('FlowrSearchGenerator')}) and
+are fully serializable so you can use them when communicating with the [Query API](${doc_files_1.FlowrWikiBaseRef}/Query%20API).
+
+We offer the following generators:
+
+${Object.keys(flowr_search_builder_1.Q).sort().map(key => `- ${ctx.link(`FlowrSearchGenerator::${key}`)}\\\n${ctx.doc(`FlowrSearchGenerator::${key}`)}`).join('\n')}
+
+Likewise, we have a palette of _transformers_ and _modifiers_:
+
+${
+        /* let's iterate over all methods of FlowrSearchBuilder */
+        Object.getOwnPropertyNames(Object.getPrototypeOf(new flowr_search_builder_1.FlowrSearchBuilder(undefined)))
+            .filter(n => n !== 'constructor').sort().map(key => `- ${ctx.link(`FlowrSearchBuilder::${key}`)}\\\n${ctx.doc(`FlowrSearchBuilder::${key}`)}`).join('\n')}
+
+Every search (and consequently the search pipeline) works with an array of ${ctx.link('FlowrSearchElement')} (neatly wrapped in ${ctx.link(flowr_search_1.FlowrSearchElements)}).
+Hence, even operations such as \`.first\` or \`.last\` return an array of elements (albeit with a single or no element).
+The search API does its best to stay typesafe wrt. to the return type and the transformers in use. 
+In addition, it offers optimizer passes to optimize the search pipeline before execution.
+They are executed with \`.build\` which may happen automatically, whenever you want to run a search using ${ctx.link(flowr_search_executor_1.runSearch)}.
+`;
+    }
+}
+exports.WikiSearch = WikiSearch;
+//# sourceMappingURL=wiki-search.js.map

package/engines.d.ts

@@ -1,4 +1,4 @@
-import type { FlowrConfigOptions, KnownEngines } from './config';
+import { type FlowrConfigOptions, type KnownEngines } from './config';
 /**
  * Retrieve all requested engine instance.
  * Please make sure that if this includes the R engine, that you properly shut it down again!

package/linter/linter-executor.d.ts

@@ -1,5 +1,8 @@
-import type { LintingRuleConfig, LintingRuleNames } from './linter-rules';
+import { type LintingRuleConfig, type LintingRuleNames } from './linter-rules';
 import type { LintingResults } from './linter-format';
 import type { DeepPartial } from 'ts-essentials';
-import type { FlowrAnalysisProvider } from '../project/flowr-analyzer';
-export declare function executeLintingRule<Name extends LintingRuleNames>(ruleName: Name, input: FlowrAnalysisProvider, lintingRuleConfig?: DeepPartial<LintingRuleConfig<Name>>): Promise<LintingResults<Name>>;
+import type { ReadonlyFlowrAnalysisProvider } from '../project/flowr-analyzer';
+/**
+ * Executes a specific linting rule on the given analysis provider input.
+ */
+export declare function executeLintingRule<Name extends LintingRuleNames>(ruleName: Name, input: ReadonlyFlowrAnalysisProvider, lintingRuleConfig?: DeepPartial<LintingRuleConfig<Name>>): Promise<LintingResults<Name>>;

package/linter/linter-executor.js

@@ -4,6 +4,9 @@ exports.executeLintingRule = executeLintingRule;
 const linter_rules_1 = require("./linter-rules");
 const flowr_search_executor_1 = require("../search/flowr-search-executor");
 const objects_1 = require("../util/objects");
+/**
+ * Executes a specific linting rule on the given analysis provider input.
+ */
 async function executeLintingRule(ruleName, input, lintingRuleConfig) {
     try {
         const rule = linter_rules_1.LintingRules[ruleName];
@@ -14,10 +17,11 @@ async function executeLintingRule(ruleName, input, lintingRuleConfig) {
         const searchTime = Date.now() - searchStart;
         const processStart = Date.now();
         const result = await rule.processSearchResult(searchResult, fullConfig, {
-            normalize: await input.normalize(),
+            /* we currently await them here for simplicity (no redundant awaits in the linting rules), but they could be passed as promises too */
             dataflow: await input.dataflow(),
+            normalize: await input.normalize(),
             cfg: await input.controlflow(),
-            config: input.flowrConfig,
+            analyzer: input
         });
         const processTime = Date.now() - processStart;
         return {

package/linter/linter-format.d.ts

@@ -9,8 +9,8 @@ import type { AsyncOrSync, DeepPartial, DeepReadonly } from 'ts-essentials';
 import type { LintingRuleTag } from './linter-tags';
 import type { SourceRange } from '../util/range';
 import type { DataflowInformation } from '../dataflow/info';
-import type { FlowrConfigOptions } from '../config';
 import type { ControlFlowInformation } from '../control-flow/control-flow-graph';
+import type { ReadonlyFlowrAnalysisProvider } from '../project/flowr-analyzer';
 export interface LinterRuleInformation<Config extends MergeableRecord = never> {
     /** Human-Readable name of the linting rule. */
     readonly name: string;
@@ -51,7 +51,7 @@ export interface LintingRule<Result extends LintingResult, Metadata extends Merg
         normalize: NormalizedAst;
         dataflow: DataflowInformation;
         cfg: ControlFlowInformation;
-        config: FlowrConfigOptions;
+        analyzer: ReadonlyFlowrAnalysisProvider;
     }) => AsyncOrSync<{
         results: Result[];
         '.meta': Metadata;
@@ -117,7 +117,15 @@ export interface LintingResultsSuccess<Name extends LintingRuleNames> {
         readonly processTimeMs: number;
     };
 }
+/**
+ * Checks whether the given linting results represent an error.
+ * @see {@link isLintingResultsSuccess}
+ */
 export declare function isLintingResultsError<Name extends LintingRuleNames>(o: LintingResults<Name>): o is LintingResultsError;
+/**
+ * Checks whether the given linting results represent a successful linting result.
+ * @see {@link isLintingResultsError}
+ */
 export declare function isLintingResultsSuccess<Name extends LintingRuleNames>(o: LintingResults<Name>): o is LintingResultsSuccess<Name>;
 export type LintingResults<Name extends LintingRuleNames> = LintingResultsSuccess<Name> | LintingResultsError;
 export declare enum LintingResultCertainty {

package/linter/linter-format.js

@@ -3,9 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LintingPrettyPrintContext = exports.LintingRuleCertainty = exports.LintingResultCertainty = void 0;
 exports.isLintingResultsError = isLintingResultsError;
 exports.isLintingResultsSuccess = isLintingResultsSuccess;
+/**
+ * Checks whether the given linting results represent an error.
+ * @see {@link isLintingResultsSuccess}
+ */
 function isLintingResultsError(o) {
     return 'error' in o;
 }
+/**
+ * Checks whether the given linting results represent a successful linting result.
+ * @see {@link isLintingResultsError}
+ */
 function isLintingResultsSuccess(o) {
     return 'results' in o;
 }

package/linter/linter-rules.d.ts

@@ -6,11 +6,7 @@ import type { LintingRule } from './linter-format';
 export declare const LintingRules: {
     readonly 'deprecated-functions': {
         readonly createSearch: (config: import("./rules/function-finder-util").FunctionsToDetectConfig) => import("../search/flowr-search-builder").FlowrSearchBuilder<"all", ["with", "filter"], import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, Promise<import("../search/flowr-search").FlowrSearchElements<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, [] | import("../search/flowr-search").FlowrSearchElement<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>[]>>>;
-        readonly processSearchResult: <T extends import("../search/flowr-search").FlowrSearchElement<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>[]>(elements: import("../search/flowr-search").FlowrSearchElements<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, T>, _config: import("./rules/function-finder-util").FunctionsToDetectConfig, _data: {
-            normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
-            dataflow: import("../dataflow/info").DataflowInformation;
-            config: import("../config").FlowrConfigOptions;
-        }, refineSearch?: (elements: T) => T) => {
+        readonly processSearchResult: <T extends import("../search/flowr-search").FlowrSearchElement<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>[]>(elements: import("../search/flowr-search").FlowrSearchElements<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, T>, _config: unknown, _data: unknown, refineSearch?: (elements: T) => T) => {
             results: {
                 certainty: import("./linter-format").LintingResultCertainty;
                 function: import("../dataflow/environments/identifier").Identifier;
@@ -38,7 +34,7 @@ export declare const LintingRules: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             cfg: import("../control-flow/control-flow-graph").ControlFlowInformation;
-            config: import("../config").FlowrConfigOptions;
+            analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: import("./rules/file-path-validity").FilePathValidityResult[];
             ".meta": import("./rules/file-path-validity").FilePathValidityMetadata;
@@ -65,10 +61,10 @@ export declare const LintingRules: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             cfg: import("../control-flow/control-flow-graph").ControlFlowInformation;
-            config: import("../config").FlowrConfigOptions;
+            analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: {
-                certainty: import("./linter-format").LintingResultCertainty.Certain;
+                certainty: import("./linter-format").LintingResultCertainty;
                 function: import("../dataflow/environments/identifier").Identifier;
                 range: import("../util/range").SourceRange;
             }[];
@@ -101,7 +97,7 @@ export declare const LintingRules: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             cfg: import("../control-flow/control-flow-graph").ControlFlowInformation;
-            config: import("../config").FlowrConfigOptions;
+            analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: import("./rules/absolute-path").AbsoluteFilePathResult[];
             ".meta": import("./rules/absolute-path").AbsoluteFilePathMetadata;
@@ -132,7 +128,7 @@ export declare const LintingRules: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             cfg: import("../control-flow/control-flow-graph").ControlFlowInformation;
-            config: import("../config").FlowrConfigOptions;
+            analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: import("./rules/unused-definition").UnusedDefinitionResult[];
             ".meta": import("./rules/unused-definition").UnusedDefinitionMetadata;
@@ -157,7 +153,7 @@ export declare const LintingRules: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             cfg: import("../control-flow/control-flow-graph").ControlFlowInformation;
-            config: import("../config").FlowrConfigOptions;
+            analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: {
                 quickFix: import("./linter-format").LintQuickFixReplacement[] | undefined;
@@ -178,7 +174,7 @@ export declare const LintingRules: {
         readonly info: {
             readonly name: "Naming Convention";
             readonly certainty: import("./linter-format").LintingRuleCertainty.OverApproximative;
-            readonly description: "Checks wether the symbols conform to a certain naming convention";
+            readonly description: "Checks whether the symbols conform to a certain naming convention";
             readonly tags: readonly [import("./linter-tags").LintingRuleTag.Style, import("./linter-tags").LintingRuleTag.QuickFix];
             readonly defaultConfig: {
                 readonly caseing: "auto";
@@ -192,7 +188,7 @@ export declare const LintingRules: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             cfg: import("../control-flow/control-flow-graph").ControlFlowInformation;
-            config: import("../config").FlowrConfigOptions;
+            analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: {
                 certainty: import("./linter-format").LintingResultCertainty;
@@ -222,7 +218,7 @@ export declare const LintingRules: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             cfg: import("../control-flow/control-flow-graph").ControlFlowInformation;
-            config: import("../config").FlowrConfigOptions;
+            analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: import("./rules/dataframe-access-validation").DataFrameAccessValidationResult[];
             '.meta': import("./rules/dataframe-access-validation").DataFrameAccessValidationMetadata;
@@ -247,7 +243,7 @@ export declare const LintingRules: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             cfg: import("../control-flow/control-flow-graph").ControlFlowInformation;
-            config: import("../config").FlowrConfigOptions;
+            analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: {
                 certainty: import("./linter-format").LintingResultCertainty.Certain;
@@ -269,11 +265,11 @@ export declare const LintingRules: {
     };
     readonly 'useless-loop': {
         readonly createSearch: () => import("../search/flowr-search-builder").FlowrSearchBuilder<"all", ["filter"], import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, Promise<import("../search/flowr-search").FlowrSearchElements<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, [] | import("../search/flowr-search").FlowrSearchElement<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>[]>>>;
-        readonly processSearchResult: (elements: import("../search/flowr-search").FlowrSearchElements<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../search/flowr-search").FlowrSearchElement<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>[]>, useLessLoopConfig: import("./rules/useless-loop").UselessLoopConfig, { config, dataflow, normalize, cfg }: {
+        readonly processSearchResult: (elements: import("../search/flowr-search").FlowrSearchElements<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../search/flowr-search").FlowrSearchElement<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>[]>, useLessLoopConfig: import("./rules/useless-loop").UselessLoopConfig, { analyzer, dataflow, normalize, cfg }: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             cfg: import("../control-flow/control-flow-graph").ControlFlowInformation;
-            config: import("../config").FlowrConfigOptions;
+            analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: {
                 certainty: import("./linter-format").LintingResultCertainty.Certain;

package/linter/rules/absolute-path.d.ts

@@ -1,10 +1,8 @@
-import type { LintingResult } from '../linter-format';
-import { LintingRuleCertainty } from '../linter-format';
-import type { MergeableRecord } from '../../util/objects';
-import type { SourceRange } from '../../util/range';
+import { type LintingResult, LintingRuleCertainty } from '../linter-format';
+import { type MergeableRecord } from '../../util/objects';
+import { type SourceRange } from '../../util/range';
 import { LintingRuleTag } from '../linter-tags';
 import type { FunctionInfo } from '../../queries/catalog/dependencies-query/function-info/function-info';
-import type { FlowrConfigOptions } from '../../config';
 export interface AbsoluteFilePathResult extends LintingResult {
     filePath: string;
     range: SourceRange;
@@ -41,7 +39,7 @@ export declare const ABSOLUTE_PATH: {
         normalize: import("../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
         dataflow: import("../../dataflow/info").DataflowInformation;
         cfg: import("../../control-flow/control-flow-graph").ControlFlowInformation;
-        config: FlowrConfigOptions;
+        analyzer: import("../../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
     }) => {
         results: AbsoluteFilePathResult[];
         ".meta": AbsoluteFilePathMetadata;

package/linter/rules/absolute-path.js

@@ -52,7 +52,7 @@ const PathFunctions = {
     'file.path': (df, vtx, config) => {
         const fsep = (0, resolve_argument_1.getArgumentStringValue)(config.solver.variables, df, vtx, undefined, 'fsep', true);
         // in the future we can access `.Platform$file.sep` here
-        const sepValues = new Array(...fsep?.values()?.flatMap(s => [...s].filter(assert_1.isNotUndefined)) ?? [path_1.default.sep]);
+        const sepValues = fsep?.values()?.flatMap(s => s.values().filter(assert_1.isNotUndefined)).toArray() ?? [path_1.default.sep];
         if (sepValues.some(s => s === dependencies_query_format_1.Unknown || (0, assert_1.isUndefined)(s))) {
             // if we have no fsep, we cannot construct a path
             return undefined;
@@ -139,7 +139,7 @@ exports.ABSOLUTE_PATH = {
                     const dfNode = data.dataflow.graph.getVertex(node.info.id);
                     if ((0, vertex_1.isFunctionCallVertex)(dfNode)) {
                         const handler = PathFunctions[dfNode.name ?? ''];
-                        const strings = handler ? handler(data.dataflow.graph, dfNode, data.config) : [];
+                        const strings = handler ? handler(data.dataflow.graph, dfNode, data.analyzer.flowrConfig) : [];
                         if (strings) {
                             return strings.filter(s => (0, strings_1.isAbsolutePath)(s, regex)).map(str => ({
                                 certainty: linter_format_1.LintingResultCertainty.Uncertain,