@eagleoutice/flowr 2.2.16 → 2.4.0

package/documentation/print-linter-wiki.js

@@ -20,11 +20,12 @@ const strings_1 = require("../util/text/strings");
 const assert_1 = require("../util/assert");
 const doc_print_1 = require("./doc-util/doc-print");
 const doc_functions_1 = require("./doc-util/doc-functions");
+const linter_format_1 = require("../linter/linter-format");
 const SpecialTagColors = {
     [linter_tags_1.LintingRuleTag.Bug]: 'red',
     [linter_tags_1.LintingRuleTag.Security]: 'orange',
     [linter_tags_1.LintingRuleTag.Smell]: 'yellow',
-    [linter_tags_1.LintingRuleTag.QuickFix]: 'lightgray',
+    [linter_tags_1.LintingRuleTag.QuickFix]: 'lightgray'
 };
 function makeTagBadge(name, info) {
     const doc = (0, doc_types_1.getDocumentationForType)('LintingRuleTag::' + name, info, '', true).replaceAll('\n', ' ');
@@ -108,6 +109,11 @@ print(x)
 myVar <- 42
 print(myVar)
 `, tagTypes);
+    rule(shell, 'dataframe-access-validation', 'DataFrameAccessValidationConfig', 'DATA_FRAME_ACCESS_VALIDATION', 'lint-dataframe-access-validation', `
+df <- data.frame(id = 1:5, name = 6:10)
+df[6, "value"]
+`, tagTypes);
+    rule(shell, 'dead-code', 'DeadCodeConfig', 'DEAD_CODE', 'lint-dead-code', 'if(TRUE) 1 else 2', tagTypes);
     function rule(shell, name, configType, ruleType, testfile, example, types) {
         const rule = linter_rules_1.LintingRules[name];
         const tags = rule.info.tags.toSorted((a, b) => {
@@ -126,6 +132,8 @@ print(myVar)
             }
             return a.localeCompare(b);
         }).map(t => makeTagBadge(t, types)).join(' ');
+        const certaintyDoc = (0, doc_types_1.getDocumentationForType)(`LintingRuleCertainty::${rule.info.certainty}`, types, '', true).replaceAll('\n', ' ');
+        const certaintyText = `\`${(0, html_hover_over_1.textWithTooltip)(rule.info.certainty, certaintyDoc)}\``;
         if (format === 'short') {
             ruleExplanations.set(name, () => Promise.resolve(`
 	**[${rule.info.name}](${doc_files_1.FlowrWikiBaseRef}/lint-${name}):** ${rule.info.description} [see ${(0, doc_types_1.shortLinkFile)(ruleType, types)}]\\
@@ -140,6 +148,9 @@ ${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'linte
 ${(0, doc_structure_1.section)(rule.info.name + `&emsp;<sup>[<a href="${doc_files_1.FlowrWikiBaseRef}/Linter">overview</a>]</sup>`, 2, name)}
 
 ${tags}
+
+
+This rule is a ${certaintyText} rule.
  
 ${rule.info.description}\\
 _This linting rule is implemented in ${(0, doc_types_1.shortLinkFile)(ruleType, types)}._
@@ -167,9 +178,12 @@ ${buildSamplesFromLinterTestCases(shell, `${testfile}.test.ts`)}
     }
     return ruleExplanations;
 }
-function getAllLintingRulesWitTag(tag) {
+function getAllLintingRulesWithTag(tag) {
     return Object.entries(linter_rules_1.LintingRules).filter(([_, rule]) => rule.info.tags.includes(tag)).map(([name]) => name);
 }
+function getAllLintingRulesWitCertainty(certainty) {
+    return Object.entries(linter_rules_1.LintingRules).filter(([_, rule]) => rule.info.certainty === certainty).map(([name]) => name);
+}
 function linkToRule(name) {
     return `[${name}](${doc_files_1.FlowrWikiBaseRef}/lint-${name})`;
 }
@@ -210,14 +224,32 @@ ${await (async () => {
 	
 ${(0, doc_structure_1.section)('Tags', 2, 'tags')}
 
-We use tags to categorize linting rules. The following tags are available:
+We use tags to categorize linting rules for users. The following tags are available:
 
 | Tag/Badge&emsp;&emsp; | Description |
 | --- | :-- |
 ${Object.entries(linter_tags_1.LintingRuleTag).map(([name, tag]) => {
-        return `| <a id="${tag}"></a> ${makeTagBadge(tag, tagTypes.info)} | ${(0, doc_types_1.getDocumentationForType)('LintingRuleTag::' + name, tagTypes.info).replaceAll(/\n/g, ' ')} (rule${getAllLintingRulesWitTag(tag).length === 1 ? '' : 's'}: ${(0, strings_1.joinWithLast)(getAllLintingRulesWitTag(tag).map(l => linkToRule(l))) || '_none_'}) | `;
+        return `| <a id="${tag}"></a> ${(makeTagBadge(tag, tagTypes.info))} | ${(0, doc_types_1.getDocumentationForType)('LintingRuleTag::' + name, tagTypes.info).replaceAll(/\n/g, ' ')} (rule${getAllLintingRulesWithTag(tag).length === 1 ? '' : 's'}: ${(0, strings_1.joinWithLast)(getAllLintingRulesWithTag(tag).map(l => linkToRule(l))) || '_none_'}) | `;
+    }).join('\n')}
+
+${(0, doc_structure_1.section)('Certainty', 2, 'certainty')}
+
+Both linting rules and their individual results are additionally categorized by how certain the linter is that the results it is returning are valid.
+
+${(0, doc_structure_1.section)('Rule Certainty', 3, 'rule-certainty')}
+
+| Rule Certainty | Description |
+| -------------- | :---------- |
+${Object.entries(linter_format_1.LintingRuleCertainty).map(([name, certainty]) => {
+        return `| <a id="${certainty}"></a> \`${certainty}\` | ${(0, doc_types_1.getDocumentationForType)('LintingRuleCertainty::' + name, tagTypes.info).replaceAll(/\n/g, ' ')} (rule${getAllLintingRulesWitCertainty(certainty).length === 1 ? '' : 's'}: ${(0, strings_1.joinWithLast)(getAllLintingRulesWitCertainty(certainty).map(l => linkToRule(l))) || '_none_'}) |`;
     }).join('\n')}
 	
+${(0, doc_structure_1.section)('Result Certainty', 3, 'result-certainty')}
+
+| Result Certainty | Description |
+| ---------------- | :---------- |
+${Object.entries(linter_format_1.LintingResultCertainty).map(([name, certainty]) => `| <a id="${certainty}"></a> \`${certainty}\` | ${(0, doc_types_1.getDocumentationForType)('LintingResultCertainty::' + name, tagTypes.info).replaceAll(/\n/g, ' ')} |`).join('\n')}
+
 `.trim();
 }
 async function getRulesPages(shell, tagTypes, rVersion) {

package/documentation/print-linting-and-testing-wiki.js

@@ -4,16 +4,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const log_1 = require("../../test/functionality/_helper/log");
+const log_2 = require("../util/log");
 const doc_code_1 = require("./doc-util/doc-code");
 const doc_files_1 = require("./doc-util/doc-files");
 const doc_structure_1 = require("./doc-util/doc-structure");
 const doc_types_1 = require("./doc-util/doc-types");
 const path_1 = __importDefault(require("path"));
 const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
+const doc_cli_option_1 = require("./doc-util/doc-cli-option");
 function getText() {
     const { info } = (0, doc_types_1.getTypesFromFolder)({
         rootFolder: path_1.default.resolve('./test'),
-        files: [path_1.default.resolve('./src/dataflow/graph/dataflowgraph-builder.ts')],
+        files: [path_1.default.resolve('./src/dataflow/graph/dataflowgraph-builder.ts'), path_1.default.resolve('./src/util/log.ts'), path_1.default.resolve('./src/slicing/static/static-slicer.ts')],
         typeNameForMermaid: 'parameter',
         inlineTypes: doc_types_1.mermaidHide
     });
@@ -39,6 +41,7 @@ for the latest benchmark results, see the [benchmark results](${doc_files_1.Flow
   - [License Checker](#license-checker)
 - [🐛 Debugging](#debugging)
   - [VS Code](#vs-code-1)
+  - [Logging](#logging)
 
 <a id='testing-suites'></a>
 ## 🏨 Testing Suites
@@ -254,6 +257,15 @@ However, in case you think that the linter is wrong, please do not hesitate to o
 ### VS Code
 When working with VS Code, you can attach a debugger to the REPL. This works automatically by running the \`Start Debugging\` command (\`F5\` by default).
 You can also set the \`Auto Attach Filter\` setting to automatically attach the debugger, when running \`npm run flowr\`.
+
+### Logging
+
+*flowR* uses a wrapper around [tslog](https://www.npmjs.com/package/tslog) using a class named
+${(0, doc_types_1.shortLink)(log_2.FlowrLogger.name, info)}. They obey to, for example, the ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'verbose')}
+option. Throughout *flowR*, we use the \`log\` object (or subloggers of it) for logging.
+To create your own logger, you can use ${(0, doc_types_1.shortLink)(log_2.FlowrLogger.name + '::' + (new log_2.FlowrLogger().getSubLogger.name), info, true, 'i')}.
+For example, check out the ${(0, doc_types_1.shortLink)('slicerLogger', info)} for the static slicer.
+
 `;
 }
 if (require.main === module) {

package/documentation/print-onboarding-wiki.js

@@ -13,6 +13,10 @@ To get started developing on *flowR*, we recommend carefully reading the followi
 - 💖 [Contributing guidelines](${doc_files_1.FlowrGithubBaseRef}/flowr/tree/main/.github/CONTRIBUTING.md).\
   This page also includes information about how to set up **git-lfs** and several **git hooks**.
 
+If you have any questions, please check out the [FAQ](${doc_files_1.FlowrWikiBaseRef}/FAQ) first, but if the question
+is not answered there (or in the wiki in general), feel free to ask a question.  
+	
+
 ## ⌛ TL;DR
 
 The most important steps to get the *flowR* development environment set up (after installing **R** and **Node.js**) can be seen below. For convenience, they can be executed all at once using the following command:

package/documentation/print-query-wiki.js

@@ -36,6 +36,8 @@ 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");
 (0, doc_query_1.registerQueryDocumentation)('call-context', {
     name: 'Call-Context Query',
     type: 'active',
@@ -333,6 +335,22 @@ ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
 This query provides access to the current configuration of the flowR instance. See the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more information on what the configuration represents.`;
     }
 });
+(0, doc_query_1.registerQueryDocumentation)('df-shape', {
+    name: 'Dataframe Shape Inference Query',
+    type: 'active',
+    shortDescription: 'Returns the shapes inferred for all dataframes in the code.',
+    functionName: df_shape_query_executor_1.executeDfShapeQuery.name,
+    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)';
+        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 })}
+`;
+    }
+});
 (0, doc_query_1.registerQueryDocumentation)('compound', {
     name: 'Compound Query',
     type: 'virtual',
@@ -390,15 +408,15 @@ Now, the results no longer contain calls to \`plot\` that are not defined locall
 (0, doc_query_1.registerQueryDocumentation)('static-slice', {
     name: 'Static Slice Query',
     type: 'active',
-    shortDescription: 'Slice the dataflow graph reducing the code to just the parts relevant for the given criteria.',
+    shortDescription: 'Slice the dataflow graph reducing the code to just the parts relevant for the given criteria (backward and forward).',
     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';
         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. 
-Given this, the slice is essentially the subpart of the program that may influence the value of the variables you are interested in.
+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). 
+Given this, the backward slice is essentially the subpart of the program that may influence the value of the variables you are interested in.
 To specify a variable of interest, you have to present flowR with a [slicing criterion](${doc_files_1.FlowrWikiBaseRef}/Terminology#slicing-criterion) (or, respectively, an array of them).
 
 To exemplify the capabilities, consider the following code:
@@ -419,6 +437,14 @@ ${(0, doc_structure_1.details)('No Reconstruction Example', await (0, doc_query_
                 noReconstruction: true
             }], { showCode: false }))}
 
+Likewise, if you want the forward slice for the first use of \`x\`, you can do it like this:
+
+${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
+                type: 'static-slice',
+                criteria: ['1@x'],
+                direction: _00_slice_1.SliceDirection.Forward
+            }], { showCode: false })}
+
 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.
 		`;

package/linter/linter-executor.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeLintingRule = executeLintingRule;
 const linter_rules_1 = require("./linter-rules");
 const flowr_search_executor_1 = require("../search/flowr-search-executor");
-const flowr_search_1 = require("../search/flowr-search");
 const objects_1 = require("../util/objects");
 function executeLintingRule(ruleName, input, lintingRuleConfig) {
     const rule = linter_rules_1.LintingRules[ruleName];
@@ -13,7 +12,7 @@ function executeLintingRule(ruleName, input, lintingRuleConfig) {
     const searchResult = (0, flowr_search_executor_1.runSearch)(ruleSearch, input);
     const searchTime = Date.now() - searchStart;
     const processStart = Date.now();
-    const result = rule.processSearchResult(new flowr_search_1.FlowrSearchElements(searchResult), fullConfig, input);
+    const result = rule.processSearchResult(searchResult, fullConfig, input);
     const processTime = Date.now() - processStart;
     return {
         ...result,

package/linter/linter-format.d.ts

@@ -22,6 +22,10 @@ export interface LinterRuleInformation<Config extends MergeableRecord = never> {
      * A short list of tags that describe and categorize the linting rule.
      */
     readonly tags: readonly LintingRuleTag[];
+    /**
+     * The linting rule's certainty in terms of the rule's calculations' precision and recall.
+     */
+    readonly certainty: LintingRuleCertainty;
     /**
      * A short description of the linting rule.
      * This is used to display the rule in the UI and to provide a brief overview of what the rule does.
@@ -91,7 +95,7 @@ export type LintQuickFix = LintQuickFixReplacement | LintQuickFixRemove;
  * A linting result for a single linting rule match.
  */
 export interface LintingResult {
-    readonly certainty: LintingCertainty;
+    readonly certainty: LintingResultCertainty;
     /**
      * If available, what to do to fix the linting result.
      */
@@ -108,15 +112,33 @@ export interface LintingResults<Name extends LintingRuleNames> {
         readonly processTimeMs: number;
     };
 }
-export declare enum LintingCertainty {
+export declare enum LintingResultCertainty {
     /**
      * The linting rule cannot say for sure whether the result is correct or not.
+     * This linting certainty should be used for linting results whose calculations are based on estimations involving unknown side-effects, reflection, etc.
      */
-    Maybe = "maybe",
+    Uncertain = "uncertain",
     /**
      * The linting rule is certain that the reported lint is real.
+     * This linting certainty should be used for linting results whose calculations do not involve estimates or other unknown factors.
+     */
+    Certain = "certain"
+}
+export declare enum LintingRuleCertainty {
+    /**
+     * Linting rules that are expected to have both high precision and high recall.
+     */
+    Exact = "exact",
+    /**
+     * Linting rules that are expected to have high precision, but not necessarily high recall.
+     * Rules with this certainty generally ensure that the results they return are correct, but may not return all results.
+     */
+    BestEffort = "best-effort",
+    /**
+     * Linting rules that are expected to have high recall, but not necessarily high precision.
+     * Rules with this certainty generally return all relevant results, but may also include some incorrect matches.
      */
-    Definitely = "definitely"
+    OverApproximative = "over-approximative"
 }
 export declare enum LintingPrettyPrintContext {
     Query = "query",

package/linter/linter-format.js

@@ -1,17 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LintingPrettyPrintContext = exports.LintingCertainty = void 0;
-var LintingCertainty;
-(function (LintingCertainty) {
+exports.LintingPrettyPrintContext = exports.LintingRuleCertainty = exports.LintingResultCertainty = void 0;
+var LintingResultCertainty;
+(function (LintingResultCertainty) {
     /**
      * The linting rule cannot say for sure whether the result is correct or not.
+     * This linting certainty should be used for linting results whose calculations are based on estimations involving unknown side-effects, reflection, etc.
      */
-    LintingCertainty["Maybe"] = "maybe";
+    LintingResultCertainty["Uncertain"] = "uncertain";
     /**
      * The linting rule is certain that the reported lint is real.
+     * This linting certainty should be used for linting results whose calculations do not involve estimates or other unknown factors.
      */
-    LintingCertainty["Definitely"] = "definitely";
-})(LintingCertainty || (exports.LintingCertainty = LintingCertainty = {}));
+    LintingResultCertainty["Certain"] = "certain";
+})(LintingResultCertainty || (exports.LintingResultCertainty = LintingResultCertainty = {}));
+var LintingRuleCertainty;
+(function (LintingRuleCertainty) {
+    /**
+     * Linting rules that are expected to have both high precision and high recall.
+     */
+    LintingRuleCertainty["Exact"] = "exact";
+    /**
+     * Linting rules that are expected to have high precision, but not necessarily high recall.
+     * Rules with this certainty generally ensure that the results they return are correct, but may not return all results.
+     */
+    LintingRuleCertainty["BestEffort"] = "best-effort";
+    /**
+     * Linting rules that are expected to have high recall, but not necessarily high precision.
+     * Rules with this certainty generally return all relevant results, but may also include some incorrect matches.
+     */
+    LintingRuleCertainty["OverApproximative"] = "over-approximative";
+})(LintingRuleCertainty || (exports.LintingRuleCertainty = LintingRuleCertainty = {}));
 var LintingPrettyPrintContext;
 (function (LintingPrettyPrintContext) {
     LintingPrettyPrintContext["Query"] = "query";

package/linter/linter-rules.d.ts

@@ -8,7 +8,7 @@ export declare const LintingRules: {
         readonly createSearch: (config: import("./rules/deprecated-functions").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: import("./linter-format").LintingCertainty.Definitely;
+                certainty: import("./linter-format").LintingResultCertainty.Certain;
                 function: import("../dataflow/environments/identifier").Identifier;
                 range: import("../util/range").SourceRange;
             }[];
@@ -21,6 +21,7 @@ export declare const LintingRules: {
         readonly info: {
             readonly name: "Deprecated Functions";
             readonly tags: readonly [import("./linter-tags").LintingRuleTag.Deprecated, import("./linter-tags").LintingRuleTag.Smell, import("./linter-tags").LintingRuleTag.Usability, import("./linter-tags").LintingRuleTag.Reproducibility];
+            readonly certainty: import("./linter-format").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"];
@@ -28,8 +29,8 @@ export declare const LintingRules: {
         };
     };
     readonly 'file-path-validity': {
-        readonly createSearch: (config: import("./rules/file-path-validity").FilePathValidityConfig) => import("../search/flowr-search-builder").FlowrSearchBuilder<"from-query", [], 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").FlowrSearchElementFromQuery<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").FlowrSearchElementFromQuery<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>[]>, config: import("./rules/file-path-validity").FilePathValidityConfig, data: {
+        readonly createSearch: (config: import("./rules/file-path-validity").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: import("./rules/file-path-validity").FilePathValidityConfig, data: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             config: import("../config").FlowrConfigOptions;
@@ -40,6 +41,7 @@ export declare const LintingRules: {
         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: import("./linter-format").LintingRuleCertainty.BestEffort;
             readonly tags: readonly [import("./linter-tags").LintingRuleTag.Robustness, import("./linter-tags").LintingRuleTag.Reproducibility, import("./linter-tags").LintingRuleTag.Bug];
             readonly defaultConfig: {
                 readonly additionalReadFunctions: readonly [];
@@ -53,14 +55,14 @@ export declare const LintingRules: {
         };
     };
     readonly 'seeded-randomness': {
-        readonly createSearch: (config: import("./rules/seeded-randomness").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: import("./rules/seeded-randomness").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: import("./rules/seeded-randomness").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: import("./linter-format").LintingCertainty.Definitely;
+                certainty: import("./linter-format").LintingResultCertainty.Certain;
                 function: import("../dataflow/environments/identifier").Identifier;
                 range: import("../util/range").SourceRange;
             }[];
@@ -78,6 +80,7 @@ export declare const LintingRules: {
                 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 [import("./linter-tags").LintingRuleTag.Robustness, import("./linter-tags").LintingRuleTag.Reproducibility];
+            readonly certainty: import("./linter-format").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`.";
         };
@@ -88,11 +91,7 @@ export declare const LintingRules: {
     };
     readonly 'absolute-file-paths': {
         readonly createSearch: (config: import("./rules/absolute-path").AbsoluteFilePathConfig) => import("../search/flowr-search-builder").FlowrSearchBuilder<"from-query", ["unique"], 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, {
-            readonly query?: "config" | "origin" | "dataflow" | "search" | "call-context" | "control-flow" | "dataflow-lens" | "normalized-ast" | "id-map" | "dataflow-cluster" | "static-slice" | "lineage" | "dependencies" | "location-map" | "happens-before" | "resolve-value" | "project" | "linter" | undefined;
-            readonly queryResult?: import("../queries/base-query-format").BaseQueryResult | undefined;
-            readonly node: import("../r-bridge/lang-4.x/ast/model/nodes/r-expression-list").RExpressionList<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-function-definition").RFunctionDefinition<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-function-call").RNamedFunctionCall<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-function-call").RUnnamedFunctionCall<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-parameter").RParameter<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-argument").RArgument<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-comment").RComment<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-line-directive").RLineDirective<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-for-loop").RForLoop<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-repeat-loop").RRepeatLoop<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-while-loop").RWhileLoop<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-if-then-else").RIfThenElse<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-access").RNamedAccess<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-access").RIndexAccess<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-unary-op").RUnaryOp<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-binary-op").RBinaryOp<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-symbol").RSymbol<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, string> | import("../r-bridge/lang-4.x/ast/model/nodes/r-number").RNumber<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-string").RString<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-logical").RLogical<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-break").RBreak<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-next").RNext<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation> | import("../r-bridge/lang-4.x/ast/model/nodes/r-pipe").RPipe<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>;
-        }[]>, config: import("./rules/absolute-path").AbsoluteFilePathConfig, data: {
+        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: import("./rules/absolute-path").AbsoluteFilePathConfig, data: {
             normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
             dataflow: import("../dataflow/info").DataflowInformation;
             config: import("../config").FlowrConfigOptions;
@@ -108,6 +107,7 @@ export declare const LintingRules: {
             readonly name: "Absolute Paths";
             readonly description: "Checks whether file paths are absolute.";
             readonly tags: readonly [import("./linter-tags").LintingRuleTag.Robustness, import("./linter-tags").LintingRuleTag.Reproducibility, import("./linter-tags").LintingRuleTag.Smell, import("./linter-tags").LintingRuleTag.QuickFix];
+            readonly certainty: import("./linter-format").LintingRuleCertainty.BestEffort;
             readonly defaultConfig: {
                 readonly include: {
                     readonly constructed: true;
@@ -137,6 +137,7 @@ export declare const LintingRules: {
             readonly name: "Unused Definitions";
             readonly description: "Checks for unused definitions.";
             readonly tags: readonly [import("./linter-tags").LintingRuleTag.Readability, import("./linter-tags").LintingRuleTag.Smell, import("./linter-tags").LintingRuleTag.QuickFix];
+            readonly certainty: import("./linter-format").LintingRuleCertainty.BestEffort;
             readonly defaultConfig: {
                 readonly includeFunctionDefinitions: true;
             };
@@ -151,7 +152,7 @@ export declare const LintingRules: {
         }) => {
             results: {
                 quickFix: import("./linter-format").LintQuickFixReplacement[] | undefined;
-                certainty: import("./linter-format").LintingCertainty;
+                certainty: import("./linter-format").LintingResultCertainty;
                 detectedCasing: import("./rules/naming-convention").CasingConvention;
                 name: string;
                 range: import("../util/range").SourceRange;
@@ -167,13 +168,63 @@ 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 tags: readonly [import("./linter-tags").LintingRuleTag.Style, import("./linter-tags").LintingRuleTag.QuickFix];
             readonly defaultConfig: {
-                readonly caseing: import("./rules/naming-convention").CasingConvention.PascalCase;
+                readonly caseing: "auto";
             };
         };
     };
+    readonly 'dataframe-access-validation': {
+        readonly createSearch: () => import("../search/flowr-search-builder").FlowrSearchBuilder<"all", ["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: import("./rules/dataframe-access-validation").DataFrameAccessValidationConfig, data: {
+            normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
+            dataflow: import("../dataflow/info").DataflowInformation;
+            config: import("../config").FlowrConfigOptions;
+        }) => {
+            results: import("./rules/dataframe-access-validation").DataFrameAccessValidationResult[];
+            '.meta': import("./rules/dataframe-access-validation").DataFrameAccessValidationMetadata;
+        };
+        readonly prettyPrint: {
+            readonly query: (result: import("./rules/dataframe-access-validation").DataFrameAccessValidationResult) => string;
+            readonly full: (result: import("./rules/dataframe-access-validation").DataFrameAccessValidationResult) => string;
+        };
+        readonly info: {
+            readonly name: "Dataframe Access Validation";
+            readonly tags: readonly [import("./linter-tags").LintingRuleTag.Bug, import("./linter-tags").LintingRuleTag.Usability, import("./linter-tags").LintingRuleTag.Reproducibility];
+            readonly certainty: import("./linter-format").LintingRuleCertainty.BestEffort;
+            readonly description: "Validates the existance of accessed columns and rows of dataframes.";
+            readonly defaultConfig: {
+                readonly readLoadedData: false;
+            };
+        };
+    };
+    readonly 'dead-code': {
+        readonly createSearch: (config: import("./rules/dead-code").DeadCodeConfig) => import("../search/flowr-search-builder").FlowrSearchBuilder<"all", ["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: import("./rules/dead-code").DeadCodeConfig, _data: {
+            normalize: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
+            dataflow: import("../dataflow/info").DataflowInformation;
+            config: import("../config").FlowrConfigOptions;
+        }) => {
+            results: {
+                certainty: import("./linter-format").LintingResultCertainty.Certain;
+                range: import("../util/range").SourceRange;
+            }[];
+            '.meta': import("./rules/dead-code").DeadCodeMetadata;
+        };
+        readonly prettyPrint: {
+            readonly query: (result: import("./rules/dead-code").DeadCodeResult) => string;
+            readonly full: (result: import("./rules/dead-code").DeadCodeResult) => string;
+        };
+        readonly info: {
+            readonly name: "Dead Code";
+            readonly tags: readonly [import("./linter-tags").LintingRuleTag.Smell, import("./linter-tags").LintingRuleTag.Usability, import("./linter-tags").LintingRuleTag.Reproducibility];
+            readonly certainty: import("./linter-format").LintingRuleCertainty.BestEffort;
+            readonly description: "Marks areas of code that are never reached during execution.";
+            readonly defaultConfig: {};
+        };
+    };
 };
 export type LintingRuleNames = keyof typeof LintingRules;
 export type LintingRuleMetadata<Name extends LintingRuleNames> = typeof LintingRules[Name] extends LintingRule<infer _Result, infer Metadata, infer _Config, infer _Info, infer _Elements> ? Metadata : never;

package/linter/linter-rules.js

@@ -5,8 +5,10 @@ const deprecated_functions_1 = require("./rules/deprecated-functions");
 const file_path_validity_1 = require("./rules/file-path-validity");
 const absolute_path_1 = require("./rules/absolute-path");
 const unused_definition_1 = require("./rules/unused-definition");
+const dead_code_1 = require("./rules/dead-code");
 const seeded_randomness_1 = require("./rules/seeded-randomness");
 const naming_convention_1 = require("./rules/naming-convention");
+const dataframe_access_validation_1 = require("./rules/dataframe-access-validation");
 /**
  * The registry of currently supported linting rules.
  * A linting rule can be executed on a dataflow pipeline result using {@link executeLintingRule}.
@@ -17,6 +19,8 @@ exports.LintingRules = {
     'seeded-randomness': seeded_randomness_1.SEEDED_RANDOMNESS,
     'absolute-file-paths': absolute_path_1.ABSOLUTE_PATH,
     'unused-definitions': unused_definition_1.UNUSED_DEFINITION,
-    'naming-convention': naming_convention_1.NAMING_CONVENTION
+    'naming-convention': naming_convention_1.NAMING_CONVENTION,
+    'dataframe-access-validation': dataframe_access_validation_1.DATA_FRAME_ACCESS_VALIDATION,
+    'dead-code': dead_code_1.DEAD_CODE,
 };
 //# sourceMappingURL=linter-rules.js.map

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

@@ -1,9 +1,9 @@
 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';
 import type { FunctionInfo } from '../../queries/catalog/dependencies-query/function-info/function-info';
-import type { ParentInformation } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { FlowrConfigOptions } from '../../config';
 export interface AbsoluteFilePathResult extends LintingResult {
     filePath: string;
@@ -36,12 +36,8 @@ export interface AbsoluteFilePathMetadata extends MergeableRecord {
     totalUnknown: number;
 }
 export declare const ABSOLUTE_PATH: {
-    readonly createSearch: (config: AbsoluteFilePathConfig) => import("../../search/flowr-search-builder").FlowrSearchBuilder<"from-query", ["unique"], ParentInformation, import("../../search/flowr-search").FlowrSearchElements<ParentInformation, import("../../search/flowr-search").FlowrSearchElement<ParentInformation>[]>>;
-    readonly processSearchResult: (elements: import("../../search/flowr-search").FlowrSearchElements<ParentInformation, {
-        readonly query?: "config" | "origin" | "dataflow" | "search" | "call-context" | "control-flow" | "dataflow-lens" | "normalized-ast" | "id-map" | "dataflow-cluster" | "static-slice" | "lineage" | "dependencies" | "location-map" | "happens-before" | "resolve-value" | "project" | "linter" | undefined;
-        readonly queryResult?: import("../../queries/base-query-format").BaseQueryResult | undefined;
-        readonly node: import("../../r-bridge/lang-4.x/ast/model/nodes/r-expression-list").RExpressionList<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-function-definition").RFunctionDefinition<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-function-call").RNamedFunctionCall<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-function-call").RUnnamedFunctionCall<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-parameter").RParameter<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-argument").RArgument<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-comment").RComment<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-line-directive").RLineDirective<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-for-loop").RForLoop<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-repeat-loop").RRepeatLoop<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-while-loop").RWhileLoop<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-if-then-else").RIfThenElse<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-access").RNamedAccess<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-access").RIndexAccess<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-unary-op").RUnaryOp<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-binary-op").RBinaryOp<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-symbol").RSymbol<ParentInformation, string> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-number").RNumber<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-string").RString<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-logical").RLogical<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-break").RBreak<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-next").RNext<ParentInformation> | import("../../r-bridge/lang-4.x/ast/model/nodes/r-pipe").RPipe<ParentInformation>;
-    }[]>, config: AbsoluteFilePathConfig, data: {
+    readonly createSearch: (config: AbsoluteFilePathConfig) => import("../../search/flowr-search-builder").FlowrSearchBuilder<"from-query", ["unique"], 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: AbsoluteFilePathConfig, data: {
         normalize: import("../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
         dataflow: import("../../dataflow/info").DataflowInformation;
         config: FlowrConfigOptions;
@@ -57,6 +53,7 @@ export declare const ABSOLUTE_PATH: {
         readonly name: "Absolute Paths";
         readonly description: "Checks whether file paths are absolute.";
         readonly tags: readonly [LintingRuleTag.Robustness, LintingRuleTag.Reproducibility, LintingRuleTag.Smell, LintingRuleTag.QuickFix];
+        readonly certainty: LintingRuleCertainty.BestEffort;
         readonly defaultConfig: {
             readonly include: {
                 readonly constructed: true;