@abaplint/core 2.104.6 → 2.105.0

package/build/src/registry.js

@@ -65,7 +65,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.104.6";
+        return "2.105.0";
     }
     getDDICReferences() {
         return this.ddicReferences;

package/build/src/rules/index.js

@@ -108,6 +108,7 @@ __exportStar(require("./no_aliases"), exports);
 __exportStar(require("./no_chained_assignment"), exports);
 __exportStar(require("./no_external_form_calls"), exports);
 __exportStar(require("./no_inline_in_optional_branches"), exports);
+__exportStar(require("./no_prefixes"), exports);
 __exportStar(require("./no_public_attributes"), exports);
 __exportStar(require("./no_yoda_conditions"), exports);
 __exportStar(require("./nrob_consistency"), exports);

package/build/src/rules/no_prefixes.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoPrefixes = exports.NoPrefixesConf = void 0;
+const issue_1 = require("../issue");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _abap_rule_1 = require("./_abap_rule");
+const Expressions = require("../abap/2_statements/expressions");
+const Statements = require("../abap/2_statements/statements");
+const _irule_1 = require("./_irule");
+class NoPrefixesConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        /** DATA, CLASS-DATA, DATA BEGIN OF, CLASS-DATA BEGIN OF, FINAL(), DATA(), case insensitive regex */
+        this.data = "^[lg]._";
+        /** STATICS, STATICS BEGIN OF, case insensitive regex */
+        this.statics = "";
+        /** FIELD-SYMBOLS and inline FIELD-SYMBOLS(), case insensitive regex */
+        this.fieldSymbols = "^<l._";
+        /** CONSTANTS, CONSTANTS BEGIN OF, case insensitive regex */
+        this.constants = "^[lg]c_";
+        /** TYPES, ENUM, MESH, case insensitive regex */
+        this.types = "^ty_";
+        /** importing, exporting, returning and changing parameters, case insensitive regex */
+        this.methodParameters = "^[ierc]._";
+        // todo, public localClass: string = "";
+        // todo, public localInterface: string = "";
+        // todo, public functionModuleParameters: string = "";
+        // todo, public parameters: string = "";
+        // todo, public selectOptions: string = "";
+        // todo, public formParameters: string = "";
+    }
+}
+exports.NoPrefixesConf = NoPrefixesConf;
+const MESSAGE = "Avoid hungarian notation";
+class NoPrefixes extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new NoPrefixesConf();
+    }
+    getMetadata() {
+        return {
+            key: "no_prefixes",
+            title: "No Prefixes",
+            shortDescription: `Dont use hungarian notation`,
+            extendedInformation: `
+https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-encodings-esp-hungarian-notation-and-prefixes
+
+https://github.com/SAP/styleguides/blob/main/clean-abap/sub-sections/AvoidEncodings.md`,
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
+            badExample: `DATA lv_foo TYPE i.`,
+            goodExample: `DATA foo TYPE i.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file) {
+        const ret = [];
+        const config = this.getConfig();
+        const structure = file.getStructure();
+        if (structure === undefined) {
+            // syntax error, skip
+            return [];
+        }
+        if (config.data !== undefined && config.data !== "") {
+            ret.push(...this.checkData(structure, new RegExp(config.data, "i"), file));
+        }
+        if (config.statics !== undefined && config.statics !== "") {
+            ret.push(...this.checkStatics(structure, new RegExp(config.statics, "i"), file));
+        }
+        if (config.fieldSymbols !== undefined && config.fieldSymbols !== "") {
+            ret.push(...this.checkFieldSymbols(structure, new RegExp(config.fieldSymbols, "i"), file));
+        }
+        if (config.constants !== undefined && config.constants !== "") {
+            ret.push(...this.checkConstants(structure, new RegExp(config.constants, "i"), file));
+        }
+        if (config.types !== undefined && config.types !== "") {
+            ret.push(...this.checkTypes(structure, new RegExp(config.types, "i"), file));
+        }
+        if (config.methodParameters !== undefined && config.methodParameters !== "") {
+            ret.push(...this.checkMethodParameters(structure, new RegExp(config.methodParameters, "i"), file));
+        }
+        return ret;
+    }
+    checkData(topNode, regex, file) {
+        var _a, _b, _c;
+        const ret = [];
+        for (const data of topNode.findAllStatements(Statements.Data).concat(topNode.findAllStatements(Statements.DataBegin)).concat(topNode.findAllStatements(Statements.ClassDataBegin)).concat(topNode.findAllStatements(Statements.ClassData))) {
+            let name = ((_a = data.findFirstExpression(Expressions.DefinitionName)) === null || _a === void 0 ? void 0 : _a.concatTokens()) || "";
+            if (name === "") {
+                name = ((_b = data.findFirstExpression(Expressions.NamespaceSimpleName)) === null || _b === void 0 ? void 0 : _b.concatTokens()) || "";
+            }
+            if (name !== "" && name.match(regex)) {
+                const issue = issue_1.Issue.atToken(file, data.getFirstToken(), MESSAGE, this.getMetadata().key, this.conf.severity);
+                ret.push(issue);
+            }
+        }
+        for (const data of topNode.findAllExpressions(Expressions.InlineData)) {
+            const name = ((_c = data.findFirstExpression(Expressions.TargetField)) === null || _c === void 0 ? void 0 : _c.concatTokens()) || "";
+            if (name !== "" && name.match(regex)) {
+                const issue = issue_1.Issue.atToken(file, data.getFirstToken(), MESSAGE, this.getMetadata().key, this.conf.severity);
+                ret.push(issue);
+            }
+        }
+        return ret;
+    }
+    checkStatics(topNode, regex, file) {
+        var _a;
+        const ret = [];
+        for (const data of topNode.findAllStatements(Statements.Static).concat(topNode.findAllStatements(Statements.StaticBegin))) {
+            const name = ((_a = data.findFirstExpression(Expressions.DefinitionName)) === null || _a === void 0 ? void 0 : _a.concatTokens()) || "";
+            if (name !== "" && name.match(regex)) {
+                const issue = issue_1.Issue.atToken(file, data.getFirstToken(), MESSAGE, this.getMetadata().key, this.conf.severity);
+                ret.push(issue);
+            }
+        }
+        return ret;
+    }
+    checkFieldSymbols(topNode, regex, file) {
+        var _a, _b;
+        const ret = [];
+        for (const data of topNode.findAllStatements(Statements.FieldSymbol)) {
+            const name = ((_a = data.findFirstExpression(Expressions.FieldSymbol)) === null || _a === void 0 ? void 0 : _a.concatTokens()) || "";
+            if (name !== "" && name.match(regex)) {
+                const issue = issue_1.Issue.atToken(file, data.getFirstToken(), MESSAGE, this.getMetadata().key, this.conf.severity);
+                ret.push(issue);
+            }
+        }
+        for (const data of topNode.findAllExpressions(Expressions.InlineFS)) {
+            const name = ((_b = data.findFirstExpression(Expressions.FieldSymbol)) === null || _b === void 0 ? void 0 : _b.concatTokens()) || "";
+            if (name !== "" && name.match(regex)) {
+                const issue = issue_1.Issue.atToken(file, data.getFirstToken(), MESSAGE, this.getMetadata().key, this.conf.severity);
+                ret.push(issue);
+            }
+        }
+        return ret;
+    }
+    checkConstants(topNode, regex, file) {
+        var _a;
+        const ret = [];
+        for (const data of topNode.findAllStatements(Statements.Constant).concat(topNode.findAllStatements(Statements.ConstantBegin))) {
+            const name = ((_a = data.findFirstExpression(Expressions.DefinitionName)) === null || _a === void 0 ? void 0 : _a.concatTokens()) || "";
+            if (name !== "" && name.match(regex)) {
+                const issue = issue_1.Issue.atToken(file, data.getFirstToken(), MESSAGE, this.getMetadata().key, this.conf.severity);
+                ret.push(issue);
+            }
+        }
+        return ret;
+    }
+    checkTypes(topNode, regex, file) {
+        var _a;
+        const ret = [];
+        for (const data of topNode.findAllStatements(Statements.Type).concat(topNode.findAllStatements(Statements.TypeEnum)).concat(topNode.findAllStatements(Statements.TypeEnumBegin)).concat(topNode.findAllStatements(Statements.TypeMesh)).concat(topNode.findAllStatements(Statements.TypeMeshBegin)).concat(topNode.findAllStatements(Statements.TypeBegin))) {
+            const name = ((_a = data.findFirstExpression(Expressions.NamespaceSimpleName)) === null || _a === void 0 ? void 0 : _a.concatTokens()) || "";
+            if (name !== "" && name.match(regex)) {
+                const issue = issue_1.Issue.atToken(file, data.getFirstToken(), MESSAGE, this.getMetadata().key, this.conf.severity);
+                ret.push(issue);
+            }
+        }
+        return ret;
+    }
+    checkMethodParameters(topNode, regex, file) {
+        const ret = [];
+        for (const method of topNode.findAllStatements(Statements.MethodDef)) {
+            for (const def of method.findAllExpressions(Expressions.MethodParamName)) {
+                const name = def.concatTokens();
+                if (name !== "" && name.match(regex)) {
+                    const issue = issue_1.Issue.atToken(file, method.getFirstToken(), MESSAGE, this.getMetadata().key, this.conf.severity);
+                    ret.push(issue);
+                }
+            }
+        }
+        return ret;
+    }
+}
+exports.NoPrefixes = NoPrefixes;
+//# sourceMappingURL=no_prefixes.js.map

package/package.json

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