@abaplint/core 2.107.0 → 2.107.2

package/build/src/registry.js

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

package/build/src/rules/7bit_ascii.js

@@ -23,6 +23,8 @@ https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abencharacter_set_gui
 
 Checkes files with extensions ".abap" and ".asddls"`,
             tags: [_irule_1.RuleTag.SingleFile],
+            badExample: `WRITE '뽑'.`,
+            goodExample: `WRITE cl_abap_conv_in_ce=>uccp( 'BF51' ).`,
         };
     }
     initialize(_reg) {

package/build/src/rules/align_type_expressions.js

@@ -1,17 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AlignTypeExpressions = exports.AlignTypeExpressionsConf = void 0;
-const issue_1 = require("../issue");
 const _abap_rule_1 = require("./_abap_rule");
 const _basic_rule_config_1 = require("./_basic_rule_config");
+const objects_1 = require("../objects");
+const ddic_1 = require("../ddic");
 const _irule_1 = require("./_irule");
-const Structures = require("../abap/3_structures/structures");
-const Statements = require("../abap/2_statements/statements");
+const issue_1 = require("../issue");
+const position_1 = require("../position");
 const Expressions = require("../abap/2_statements/expressions");
-/*
-import {EditHelper, IEdit} from "../edit_helper";
-*/
+const Statements = require("../abap/2_statements/statements");
+const Structures = require("../abap/3_structures/structures");
+const edit_helper_1 = require("../edit_helper");
 class AlignTypeExpressionsConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        /** Ignore global exception classes */
+        this.ignoreExceptions = true;
+    }
 }
 exports.AlignTypeExpressionsConf = AlignTypeExpressionsConf;
 class AlignTypeExpressions extends _abap_rule_1.ABAPRule {
@@ -27,9 +33,11 @@ class AlignTypeExpressions extends _abap_rule_1.ABAPRule {
             extendedInformation: `
 Currently works for METHODS + BEGIN OF
 
+If BEGIN OF has an INCLUDE TYPE its ignored
+
 Also note that clean ABAP does not recommend aligning TYPE clauses:
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-align-type-clauses`,
-            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace],
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix],
             badExample: `
 TYPES: BEGIN OF foo,
          bar TYPE i,
@@ -62,16 +70,45 @@ ENDINTERFACE.`,
     setConfig(conf) {
         this.conf = conf;
     }
-    runParsed(file) {
+    runParsed(file, obj) {
         const issues = [];
         const stru = file.getStructure();
         if (stru === undefined) {
             return issues; // parser error
         }
+        const ddic = new ddic_1.DDIC(this.reg);
+        if (obj instanceof objects_1.Class) {
+            const definition = obj.getClassDefinition();
+            if (definition === undefined) {
+                return [];
+            }
+            else if (this.conf.ignoreExceptions && ddic.isException(definition, obj)) {
+                return [];
+            }
+        }
         issues.push(...this.checkTypes(stru, file));
         issues.push(...this.checkMethods(stru, file));
         return issues;
     }
+    check(fields, column, file) {
+        const issues = [];
+        for (const f of fields) {
+            if (f.after.getCol() === column) {
+                continue;
+            }
+            let fix = undefined;
+            if (f.after.getCol() < column) {
+                fix = edit_helper_1.EditHelper.insertAt(file, f.after, " ".repeat(column - f.after.getCol()));
+            }
+            else {
+                fix = edit_helper_1.EditHelper.deleteRange(file, new position_1.Position(f.after.getRow(), column), f.after);
+            }
+            const message = `Align TYPE expressions to column ${column}`;
+            const issue = issue_1.Issue.atPosition(file, f.after, message, this.getMetadata().key, this.conf.severity, fix);
+            issues.push(issue);
+        }
+        return issues;
+    }
     checkMethods(stru, file) {
         const issues = [];
         const methods = stru.findAllStatements(Statements.MethodDef);
@@ -98,14 +135,7 @@ ENDINTERFACE.`,
                 });
                 column = Math.max(column, name.getLastToken().getEnd().getCol() + 1);
             }
-            for (const f of fields) {
-                if (f.after.getCol() !== column) {
-                    //          const fix = this.buildFix(f.name, column);
-                    const message = `Align TYPE expressions to column ${column}`;
-                    const issue = issue_1.Issue.atPosition(file, f.after, message, this.getMetadata().key, this.conf.severity);
-                    issues.push(issue);
-                }
-            }
+            issues.push(...this.check(fields, column, file));
         }
         return issues;
     }
