@abaplint/core 2.120.72 → 2.120.73

package/build/src/registry.js

@@ -75,7 +75,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.js"
-        return "2.120.72";
+        return "2.120.73";
     }
     getDDICReferences() {
         return this.ddicReferences;

package/build/src/rules/generic_regex.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenericRegex = exports.GenericRegexConf = void 0;
+const issue_1 = require("../issue");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _irule_1 = require("./_irule");
+class GenericRegexConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        /** List of forbidden regular expressions, case insensitive, checked against each line of every file.
+         * Patterns use JavaScript regex syntax without enclosing slashes or flags.
+         * @uniqueItems true
+         */
+        this.regexes = [];
+    }
+}
+exports.GenericRegexConf = GenericRegexConf;
+class GenericRegex {
+    constructor() {
+        this.conf = new GenericRegexConf();
+        this.regexes = [];
+    }
+    getMetadata() {
+        return {
+            key: "generic_regex",
+            title: "Generic regex",
+            shortDescription: "Report an issue for each match of a configured regular expression.",
+            extendedInformation: `Checks each line of every object file, including comments, strings, and XML.
+Patterns use JavaScript regular expression syntax without enclosing slashes or flags.
+Matching is case insensitive and does not span multiple lines. Each non-overlapping match is reported.
+Use the standard exclude configuration to skip files.
+
+Example configuration: \`{"generic_regex": {"regexes": ["TODO", "BREAK-POINT"]}}\``,
+            tags: [_irule_1.RuleTag.SingleFile],
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        var _a;
+        this.conf = Object.assign(new GenericRegexConf(), conf);
+        this.conf.regexes = (_a = this.conf.regexes) !== null && _a !== void 0 ? _a : [];
+    }
+    initialize(_reg) {
+        this.regexes = this.conf.regexes.map(pattern => {
+            try {
+                return new RegExp(pattern, "gi");
+            }
+            catch (_a) {
+                throw new Error(`generic_regex: Invalid regular expression "${pattern}"`);
+            }
+        });
+        return this;
+    }
+    run(obj) {
+        const issues = [];
+        if (this.regexes.length === 0) {
+            return issues;
+        }
+        for (const file of obj.getFiles()) {
+            const rows = file.getRawRows();
+            for (let row = 0; row < rows.length; row++) {
+                const text = rows[row].replace(/\r$/, "");
+                for (const regex of this.regexes) {
+                    regex.lastIndex = 0;
+                    for (;;) {
+                        const match = regex.exec(text);
+                        if (match === null) {
+                            break;
+                        }
+                        const startCol = match.index + 1;
+                        const message = `Text matches forbidden regular expression "${regex.source}"`;
+                        issues.push(issue_1.Issue.atRowRange(file, row + 1, startCol, startCol + match[0].length, message, this.getMetadata().key, this.conf.severity));
+                        if (match[0].length === 0) {
+                            regex.lastIndex++;
+                        }
+                    }
+                }
+            }
+        }
+        return issues;
+    }
+}
+exports.GenericRegex = GenericRegex;
+//# sourceMappingURL=generic_regex.js.map

package/build/src/rules/index.js

@@ -82,6 +82,7 @@ __exportStar(require("./fully_type_constants"), exports);
 __exportStar(require("./fully_type_itabs"), exports);
 __exportStar(require("./function_module_recommendations"), exports);
 __exportStar(require("./functional_writing"), exports);
+__exportStar(require("./generic_regex"), exports);
 __exportStar(require("./global_class"), exports);
 __exportStar(require("./identical_conditions"), exports);
 __exportStar(require("./identical_contents"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.120.72",
+    "version": "2.120.73",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",