@eagleoutice/flowr 2.3.0 → 2.4.0

package/linter/rules/deprecated-functions.d.ts

@@ -1,5 +1,5 @@
 import type { LintingResult } from '../linter-format';
-import { LintingCertainty } from '../linter-format';
+import { LintingResultCertainty, LintingRuleCertainty } from '../linter-format';
 import type { MergeableRecord } from '../../util/objects';
 import type { SourceRange } from '../../util/range';
 import type { Identifier } from '../../dataflow/environments/identifier';
@@ -22,7 +22,7 @@ export declare const DEPRECATED_FUNCTIONS: {
     readonly createSearch: (config: DeprecatedFunctionsConfig) => import("../../search/flowr-search-builder").FlowrSearchBuilder<"all", ["with", "filter"], import("../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, 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>[]>) => {
         results: {
-            certainty: LintingCertainty.Definitely;
+            certainty: LintingResultCertainty.Certain;
             function: Identifier;
             range: SourceRange;
         }[];
@@ -35,6 +35,7 @@ export declare const DEPRECATED_FUNCTIONS: {
     readonly info: {
         readonly name: "Deprecated Functions";
         readonly tags: readonly [LintingRuleTag.Deprecated, LintingRuleTag.Smell, LintingRuleTag.Usability, LintingRuleTag.Reproducibility];
+        readonly certainty: LintingRuleCertainty.BestEffort;
         readonly description: "Marks deprecated functions that should not be used anymore.";
         readonly defaultConfig: {
             readonly deprecatedFunctions: readonly ["all_equal", "arrange_all", "distinct_all", "filter_all", "group_by_all", "summarise_all", "mutate_all", "select_all", "vars", "all_vars", "id", "failwith", "select_vars", "rename_vars", "select_var", "current_vars", "bench_tbls", "compare_tbls", "compare_tbls2", "eval_tbls", "eval_tbls2", "location", "changes", "combine", "do", "funs", "add_count_", "add_tally_", "arrange_", "count_", "distinct_", "do_", "filter_", "funs_", "group_by_", "group_indices_", "mutate_", "tally_", "transmute_", "rename_", "rename_vars_", "select_", "select_vars_", "slice_", "summarise_", "summarize_", "summarise_each", "src_local", "tbl_df", "add_rownames", "group_nest", "group_split", "with_groups", "nest_by", "progress_estimated", "recode", "sample_n", "top_n", "transmute", "fct_explicit_na", "aes_", "aes_auto", "annotation_logticks", "is.Coord", "coord_flip", "coord_map", "is.facet", "fortify", "is.ggproto", "guide_train", "is.ggplot", "qplot", "is.theme", "gg_dep", "liply", "isplit2", "list_along", "cross", "invoke", "at_depth", "prepend", "rerun", "splice", "`%@%`", "rbernoulli", "rdunif", "when", "update_list", "map_raw", "accumulate", "reduce_right", "flatten", "map_dfr", "as_vector", "transpose", "melt_delim", "melt_fwf", "melt_table", "read_table2", "str_interp", "as_tibble", "data_frame", "tibble_", "data_frame_", "lst_", "as_data_frame", "as.tibble", "frame_data", "trunc_mat", "is.tibble", "tidy_names", "set_tidy_names", "repair_names", "extract_numeric", "complete_", "drop_na_", "expand_", "crossing_", "nesting_", "extract_", "fill_", "gather_", "nest_", "separate_rows_", "separate_", "spread_", "unite_", "unnest_", "extract", "gather", "nest_legacy", "separate_rows", "separate", "spread"];

package/linter/rules/deprecated-functions.js

@@ -35,7 +35,7 @@ exports.DEPRECATED_FUNCTIONS = {
                 });
             })
                 .map(element => ({
-                certainty: linter_format_1.LintingCertainty.Definitely,
+                certainty: linter_format_1.LintingResultCertainty.Certain,
                 function: element.target,
                 range: element.range
             })),
@@ -49,6 +49,8 @@ exports.DEPRECATED_FUNCTIONS = {
     info: {
         name: 'Deprecated Functions',
         tags: [linter_tags_1.LintingRuleTag.Deprecated, linter_tags_1.LintingRuleTag.Smell, linter_tags_1.LintingRuleTag.Usability, linter_tags_1.LintingRuleTag.Reproducibility],
+        // ensures all deprecated functions found are actually deprecated through its limited config, but doesn't find all deprecated functions since the config is pre-crawled
+        certainty: linter_format_1.LintingRuleCertainty.BestEffort,
         description: 'Marks deprecated functions that should not be used anymore.',
         defaultConfig: {
             deprecatedFunctions: ['all_equal', 'arrange_all', 'distinct_all', 'filter_all', 'group_by_all', 'summarise_all', 'mutate_all', 'select_all', 'vars', 'all_vars', 'id', 'failwith', 'select_vars', 'rename_vars', 'select_var', 'current_vars', 'bench_tbls', 'compare_tbls', 'compare_tbls2', 'eval_tbls', 'eval_tbls2', 'location', 'changes', 'combine', 'do', 'funs', 'add_count_', 'add_tally_', 'arrange_', 'count_', 'distinct_', 'do_', 'filter_', 'funs_', 'group_by_', 'group_indices_', 'mutate_', 'tally_', 'transmute_', 'rename_', 'rename_vars_', 'select_', 'select_vars_', 'slice_', 'summarise_', 'summarize_', 'summarise_each', 'src_local', 'tbl_df', 'add_rownames', 'group_nest', 'group_split', 'with_groups', 'nest_by', 'progress_estimated', 'recode', 'sample_n', 'top_n', 'transmute', 'fct_explicit_na', 'aes_', 'aes_auto', 'annotation_logticks', 'is.Coord', 'coord_flip', 'coord_map', 'is.facet', 'fortify', 'is.ggproto', 'guide_train', 'is.ggplot', 'qplot', 'is.theme', 'gg_dep', 'liply', 'isplit2', 'list_along', 'cross', 'invoke', 'at_depth', 'prepend', 'rerun', 'splice', '`%@%`', 'rbernoulli', 'rdunif', 'when', 'update_list', 'map_raw', 'accumulate', 'reduce_right', 'flatten', 'map_dfr', 'as_vector', 'transpose', 'melt_delim', 'melt_fwf', 'melt_table', 'read_table2', 'str_interp', 'as_tibble', 'data_frame', 'tibble_', 'data_frame_', 'lst_', 'as_data_frame', 'as.tibble', 'frame_data', 'trunc_mat', 'is.tibble', 'tidy_names', 'set_tidy_names', 'repair_names', 'extract_numeric', 'complete_', 'drop_na_', 'expand_', 'crossing_', 'nesting_', 'extract_', 'fill_', 'gather_', 'nest_', 'separate_rows_', 'separate_', 'spread_', 'unite_', 'unnest_', 'extract', 'gather', 'nest_legacy', 'separate_rows', 'separate', 'spread',]

package/linter/rules/file-path-validity.d.ts

@@ -1,8 +1,7 @@
 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 { ParentInformation } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
-import type { FlowrSearchElementFromQuery } from '../../search/flowr-search';
 import type { FunctionInfo } from '../../queries/catalog/dependencies-query/function-info/function-info';
 import { LintingRuleTag } from '../linter-tags';
 export interface FilePathValidityResult extends LintingResult {
@@ -32,8 +31,8 @@ export interface FilePathValidityMetadata extends MergeableRecord {
     totalValid: number;
 }
 export declare const FILE_PATH_VALIDITY: {
-    readonly createSearch: (config: FilePathValidityConfig) => import("../../search/flowr-search-builder").FlowrSearchBuilder<"from-query", [], ParentInformation, import("../../search/flowr-search").FlowrSearchElements<ParentInformation, FlowrSearchElementFromQuery<ParentInformation>[]>>;
-    readonly processSearchResult: (elements: import("../../search/flowr-search").FlowrSearchElements<ParentInformation, FlowrSearchElementFromQuery<ParentInformation>[]>, config: FilePathValidityConfig, data: {
+    readonly createSearch: (config: FilePathValidityConfig) => import("../../search/flowr-search-builder").FlowrSearchBuilder<"from-query", ["with"], import("../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, 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>[]>, config: FilePathValidityConfig, data: {
         normalize: import("../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
         dataflow: import("../../dataflow/info").DataflowInformation;
         config: import("../../config").FlowrConfigOptions;
@@ -44,6 +43,7 @@ export declare const FILE_PATH_VALIDITY: {
     readonly info: {
         readonly name: "File Path Validity";
         readonly description: "Checks whether file paths used in read and write operations are valid and point to existing files.";
+        readonly certainty: LintingRuleCertainty.BestEffort;
         readonly tags: readonly [LintingRuleTag.Robustness, LintingRuleTag.Reproducibility, LintingRuleTag.Bug];
         readonly defaultConfig: {
             readonly additionalReadFunctions: readonly [];

package/linter/rules/file-path-validity.js

@@ -10,9 +10,9 @@ const logic_1 = require("../../util/logic");
 const retriever_1 = require("../../r-bridge/retriever");
 const read_functions_1 = require("../../queries/catalog/dependencies-query/function-info/read-functions");
 const write_functions_1 = require("../../queries/catalog/dependencies-query/function-info/write-functions");
-const extract_cfg_1 = require("../../control-flow/extract-cfg");
 const happens_before_1 = require("../../control-flow/happens-before");
 const linter_tags_1 = require("../linter-tags");
+const search_enrichers_1 = require("../../search/search-executor/search-enrichers");
 exports.FILE_PATH_VALIDITY = {
     createSearch: (config) => flowr_search_builder_1.Q.fromQuery({
         type: 'dependencies',
@@ -20,9 +20,9 @@ exports.FILE_PATH_VALIDITY = {
         ignoreDefaultFunctions: true,
         readFunctions: read_functions_1.ReadFunctions.concat(config.additionalReadFunctions),
         writeFunctions: write_functions_1.WriteFunctions.concat(config.additionalWriteFunctions)
-    }),
+    }).with(search_enrichers_1.Enrichment.CfgInformation),
     processSearchResult: (elements, config, data) => {
-        const cfg = (0, extract_cfg_1.extractSimpleCfg)(data.normalize).graph;
+        const cfg = elements.enrichmentContent(search_enrichers_1.Enrichment.CfgInformation).cfg.graph;
         const metadata = {
             totalReads: 0,
             totalUnknown: 0,
@@ -31,7 +31,7 @@ exports.FILE_PATH_VALIDITY = {
         };
         return {
             results: elements.getElements().flatMap(element => {
-                const results = element.queryResult;
+                const results = elements.enrichmentContent(search_enrichers_1.Enrichment.QueryData).queries['dependencies'];
                 const matchingRead = results.readData.find(r => r.nodeId == element.node.info.id);
                 if (!matchingRead) {
                     return [];
@@ -45,7 +45,7 @@ exports.FILE_PATH_VALIDITY = {
                         return [{
                                 range,
                                 filePath: dependencies_query_format_1.Unknown,
-                                certainty: linter_format_1.LintingCertainty.Maybe
+                                certainty: linter_format_1.LintingResultCertainty.Uncertain
                             }];
                     }
                     else {
@@ -70,7 +70,7 @@ exports.FILE_PATH_VALIDITY = {
                 return [{
                         range,
                         filePath: matchingRead.source,
-                        certainty: writesBefore && writesBefore.length && writesBefore.every(w => w === logic_1.Ternary.Maybe) ? linter_format_1.LintingCertainty.Maybe : linter_format_1.LintingCertainty.Definitely
+                        certainty: writesBefore && writesBefore.length && writesBefore.every(w => w === logic_1.Ternary.Maybe) ? linter_format_1.LintingResultCertainty.Uncertain : linter_format_1.LintingResultCertainty.Certain
                     }];
             }),
             '.meta': metadata
@@ -79,6 +79,8 @@ exports.FILE_PATH_VALIDITY = {
     info: {
         name: 'File Path Validity',
         description: 'Checks whether file paths used in read and write operations are valid and point to existing files.',
+        // checks all found paths for whether they're valid to ensure correctness, but doesn't handle non-constant paths so not all will be returned
+        certainty: linter_format_1.LintingRuleCertainty.BestEffort,
         tags: [linter_tags_1.LintingRuleTag.Robustness, linter_tags_1.LintingRuleTag.Reproducibility, linter_tags_1.LintingRuleTag.Bug],
         defaultConfig: {
             additionalReadFunctions: [],

package/linter/rules/naming-convention.d.ts

@@ -2,8 +2,8 @@ import type { DataflowGraph } from '../../dataflow/graph/graph';
 import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { MergeableRecord } from '../../util/objects';
 import type { SourceRange } from '../../util/range';
-import type { LintQuickFixReplacement, LintingResult } from '../linter-format';
-import { LintingCertainty } from '../linter-format';
+import type { LintingResult, LintQuickFixReplacement } from '../linter-format';
+import { LintingResultCertainty, LintingRuleCertainty } from '../linter-format';
 import { LintingRuleTag } from '../linter-tags';
 export declare enum CasingConvention {
     CamelCase = "camelCase",
@@ -46,7 +46,7 @@ export declare const NAMING_CONVENTION: {
     }) => {
         results: {
             quickFix: LintQuickFixReplacement[] | undefined;
-            certainty: LintingCertainty;
+            certainty: LintingResultCertainty;
             detectedCasing: CasingConvention;
             name: string;
             range: SourceRange;
@@ -62,6 +62,7 @@ export declare const NAMING_CONVENTION: {
     };
     readonly info: {
         readonly name: "Naming Convention";
+        readonly certainty: LintingRuleCertainty.OverApproximative;
         readonly description: "Checks wether the symbols conform to a certain naming convention";
         readonly tags: readonly [LintingRuleTag.Style, LintingRuleTag.QuickFix];
         readonly defaultConfig: {

package/linter/rules/naming-convention.js

@@ -132,7 +132,7 @@ exports.NAMING_CONVENTION = {
     processSearchResult: (elements, config, data) => {
         const symbols = elements.getElements()
             .map(m => ({
-            certainty: linter_format_1.LintingCertainty.Definitely,
+            certainty: linter_format_1.LintingResultCertainty.Certain,
             detectedCasing: detectCasing(m.node.lexeme),
             name: m.node.lexeme,
             range: m.node.info.fullRange,
@@ -158,6 +158,8 @@ exports.NAMING_CONVENTION = {
     },
     info: {
         name: 'Naming Convention',
+        // detects casing heuristically so correctness is not ensured using default config, but checks all identifiers in the code for naming convention match
+        certainty: linter_format_1.LintingRuleCertainty.OverApproximative,
         description: 'Checks wether the symbols conform to a certain naming convention',
         tags: [linter_tags_1.LintingRuleTag.Style, linter_tags_1.LintingRuleTag.QuickFix],
         defaultConfig: {

package/linter/rules/seeded-randomness.d.ts

@@ -1,5 +1,5 @@
 import type { LintingResult } from '../linter-format';
-import { LintingCertainty } from '../linter-format';
+import { LintingResultCertainty, LintingRuleCertainty } from '../linter-format';
 import type { SourceRange } from '../../util/range';
 import type { MergeableRecord } from '../../util/objects';
 import type { Identifier } from '../../dataflow/environments/identifier';
@@ -30,14 +30,14 @@ export interface SeededRandomnessMeta extends MergeableRecord {
     callsWithNonConstantProducers: number;
 }
 export declare const SEEDED_RANDOMNESS: {
-    readonly createSearch: (config: SeededRandomnessConfig) => import("../../search/flowr-search-builder").FlowrSearchBuilder<"all", ["with", "filter", "with"], import("../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../../search/flowr-search").FlowrSearchElements<import("../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../../search/search-executor/search-enrichers").EnrichedFlowrSearchElement<import("../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>[]>>;
+    readonly createSearch: (config: SeededRandomnessConfig) => import("../../search/flowr-search-builder").FlowrSearchBuilder<"all", ["with", "filter", "with"], import("../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, 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>[]>, config: SeededRandomnessConfig, { dataflow }: {
         normalize: import("../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
         dataflow: import("../../dataflow/info").DataflowInformation;
         config: import("../../config").FlowrConfigOptions;
     }) => {
         results: {
-            certainty: LintingCertainty.Definitely;
+            certainty: LintingResultCertainty.Certain;
             function: Identifier;
             range: SourceRange;
         }[];
@@ -55,6 +55,7 @@ export declare const SEEDED_RANDOMNESS: {
             readonly randomnessConsumers: readonly ["jitter", "sample", "sample.int", "arima.sim", "kmeans", "princomp", "rcauchy", "rchisq", "rexp", "rgamma", "rgeom", "rlnorm", "rlogis", "rmultinom", "rnbinom", "rnorm", "rpois", "runif", "pointLabel", "some", "rbernoulli", "rdunif", "generateSeedVectors"];
         };
         readonly tags: readonly [LintingRuleTag.Robustness, LintingRuleTag.Reproducibility];
+        readonly certainty: LintingRuleCertainty.BestEffort;
         readonly name: "Seeded Randomness";
         readonly description: "Checks whether randomness-based function calls are preceded by a random seed generation function. For consistent reproducibility, functions that use randomness should only be called after a constant random seed is set using a function like `set.seed`.";
     };

package/linter/rules/seeded-randomness.js

@@ -86,7 +86,7 @@ exports.SEEDED_RANDOMNESS = {
                 return true;
             })
                 .map(element => ({
-                certainty: linter_format_1.LintingCertainty.Definitely,
+                certainty: linter_format_1.LintingResultCertainty.Certain,
                 function: element.target,
                 range: element.range
             })),
@@ -99,6 +99,8 @@ exports.SEEDED_RANDOMNESS = {
             randomnessConsumers: ['jitter', 'sample', 'sample.int', 'arima.sim', 'kmeans', 'princomp', 'rcauchy', 'rchisq', 'rexp', 'rgamma', 'rgeom', 'rlnorm', 'rlogis', 'rmultinom', 'rnbinom', 'rnorm', 'rpois', 'runif', 'pointLabel', 'some', 'rbernoulli', 'rdunif', 'generateSeedVectors'],
         },
         tags: [linter_tags_1.LintingRuleTag.Robustness, linter_tags_1.LintingRuleTag.Reproducibility],
+        // only finds proper randomness producers and consumers due to its config, but will not find all producers/consumers since not all existing deprecated functions will be in the config
+        certainty: linter_format_1.LintingRuleCertainty.BestEffort,
         name: 'Seeded Randomness',
         description: 'Checks whether randomness-based function calls are preceded by a random seed generation function. For consistent reproducibility, functions that use randomness should only be called after a constant random seed is set using a function like `set.seed`.'
     },

package/linter/rules/unused-definition.d.ts

@@ -1,4 +1,5 @@
 import type { LintingResult } from '../linter-format';
+import { LintingRuleCertainty } from '../linter-format';
 import type { MergeableRecord } from '../../util/objects';
 import type { SourceRange } from '../../util/range';
 import { LintingRuleTag } from '../linter-tags';
@@ -34,6 +35,7 @@ export declare const UNUSED_DEFINITION: {
         readonly name: "Unused Definitions";
         readonly description: "Checks for unused definitions.";
         readonly tags: readonly [LintingRuleTag.Readability, LintingRuleTag.Smell, LintingRuleTag.QuickFix];
+        readonly certainty: LintingRuleCertainty.BestEffort;
         readonly defaultConfig: {
             readonly includeFunctionDefinitions: true;
         };

package/linter/rules/unused-definition.js

@@ -80,7 +80,7 @@ exports.UNUSED_DEFINITION = {
                 // found an unused definition
                 const variableName = element.node.lexeme;
                 return [{
-                        certainty: linter_format_1.LintingCertainty.Maybe,
+                        certainty: linter_format_1.LintingResultCertainty.Uncertain,
                         variableName,
                         range: element.node.info.fullRange ?? element.node.location ?? (0, range_1.rangeFrom)(-1, -1, -1, -1),
                         quickFix: buildQuickFix(element.node, data.dataflow.graph, data.normalize)
@@ -97,6 +97,8 @@ exports.UNUSED_DEFINITION = {
         name: 'Unused Definitions',
         description: 'Checks for unused definitions.',
         tags: [linter_tags_1.LintingRuleTag.Readability, linter_tags_1.LintingRuleTag.Smell, linter_tags_1.LintingRuleTag.QuickFix],
+        // our limited analysis causes unused definitions involving complex reflection etc. not to be included in our result, but unused definitions are correctly validated
+        certainty: linter_format_1.LintingRuleCertainty.BestEffort,
         defaultConfig: {
             includeFunctionDefinitions: true
         }

package/package.json

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

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

@@ -40,7 +40,12 @@ function executeDependenciesQuery(data, queries) {
     const readFunctions = getFunctionsToCheck(query.readFunctions, ignoreDefault, read_functions_1.ReadFunctions);
     const writeFunctions = getFunctionsToCheck(query.writeFunctions, ignoreDefault, write_functions_1.WriteFunctions);
     const numberOfFunctions = libraryFunctions.length + sourceFunctions.length + readFunctions.length + writeFunctions.length;
-    const results = numberOfFunctions === 0 ? { kinds: {}, '.meta': { timing: 0 } } : (0, query_1.executeQueriesOfSameType)(data, ...makeCallContextQuery(libraryFunctions, 'library'), ...makeCallContextQuery(sourceFunctions, 'source'), ...makeCallContextQuery(readFunctions, 'read'), ...makeCallContextQuery(writeFunctions, 'write'));
+    const results = numberOfFunctions === 0 ? { kinds: {}, '.meta': { timing: 0 } } : (0, query_1.executeQueriesOfSameType)(data, [
+        makeCallContextQuery(libraryFunctions, 'library'),
+        makeCallContextQuery(sourceFunctions, 'source'),
+        makeCallContextQuery(readFunctions, 'read'),
+        makeCallContextQuery(writeFunctions, 'write')
+    ].flat());
     function getLexeme(argument, id) {
         if ((argument && argument !== dependencies_query_format_1.Unknown) || !id) {
             return undefined;

package/queries/catalog/dependencies-query/function-info/read-functions.js

@@ -97,5 +97,6 @@ exports.ReadFunctions = [
     { package: 'stats', name: 'read.ftable', argIdx: 0, argName: 'file', resolveValue: true },
     { package: 'DBI', name: 'dbReadTable', argIdx: 1, argName: 'name', resolveValue: true },
     { package: 'DBI', name: 'dbReadTableArrow', argIdx: 1, argName: 'name', resolveValue: true },
+    { package: 'jsonlite', name: 'read_json', argIdx: 0, argName: 'path', resolveValue: true },
 ];
 //# sourceMappingURL=read-functions.js.map

package/queries/catalog/dependencies-query/function-info/write-functions.js

@@ -83,5 +83,6 @@ exports.WriteFunctions = [
     { package: 'rasterpdf', name: 'raster_pdf', argIdx: 0, argName: 'filename', resolveValue: true },
     { package: 'rasterpdf', name: 'agg_pdf', argIdx: 0, argName: 'filename', resolveValue: true },
     { package: 'highcharter', name: 'hc_exporting', argName: 'filename', resolveValue: true },
+    { package: 'jsonlite', name: 'write_json', argIdx: 1, argName: 'path', resolveValue: true },
 ];
 //# sourceMappingURL=write-functions.js.map

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

@@ -33,7 +33,7 @@ exports.LinterQueryDefinition = {
 function addLintingRuleResult(ruleName, results, result) {
     const rule = linter_rules_1.LintingRules[ruleName];
     result.push(`   ╰ **${rule.info.name}** (${ruleName}):`);
-    for (const certainty of [linter_format_1.LintingCertainty.Definitely, linter_format_1.LintingCertainty.Maybe]) {
+    for (const certainty of [linter_format_1.LintingResultCertainty.Certain, linter_format_1.LintingResultCertainty.Uncertain]) {
         const certaintyResults = results.results.filter(r => r.certainty === certainty);
         if (certaintyResults.length) {
             result.push(`       ╰ ${certainty}:`);

package/queries/catalog/location-map-query/location-map-query-executor.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeLocationMapQuery = executeLocationMapQuery;
-const log_1 = require("../../../util/log");
+const parse_1 = require("../../../slicing/criterion/parse");
+const assert_1 = require("../../../util/assert");
 const fileIdRegex = /^(?<file>.*(\.[rR]))-/;
 function fuzzyFindFile(node, idMap) {
     if (node?.info.file) {
@@ -22,10 +23,11 @@ function fuzzyFindFile(node, idMap) {
     return '<inline>';
 }
 function executeLocationMapQuery({ ast, dataflow: { graph } }, queries) {
-    if (queries.length !== 1) {
-        log_1.log.warn('Id-Map query expects only up to one query, but got', queries.length);
-    }
     const start = Date.now();
+    const criteriaOfInterest = new Set(queries
+        .flatMap(q => q.ids ?? [])
+        .map(c => (0, parse_1.tryResolveSliceCriterionToId)(c, ast.idMap))
+        .filter(assert_1.isNotUndefined));
     const locationMap = {
         files: {},
         ids: {}
@@ -38,7 +40,7 @@ function executeLocationMapQuery({ ast, dataflow: { graph } }, queries) {
         count++;
     }
     for (const [id, node] of ast.idMap.entries()) {
-        if (node.location) {
+        if (node.location && (criteriaOfInterest.size === 0 || criteriaOfInterest.has(id))) {
             const file = fuzzyFindFile(node, ast.idMap);
             locationMap.ids[id] = [
                 inverseMap.get(file) ?? -1,

package/queries/catalog/location-map-query/location-map-query-format.d.ts

@@ -4,8 +4,11 @@ import { type OutputFormatter } from '../../../util/text/ansi';
 import Joi from 'joi';
 import type { NodeId } from '../../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { SourceRange } from '../../../util/range';
+import type { SingleSlicingCriterion } from '../../../slicing/criterion/parse';
 export interface LocationMapQuery extends BaseQueryFormat {
     readonly type: 'location-map';
+    /** Optional list of ids to filter the results by. If not provided, all ids will be included. */
+    readonly ids?: readonly SingleSlicingCriterion[];
 }
 export type FileId = number & {
     readonly __fileId?: unique symbol;

package/queries/catalog/location-map-query/location-map-query-format.js

@@ -23,6 +23,7 @@ exports.LocationMapQueryDefinition = {
     },
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('location-map').required().description('The type of the query.'),
+        ids: joi_1.default.array().items(joi_1.default.string()).optional().description('Optional list of ids to filter the results by.')
     }).description('The location map query retrieves the location of every id in the ast.'),
     flattenInvolvedNodes: () => []
 };

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

@@ -9,7 +9,7 @@ function executeSearch({ ast, dataflow, config }, queries) {
         const { search } = query;
         results.push({
             ids: (0, flowr_search_executor_1.runSearch)(search, { normalize: ast, dataflow, config })
-                .map(({ node }) => node.info.id),
+                .getElements().map(({ node }) => node.info.id),
             search
         });
     }

package/queries/catalog/static-slice-query/static-slice-query-executor.js

@@ -7,6 +7,7 @@ const reconstruct_1 = require("../../../reconstruct/reconstruct");
 const auto_select_defaults_1 = require("../../../reconstruct/auto-select/auto-select-defaults");
 const magic_comments_1 = require("../../../reconstruct/auto-select/magic-comments");
 const log_1 = require("../../../util/log");
+const _00_slice_1 = require("../../../core/steps/all/static-slicing/00-slice");
 function fingerPrintOfQuery(query) {
     return JSON.stringify(query);
 }
@@ -20,7 +21,7 @@ function executeStaticSliceQuery({ dataflow: { graph }, ast, config }, queries)
         }
         const { criteria, noReconstruction, noMagicComments } = query;
         const sliceStart = Date.now();
-        const slice = (0, static_slicer_1.staticSlicing)(graph, ast, criteria, config.solver.slicer?.threshold);
+        const slice = (0, static_slicer_1.staticSlice)(graph, ast, criteria, query.direction ?? _00_slice_1.SliceDirection.Backward, config.solver.slicer?.threshold);
         const sliceEnd = Date.now();
         if (noReconstruction) {
             results[key] = { slice: { ...slice, '.meta': { timing: sliceEnd - sliceStart } } };

package/queries/catalog/static-slice-query/static-slice-query-format.d.ts

@@ -4,6 +4,7 @@ import type { DEFAULT_DATAFLOW_PIPELINE, DEFAULT_SLICE_WITHOUT_RECONSTRUCT_PIPEL
 import type { SlicingCriteria } from '../../../slicing/criterion/parse';
 import Joi from 'joi';
 import { executeStaticSliceQuery } from './static-slice-query-executor';
+import { SliceDirection } from '../../../core/steps/all/static-slicing/00-slice';
 import type { NodeId } from '../../../r-bridge/lang-4.x/ast/model/processing/node-id';
 /** Calculates and returns all clusters encountered in the dataflow graph. */
 export interface StaticSliceQuery extends BaseQueryFormat {
@@ -14,6 +15,8 @@ export interface StaticSliceQuery extends BaseQueryFormat {
     readonly noReconstruction?: boolean;
     /** Should the magic comments (force-including lines within the slice) be ignored? */
     readonly noMagicComments?: boolean;
+    /** The direction to slice in. Defaults to backward slicing if unset. */
+    readonly direction?: SliceDirection;
 }
 export interface StaticSliceQueryResult extends BaseQueryResult {
     /**

package/queries/catalog/static-slice-query/static-slice-query-format.js

@@ -9,6 +9,7 @@ const time_1 = require("../../../util/text/time");
 const joi_1 = __importDefault(require("joi"));
 const static_slice_query_executor_1 = require("./static-slice-query-executor");
 const query_print_1 = require("../../query-print");
+const _00_slice_1 = require("../../../core/steps/all/static-slicing/00-slice");
 exports.StaticSliceQueryDefinition = {
     executor: static_slice_query_executor_1.executeStaticSliceQuery,
     asciiSummarizer: (formatter, _processed, queryResults, result) => {
@@ -37,7 +38,8 @@ exports.StaticSliceQueryDefinition = {
         type: joi_1.default.string().valid('static-slice').required().description('The type of the query.'),
         criteria: joi_1.default.array().items(joi_1.default.string()).min(0).required().description('The slicing criteria to use.'),
         noReconstruction: joi_1.default.boolean().optional().description('Do not reconstruct the slice into readable code.'),
-        noMagicComments: joi_1.default.boolean().optional().description('Should the magic comments (force-including lines within the slice) be ignored?')
+        noMagicComments: joi_1.default.boolean().optional().description('Should the magic comments (force-including lines within the slice) be ignored?'),
+        direction: joi_1.default.string().valid(...Object.values(_00_slice_1.SliceDirection)).optional().description('The direction to slice in. Defaults to backward slicing if unset.')
     }).description('Slice query used to slice the dataflow graph'),
     flattenInvolvedNodes: (queryResults) => {
         const flattened = [];

package/queries/query-print.d.ts

@@ -5,4 +5,4 @@ import type { DEFAULT_DATAFLOW_PIPELINE } from '../core/steps/pipeline/default-p
 import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
 export declare function asciiCallContext(formatter: OutputFormatter, results: QueryResults<'call-context'>['call-context'], processed: PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>): string;
 export declare function summarizeIdsIfTooLong(formatter: OutputFormatter, ids: readonly NodeId[]): string;
-export declare function asciiSummaryOfQueryResult(formatter: OutputFormatter, totalInMs: number, results: QueryResults<SupportedQueryTypes>, processed: PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>): string;
+export declare function asciiSummaryOfQueryResult<S extends SupportedQueryTypes>(formatter: OutputFormatter, totalInMs: number, results: Awaited<QueryResults<S>>, processed: PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>): string;

package/queries/query-print.js

@@ -81,7 +81,6 @@ function asciiSummaryOfQueryResult(formatter, totalInMs, results, processed) {
         }
         result.push(`Query: ${(0, ansi_1.bold)(query, formatter)}`);
         let timing = -1;
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         for (const [key, value] of Object.entries(queryResults)) {
             if (key === '.meta') {
                 timing = value.timing;

package/queries/query.d.ts

@@ -25,11 +25,20 @@ import type { LinterQuery } from './catalog/linter-query/linter-query-format';
 import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { ControlFlowQuery } from './catalog/control-flow-query/control-flow-query-format';
 import type { DfShapeQuery } from './catalog/df-shape-query/df-shape-query-format';
+import type { AsyncOrSync, AsyncOrSyncType } from 'ts-essentials';
+/**
+ * These are all queries that can be executed from within flowR
+ * {@link SynchronousQuery} are queries that can be executed synchronously, i.e., they do not return a Promise.
+ */
 export type Query = CallContextQuery | ConfigQuery | SearchQuery | DataflowQuery | ControlFlowQuery | DataflowLensQuery | DfShapeQuery | NormalizedAstQuery | IdMapQuery | DataflowClusterQuery | StaticSliceQuery | LineageQuery | DependenciesQuery | LocationMapQuery | HappensBeforeQuery | ResolveValueQuery | ProjectQuery | OriginQuery | LinterQuery;
+export type SynchronousQuery = Exclude<Query, {
+    executor: (query: Query) => Promise<unknown>;
+}>;
+export type SupportedSynchronousQueryTypes = SynchronousQuery['type'];
 export type QueryArgumentsWithType<QueryType extends BaseQueryFormat['type']> = Query & {
     type: QueryType;
 };
-export type QueryExecutor<Query extends BaseQueryFormat, Result extends BaseQueryResult> = (data: BasicQueryData, query: readonly Query[]) => Result;
+export type QueryExecutor<Query extends BaseQueryFormat, Result extends BaseQueryResult> = (data: BasicQueryData, query: readonly Query[]) => AsyncOrSync<Result>;
 type SupportedQueries = {
     [QueryType in Query['type']]: SupportedQuery<QueryType>;
 };
@@ -1008,17 +1017,19 @@ export declare const SupportedQueries: {
     };
 };
 export type SupportedQueryTypes = keyof typeof SupportedQueries;
-export type QueryResult<Type extends Query['type']> = ReturnType<typeof SupportedQueries[Type]['executor']>;
-export declare function executeQueriesOfSameType<SpecificQuery extends Query>(data: BasicQueryData, ...queries: readonly SpecificQuery[]): QueryResult<SpecificQuery['type']>;
+export type QueryResult<Type extends Query['type']> = AsyncOrSync<ReturnType<typeof SupportedQueries[Type]['executor']>>;
+export declare function executeQueriesOfSameType<SpecificQuery extends SynchronousQuery>(data: BasicQueryData, queries: readonly SpecificQuery[]): AsyncOrSyncType<QueryResult<SpecificQuery['type']>>;
+export declare function executeQueriesOfSameType<SpecificQuery extends Query>(data: BasicQueryData, queries: readonly SpecificQuery[]): QueryResult<SpecificQuery['type']>;
 export type QueryResults<Base extends SupportedQueryTypes> = {
-    readonly [QueryType in Base]: QueryResult<QueryType>;
+    readonly [QueryType in Base]: Awaited<QueryResult<QueryType>>;
 } & BaseQueryResult;
 type OmitFromValues<T, K extends string | number | symbol> = {
     [P in keyof T]?: Omit<T[P], K>;
 };
 export type QueryResultsWithoutMeta<Queries extends Query> = OmitFromValues<Omit<QueryResults<Queries['type']>, '.meta'>, '.meta'>;
 export type Queries<Base extends SupportedQueryTypes, VirtualArguments extends VirtualCompoundConstraint<Base> = VirtualCompoundConstraint<Base>> = readonly (QueryArgumentsWithType<Base> | VirtualQueryArgumentsWithType<Base, VirtualArguments>)[];
-export declare function executeQueries<Base extends SupportedQueryTypes, VirtualArguments extends VirtualCompoundConstraint<Base> = VirtualCompoundConstraint<Base>>(data: BasicQueryData, queries: Queries<Base, VirtualArguments>): QueryResults<Base>;
+export declare function executeQueries<Base extends SupportedSynchronousQueryTypes, VirtualArguments extends VirtualCompoundConstraint<Base> = VirtualCompoundConstraint<Base>>(data: BasicQueryData, queries: Queries<Base, VirtualArguments>): QueryResults<Base>;
+export declare function executeQueries<Base extends SupportedQueryTypes, VirtualArguments extends VirtualCompoundConstraint<Base> = VirtualCompoundConstraint<Base>>(data: BasicQueryData, queries: Queries<Base, VirtualArguments>): AsyncOrSync<QueryResults<Base>>;
 export declare function SupportedQueriesSchema(): Joi.AlternativesSchema<any>;
 export declare const CompoundQuerySchema: Joi.ObjectSchema<any>;
 export declare function VirtualQuerySchema(): Joi.AlternativesSchema<any>;

package/queries/query.js

@@ -53,7 +53,7 @@ exports.SupportedQueries = {
     'origin': origin_query_format_1.OriginQueryDefinition,
     'linter': linter_query_format_1.LinterQueryDefinition
 };
-function executeQueriesOfSameType(data, ...queries) {
+function executeQueriesOfSameType(data, queries) {
     (0, assert_1.guard)(queries.length > 0, 'At least one query must be provided');
     /* every query must have the same type */
     (0, assert_1.guard)(queries.every(q => q.type === queries[0].type), 'All queries must have the same type');
@@ -67,9 +67,7 @@ function isVirtualQuery(query) {
 function groupQueriesByType(queries) {
     const grouped = {};
     function addQuery(query) {
-        if (grouped[query.type] === undefined) {
-            grouped[query.type] = [];
-        }
+        grouped[query.type] ??= [];
         grouped[query.type].push(query);
     }
     for (const query of queries) {
@@ -86,17 +84,32 @@ function groupQueriesByType(queries) {
     }
     return grouped;
 }
+function isPromiseLike(value) {
+    return value !== null && typeof value === 'object' && typeof value.then === 'function';
+}
+/**
+ * This is the main query execution function that takes a set of queries and executes them on the given data.
+ */
 function executeQueries(data, queries) {
     const now = Date.now();
     const grouped = groupQueriesByType(queries);
-    const results = {};
-    for (const type of Object.keys(grouped)) {
-        results[type] = executeQueriesOfSameType(data, ...grouped[type]);
+    const entries = Object.entries(grouped);
+    const results = entries.map(([type, group]) => [type, executeQueriesOfSameType(data, group)]);
+    if (results.length === 0 || results.every(([_, r]) => !isPromiseLike(r))) {
+        // all results are synchronous, we can return them directly
+        const r = Object.fromEntries(results);
+        r['.meta'] = {
+            timing: Date.now() - now
+        };
+        return r;
     }
-    results['.meta'] = {
-        timing: Date.now() - now
-    };
-    return results;
+    return Promise.all(results.map(([type, result]) => Promise.resolve(result).then(resolvedResult => [type, resolvedResult]))).then(resultsArray => {
+        const results = Object.fromEntries(resultsArray);
+        results['.meta'] = {
+            timing: Date.now() - now
+        };
+        return results;
+    });
 }
 function SupportedQueriesSchema() {
     return joi_1.default.alternatives(Object.values(exports.SupportedQueries).map(q => q.schema)).description('Supported queries');