@eagleoutice/flowr 2.8.4 → 2.8.5

package/linter/linter-format.d.ts

@@ -11,6 +11,7 @@ import type { SourceRange } from '../util/range';
 import type { DataflowInformation } from '../dataflow/info';
 import type { ControlFlowInformation } from '../control-flow/control-flow-graph';
 import type { ReadonlyFlowrAnalysisProvider } from '../project/flowr-analyzer';
+import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
 export interface LinterRuleInformation<Config extends MergeableRecord = never> {
     /** Human-Readable name of the linting rule. */
     readonly name: string;
@@ -94,11 +95,16 @@ export type LintQuickFix = LintQuickFixReplacement | LintQuickFixRemove;
  * A linting result for a single linting rule match.
  */
 export interface LintingResult {
+    /** The certainty of the linting result. */
     readonly certainty: LintingResultCertainty;
     /**
      * If available, what to do to fix the linting result.
      */
     readonly quickFix?: LintQuickFix[];
+    /**
+     * The node ID involved in this linting result, if applicable.
+     */
+    readonly involvedId: NodeId | undefined;
 }
 export interface ConfiguredLintingRule<Name extends LintingRuleNames = LintingRuleNames> {
     readonly name: Name;

package/linter/linter-rules.d.ts

@@ -9,6 +9,7 @@ export declare const LintingRules: {
         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;
+                involvedId: import("../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
                 function: import("../dataflow/environments/identifier").Identifier;
                 range: import("../util/range").SourceRange;
             }[];
@@ -64,6 +65,7 @@ export declare const LintingRules: {
             analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: {
+                involvedId: import("../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
                 certainty: import("./linter-format").LintingResultCertainty;
                 function: import("../dataflow/environments/identifier").Identifier;
                 range: import("../util/range").SourceRange;
@@ -156,6 +158,7 @@ export declare const LintingRules: {
             analyzer: import("../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
         }) => {
             results: {
+                involvedId: import("../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
                 quickFix: import("./linter-format").LintQuickFixReplacement[] | undefined;
                 certainty: import("./linter-format").LintingResultCertainty;
                 detectedCasing: import("./rules/naming-convention").CasingConvention;
@@ -192,6 +195,7 @@ export declare const LintingRules: {
         }) => {
             results: {
                 certainty: import("./linter-format").LintingResultCertainty;
+                involvedId: import("../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
                 function: import("../dataflow/environments/identifier").Identifier;
                 range: import("../util/range").SourceRange;
             }[];
@@ -247,6 +251,7 @@ export declare const LintingRules: {
         }) => {
             results: {
                 certainty: import("./linter-format").LintingResultCertainty.Certain;
+                involvedId: undefined;
                 range: import("../util/range").SourceRange;
             }[];
             '.meta': import("./rules/dead-code").DeadCodeMetadata;
@@ -275,6 +280,7 @@ export declare const LintingRules: {
                 certainty: import("./linter-format").LintingResultCertainty.Certain;
                 name: string;
                 range: import("../util/range").SourceRange;
+                involvedId: import("../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
             }[];
             '.meta': {
                 numOfUselessLoops: number;

package/linter/rules/dataframe-access-validation.js

@@ -65,6 +65,7 @@ exports.DATA_FRAME_ACCESS_VALIDATION = {
         }))
             .map(({ node, operand, ...accessed }) => ({
             ...accessed,
+            involvedId: node?.info.id,
             access: node?.lexeme ?? '???',
             ...(operand?.type === type_1.RType.Symbol ? { operand: operand.content } : {}),
             range: node?.info.fullRange ?? node?.location ?? (0, range_1.rangeFrom)(-1, -1, -1, -1),

package/linter/rules/dead-code.d.ts

@@ -26,6 +26,7 @@ export declare const DEAD_CODE: {
     }) => {
         results: {
             certainty: LintingResultCertainty.Certain;
+            involvedId: undefined;
             range: SourceRange;
         }[];
         '.meta': DeadCodeMetadata;

package/linter/rules/dead-code.js

@@ -29,6 +29,7 @@ exports.DEAD_CODE = {
                 .filter(assert_1.isNotUndefined)))
                 .map(range => ({
                 certainty: linter_format_1.LintingResultCertainty.Certain,
+                involvedId: undefined,
                 range
             })),
             '.meta': meta

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

@@ -6,6 +6,7 @@ export declare const DEPRECATED_FUNCTIONS: {
     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;
+            involvedId: import("../../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
             function: import("../../dataflow/environments/identifier").Identifier;
             range: import("../../util/range").SourceRange;
         }[];

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

@@ -39,6 +39,7 @@ exports.FILE_PATH_VALIDITY = {
                     metadata.totalUnknown++;
                     if (config.includeUnknown) {
                         return [{
+                                involvedId: matchingRead.nodeId,
                                 range,
                                 filePath: dependencies_query_format_1.Unknown,
                                 certainty: linter_format_1.LintingResultCertainty.Uncertain
@@ -65,6 +66,7 @@ exports.FILE_PATH_VALIDITY = {
                     return [];
                 }
                 return [{
+                        involvedId: matchingRead.nodeId,
                         range,
                         filePath: matchingRead.value,
                         certainty: writesBefore && writesBefore.length && writesBefore.every(w => w === logic_1.Ternary.Maybe) ? linter_format_1.LintingResultCertainty.Uncertain : linter_format_1.LintingResultCertainty.Certain

package/linter/rules/function-finder-util.d.ts

@@ -29,6 +29,7 @@ export declare const functionFinderUtil: {
     processSearchResult: <T extends FlowrSearchElement<ParentInformation>[]>(elements: FlowrSearchElements<ParentInformation, T>, _config: unknown, _data: unknown, refineSearch?: (elements: T) => T) => {
         results: {
             certainty: LintingResultCertainty;
+            involvedId: import("../../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
             function: Identifier;
             range: SourceRange;
         }[];

package/linter/rules/function-finder-util.js

@@ -45,6 +45,7 @@ exports.functionFinderUtil = {
         return {
             results: results.map(element => ({
                 certainty: linter_format_1.LintingResultCertainty.Certain,
+                involvedId: element.node.info.id,
                 function: element.target,
                 range: element.range
             })),

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

@@ -60,6 +60,7 @@ export declare const NAMING_CONVENTION: {
         analyzer: import("../../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
     }) => {
         results: {
+            involvedId: NodeId;
             quickFix: LintQuickFixReplacement[] | undefined;
             certainty: LintingResultCertainty;
             detectedCasing: CasingConvention;

package/linter/rules/naming-convention.js

@@ -168,6 +168,7 @@ exports.NAMING_CONVENTION = {
             const fix = fixCasing(m.name, casing);
             return {
                 ...m,
+                involvedId: id,
                 quickFix: fix ? createNamingConventionQuickFixes(data.dataflow.graph, id, fix, casing) : undefined
             };
         });

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

@@ -18,6 +18,7 @@ export declare const NETWORK_FUNCTIONS: {
     }) => {
         results: {
             certainty: import("../linter-format").LintingResultCertainty;
+            involvedId: import("../../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
             function: import("../../dataflow/environments/identifier").Identifier;
             range: import("../../util/range").SourceRange;
         }[];

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

@@ -38,6 +38,7 @@ export declare const SEEDED_RANDOMNESS: {
         analyzer: import("../../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider;
     }) => {
         results: {
+            involvedId: import("../../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
             certainty: LintingResultCertainty;
             function: Identifier;
             range: SourceRange;

package/linter/rules/seeded-randomness.js

@@ -47,6 +47,7 @@ exports.SEEDED_RANDOMNESS = {
                 .flatMap(element => (0, search_enrichers_1.enrichmentContent)(element, search_enrichers_1.Enrichment.CallTargets).targets.map(target => {
                 metadata.consumerCalls++;
                 return {
+                    involvedId: element.node.info.id,
                     range: element.node.info.fullRange,
                     target: target,
                     searchElement: element
@@ -110,6 +111,7 @@ exports.SEEDED_RANDOMNESS = {
                     metadata.callsWithOtherBranchProducers++;
                 }
                 return [{
+                        involvedId: element.involvedId,
                         certainty: cdsOfProduces.size > 0 ? linter_format_1.LintingResultCertainty.Uncertain : linter_format_1.LintingResultCertainty.Certain,
                         function: element.target,
                         range: element.range

package/linter/rules/unused-definition.js

@@ -83,6 +83,7 @@ exports.UNUSED_DEFINITION = {
                 return [{
                         certainty: linter_format_1.LintingResultCertainty.Uncertain,
                         variableName,
+                        involvedId: element.node.info.id,
                         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)
                     }];

package/linter/rules/useless-loop.d.ts

@@ -26,6 +26,7 @@ export declare const USELESS_LOOP: {
             certainty: LintingResultCertainty.Certain;
             name: string;
             range: SourceRange;
+            involvedId: import("../../r-bridge/lang-4.x/ast/model/processing/node-id").NodeId;
         }[];
         '.meta': {
             numOfUselessLoops: number;

package/linter/rules/useless-loop.js

@@ -19,7 +19,8 @@ exports.USELESS_LOOP = {
         }).filter(loop => (0, useless_loop_1.onlyLoopsOnce)(loop.node.info.id, dataflow.graph, cfg, normalize, analyzer.inspectContext())).map(res => ({
             certainty: linter_format_1.LintingResultCertainty.Certain,
             name: res.node.lexeme,
-            range: res.node.info.fullRange
+            range: res.node.info.fullRange,
+            involvedId: res.node.info.id
         }));
         return {
             results: results,

package/package.json

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

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

@@ -31,6 +31,10 @@ export declare const LinterQueryDefinition: {
     readonly completer: typeof linterQueryCompleter;
     readonly fromLine: typeof linterQueryLineParser;
     readonly schema: Joi.ObjectSchema<any>;
-    readonly flattenInvolvedNodes: () => never[];
+    readonly flattenInvolvedNodes: (queryResults: BaseQueryResult) => ((string & {
+        __brand?: "node-id";
+    }) | (number & {
+        __brand?: "node-id";
+    }))[];
 };
 export {};

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

@@ -105,7 +105,15 @@ exports.LinterQueryDefinition = {
             config: joi_1.default.object()
         })).description('The rules to lint for. If unset, all rules will be included.')
     }).description('The linter query lints for the given set of rules and returns the result.'),
-    flattenInvolvedNodes: () => []
+    flattenInvolvedNodes: (queryResults) => {
+        const out = queryResults;
+        return Object.values(out.results).flatMap(v => {
+            if ((0, linter_format_1.isLintingResultsError)(v)) {
+                return [];
+            }
+            return v.results.map(v => v.involvedId);
+        }).filter(assert_1.isNotUndefined);
+    }
 };
 function addLintingRuleResult(ruleName, results, result) {
     const rule = linter_rules_1.LintingRules[ruleName];

package/queries/query.d.ts

@@ -228,7 +228,11 @@ export declare const SupportedQueries: {
         readonly completer: (line: readonly string[], startingNewArg: boolean, _config: FlowrConfigOptions) => CommandCompletions;
         readonly fromLine: (output: ReplOutput, line: readonly string[], _config: FlowrConfigOptions) => ParsedQueryLine<"linter">;
         readonly schema: Joi.ObjectSchema<any>;
-        readonly flattenInvolvedNodes: () => never[];
+        readonly flattenInvolvedNodes: (queryResults: BaseQueryResult) => ((string & {
+            __brand?: "node-id";
+        }) | (number & {
+            __brand?: "node-id";
+        }))[];
     };
 };
 export type SupportedQueryTypes = keyof typeof SupportedQueries;

package/util/version.js

@@ -6,7 +6,7 @@ exports.printVersionInformation = printVersionInformation;
 const semver_1 = require("semver");
 const assert_1 = require("./assert");
 // this is automatically replaced with the current version by release-it
-const version = '2.8.4';
+const version = '2.8.5';
 /**
  * Retrieves the current flowR version as a new {@link SemVer} object.
  */