@@ -113,6 +143,9 @@ ENDINTERFACE.`,
         const issues = [];
         const types = stru.findAllStructuresRecursive(Structures.Types);
         for (const t of types) {
+            if (t.findDirectStatement(Statements.IncludeType)) {
+                continue;
+            }
             const fields = [];
             let column = 0;
             const st = t.findDirectStatements(Statements.Type);
@@ -124,14 +157,7 @@ ENDINTERFACE.`,
                 });
                 column = Math.max(column, name.getFirstToken().getEnd().getCol() + 1);
             }
-            for (const f of fields) {
-                if (f.after.getCol() !== column) {
-                    //          const fix = this.buildFix(f.name, column);
-                    const message = `Align TYPE expressions to column ${column}`;
-                    const issue = issue_1.Issue.atPosition(file, f.after, message, this.getMetadata().key, this.conf.severity);
-                    issues.push(issue);
-                }
-            }
+            issues.push(...this.check(fields, column, file));
         }
         return issues;
     }

package/build/src/rules/begin_single_include.js

@@ -33,7 +33,8 @@ STATICS BEGIN OF bar.
 INCLUDE STRUCTURE syst.
 STATICS END OF bar.`,
             goodExample: `DATA BEGIN OF foo.
-INCLUDE STRUCTURE dselc.
+  DATA field TYPE i.
+  INCLUDE STRUCTURE dselc.
 DATA END OF foo.`,
         };
     }

package/build/src/rules/commented_code.js

@@ -33,6 +33,7 @@ class CommentedCode extends _abap_rule_1.ABAPRule {
             extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#delete-code-instead-of-commenting-it
 https://docs.abapopenchecks.org/checks/14/`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
