@abaplint/core 2.107.1 → 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.1";
+        return "2.107.2";
     }
     getDDICReferences() {
         return this.ddicReferences;

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.1",
+    "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",