@abaplint/core 2.103.10 → 2.104.0

package/build/src/registry.js

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

package/build/src/rules/index.js

@@ -129,6 +129,7 @@ __exportStar(require("./prefer_returning_to_exporting"), exports);
 __exportStar(require("./prefer_xsdbool"), exports);
 __exportStar(require("./preferred_compare_operator"), exports);
 __exportStar(require("./prefix_is_current_class"), exports);
+__exportStar(require("./reduce_procedural_code"), exports);
 __exportStar(require("./reduce_string_templates"), exports);
 __exportStar(require("./release_idoc"), exports);
 __exportStar(require("./remove_descriptions"), exports);

package/build/src/rules/reduce_procedural_code.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReduceProceduralCode = exports.ReduceProceduralCodeConf = void 0;
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _abap_rule_1 = require("./_abap_rule");
+const _irule_1 = require("./_irule");
+const Statements = require("../abap/2_statements/statements");
+const issue_1 = require("../issue");
+class ReduceProceduralCodeConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        this.maxStatements = 10;
+    }
+}
+exports.ReduceProceduralCodeConf = ReduceProceduralCodeConf;
+class ReduceProceduralCode extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new ReduceProceduralCodeConf();
+    }
+    getMetadata() {
+        return {
+            key: "reduce_procedural_code",
+            title: "Reduce procedural code",
+            shortDescription: `Checks FORM and FUNCTION-MODULE have few statements`,
+            extendedInformation: `Delegate logic to a class method instead of using FORM or FUNCTION-MODULE.
+
+Only one issue is reported per include/file.
+
+https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-object-orientation-to-procedural-programming`,
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
+            badExample: `FORM foo.
+  DATA lv_bar TYPE i.
+  lv_bar = 2 + 2.
+  IF lv_bar = 4.
+    WRITE 'hello world'.
+  ENDIF.
+  DATA lv_bar TYPE i.
+  lv_bar = 2 + 2.
+  IF lv_bar = 4.
+    WRITE 'hello world'.
+  ENDIF.
+ENDFORM.`,
+            goodExample: `FORM foo.
+  NEW zcl_global_class( )->run_logic( ).
+ENDFORM.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file) {
+        const issues = [];
+        if (file.getStructure() === undefined) {
+            // constains syntax errors, skip this check
+            return issues;
+        }
+        let doCount = undefined;
+        let count = 0;
+        for (const statement of file.getStatements()) {
+            if (statement.get() instanceof Statements.Form || statement.get() instanceof Statements.FunctionModule) {
+                doCount = statement;
+                count = 0;
+            }
+            else if (statement.get() instanceof Statements.EndForm || statement.get() instanceof Statements.EndFunction) {
+                if (count >= this.conf.maxStatements && doCount !== undefined) {
+                    const message = "Reduce procedural code, max " + this.conf.maxStatements + " statements";
+                    const issue = issue_1.Issue.atStatement(file, doCount, message, this.getMetadata().key, this.conf.severity);
+                    issues.push(issue);
+                }
+                doCount = undefined;
+            }
+            else if (doCount !== undefined) {
+                count = count + 1;
+            }
+        }
+        return issues;
+    }
+}
+exports.ReduceProceduralCode = ReduceProceduralCode;
+//# sourceMappingURL=reduce_procedural_code.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.103.10",
+    "version": "2.104.0",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",
@@ -53,7 +53,7 @@
         "@microsoft/api-extractor": "^7.38.3",
         "@types/chai": "^4.3.11",
         "@types/mocha": "^10.0.6",
-        "@types/node": "^20.10.0",
+        "@types/node": "^20.10.1",
         "chai": "^4.3.10",
         "eslint": "^8.54.0",
         "mocha": "^10.2.0",