+            badExample: `* WRITE 'hello world'.`,
         };
     }
     getMessage() {

package/build/src/rules/contains_tab.js

@@ -29,6 +29,8 @@ class ContainsTab extends _abap_rule_1.ABAPRule {
 https://docs.abapopenchecks.org/checks/09/
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#indent-and-snap-to-tab`,
             tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
+            badExample: `\tWRITE 'hello world'.`,
+            goodExample: `  WRITE 'hello world'.`,
         };
     }
     getMessage() {

package/build/src/rules/empty_statement.js

@@ -22,6 +22,8 @@ class EmptyStatement extends _abap_rule_1.ABAPRule {
             title: "Remove empty statement",
             shortDescription: `Checks for empty statements (an empty statement is a single dot)`,
             tags: [_irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
+            badExample: `WRITE 'hello world'..`,
+            goodExample: `WRITE 'hello world'.`,
         };
     }
     getConfig() {

package/build/src/rules/indentation.js

@@ -39,6 +39,24 @@ class Indentation extends _abap_rule_1.ABAPRule {
             title: "Indentation",
             shortDescription: `Checks indentation`,
             tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
+            badExample: `CLASS lcl DEFINITION.
+PRIVATE SECTION.
+METHODS constructor.
+ENDCLASS.
+
+CLASS lcl IMPLEMENTATION.
+METHOD constructor.
+ENDMETHOD.
+ENDCLASS.`,
+            goodExample: `CLASS lcl DEFINITION.
+  PRIVATE SECTION.
+    METHODS constructor.
+ENDCLASS.
+
+CLASS lcl IMPLEMENTATION.
+  METHOD constructor.
+  ENDMETHOD.
+ENDCLASS.`,
         };
     }
     getConfig() {

package/build/src/rules/keyword_case.js

@@ -113,6 +113,8 @@ class KeywordCase extends _abap_rule_1.ABAPRule {
             shortDescription: `Checks that keywords have the same case. Non-keywords must be lower case.`,
             extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-your-pretty-printer-team-settings`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
+            badExample: `write 'hello world'.`,
+            goodExample: `WRITE 'hello world'.`,
         };
     }
     getConfig() {

package/build/src/rules/local_variable_names.js

@@ -34,6 +34,12 @@ class LocalVariableNames extends _abap_rule_1.ABAPRule {
 Allows you to enforce a pattern, such as a prefix, for local variables, constants and field symbols.
 Regexes are case-insensitive.`,
             tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile],
+            badExample: `FORM bar.
+  DATA foo.
+ENDFORM.`,
+            goodExample: `FORM bar.
+  DATA lv_foo.
+ENDFORM.`,
         };
     }
     getDescription(expected, actual) {

package/build/src/rules/method_overwrites_builtin.js

@@ -25,6 +25,15 @@ https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-obscu
 
 Interface method names are ignored`,
             tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
+            badExample: `CLASS lcl DEFINITION.
+  PUBLIC SECTION.
+    METHODS matches.
+ENDCLASS.
+
+CLASS lcl IMPLEMENTATION.
+  METHOD matches.
+  ENDMETHOD.
+ENDCLASS.`,
         };
     }
     getConfig() {

package/build/src/rules/mix_returning.js

@@ -23,6 +23,13 @@ class MixReturning extends _abap_rule_1.ABAPRule {
             // eslint-disable-next-line max-len
             extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-either-returning-or-exporting-or-changing-but-not-a-combination`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
+            badExample: `CLASS lcl DEFINITION.
+  PUBLIC SECTION.
+    METHODS
+      foobar
+        EXPORTING foo TYPE i
+        RETURNING VALUE(rv_string) TYPE string.
+ENDCLASS.`,
         };
     }
     getMessage() {

package/build/src/rules/prefer_returning_to_exporting.js

@@ -23,6 +23,10 @@ class PreferReturningToExporting extends _abap_rule_1.ABAPRule {
             extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-returning-to-exporting
 https://docs.abapopenchecks.org/checks/44/`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
+            badExample: `CLASS lcl DEFINITION.
+  PUBLIC SECTION.
+    METHODS test EXPORTING ev_foo TYPE i.
+ENDCLASS.`,
         };
     }
     getConfig() {

package/build/src/rules/preferred_compare_operator.js

@@ -27,6 +27,10 @@ class PreferredCompareOperator extends _abap_rule_1.ABAPRule {
             title: "Preferred compare operator",
             shortDescription: `Configure undesired operator variants`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
+            badExample: `IF foo EQ bar.
+ENDIF.`,
+            goodExample: `IF foo = bar.
+ENDIF.`,
         };
     }
     getDescription(operator) {

package/build/src/rules/select_add_order_by.js

@@ -32,6 +32,8 @@ add ORDER BY PRIMARY KEY if in doubt
 
 If the target is a sorted/hashed table, no issue is reported`,
             tags: [_irule_1.RuleTag.SingleFile],
+            badExample: `SELECT * FROM db INTO TABLE @DATA(tab).`,
+            goodExample: `SELECT * FROM db INTO TABLE @DATA(tab) ORDER BY PRIMARY KEY.`,
         };
     }
     getConfig() {

package/build/src/rules/types_naming.js

@@ -28,6 +28,8 @@ class TypesNaming extends _abap_rule_1.ABAPRule {
             shortDescription: `Allows you to enforce a pattern for TYPES definitions`,
             extendedInformation: `Does not run for TYPE POOLS`,
             tags: [_irule_1.RuleTag.Naming, _irule_1.RuleTag.SingleFile],
+            badExample: `TYPES foo TYPE i.`,
+            goodExample: `TYPES ty_foo TYPE i.`,
         };
     }
     getConfig() {

package/build/src/rules/use_class_based_exceptions.js

@@ -22,6 +22,16 @@ class UseClassBasedExceptions extends _abap_rule_1.ABAPRule {
             shortDescription: `Use class based exceptions, checks interface and class definitions`,
             extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-class-based-exceptions`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
+            badExample: `INTERFACE lif.
+  METHODS load_data
+    EXCEPTIONS
+      invalid_parameter.
+ENDINTERFACE.`,
+            goodExample: `INTERFACE lif.
+  METHODS load_data
+    RAISING
+      cx_something.
+ENDINTERFACE.`,
         };
     }
     getMessage() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.107.0",
+    "version": "2.107.2",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",
@@ -51,9 +51,9 @@
     "homepage": "https://abaplint.org",
     "devDependencies": {
         "@microsoft/api-extractor": "^7.43.1",
-        "@types/chai": "^4.3.14",
+        "@types/chai": "^4.3.15",
         "@types/mocha": "^10.0.6",
-        "@types/node": "^20.12.7",
+        "@types/node": "^20.12.8",
         "chai": "^4.4.1",
         "eslint": "^8.57.0",
         "mocha": "^10.4.0",