@abaplint/core 2.85.34 → 2.85.37

package/build/src/rules/downport.js

@@ -19,6 +19,8 @@ const _typed_identifier_1 = require("../abap/types/_typed_identifier");
 const basic_1 = require("../abap/types/basic");
 const config_1 = require("../config");
 const tokens_1 = require("../abap/1_lexer/tokens");
+const include_graph_1 = require("../utils/include_graph");
+const objects_1 = require("../objects");
 // todo: refactor each sub-rule to new classes?
 // todo: add configuration
 class DownportConf extends _basic_rule_config_1.BasicRuleConfig {
@@ -33,33 +35,33 @@ class Downport {
             key: "downport",
             title: "Downport statement",
             shortDescription: `Experimental downport functionality`,
-            extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
-a higher level language version. If successful, various rules are applied to downport the statement.
-Target downport version is always v702, thus rule is only enabled if target version is v702.
-
-Current rules:
-* NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
-* DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
-* FIELD-SYMBOL() definitions are outlined
-* CONV is outlined
-* COND is outlined
-* REDUCE is outlined
-* SWITCH is outlined
-* APPEND expression is outlined
-* EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
-* CAST changed to ?=
-* LOOP AT method_call( ) is outlined
-* VALUE # with structure fields
-* VALUE # with internal table lines
-* Table Expressions are outlined
-* SELECT INTO @DATA definitions are outlined
-* Some occurrences of string template formatting option ALPHA changed to function module call
-* SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
-* PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
-* RAISE EXCEPTION ... MESSAGE
-* Moving with +=, -=, /=, *=, &&= is expanded
-* line_exists and line_index is downported to READ TABLE
-
+            extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
+a higher level language version. If successful, various rules are applied to downport the statement.
+Target downport version is always v702, thus rule is only enabled if target version is v702.
+
+Current rules:
+* NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
+* DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
+* FIELD-SYMBOL() definitions are outlined
+* CONV is outlined
+* COND is outlined
+* REDUCE is outlined
+* SWITCH is outlined
+* APPEND expression is outlined
+* EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
+* CAST changed to ?=
+* LOOP AT method_call( ) is outlined
+* VALUE # with structure fields
+* VALUE # with internal table lines
+* Table Expressions are outlined
+* SELECT INTO @DATA definitions are outlined
+* Some occurrences of string template formatting option ALPHA changed to function module call
+* SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
+* PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
+* RAISE EXCEPTION ... MESSAGE
+* Moving with +=, -=, /=, *=, &&= is expanded
+* line_exists and line_index is downported to READ TABLE
+
 Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.`,
             tags: [_irule_1.RuleTag.Experimental, _irule_1.RuleTag.Downport, _irule_1.RuleTag.Quickfix],
         };
@@ -75,10 +77,12 @@ Only one transformation is applied to a statement at a time, so multiple steps m
         const version = this.lowReg.getConfig().getVersion();
         if (version === version_1.Version.v702 || version === version_1.Version.OpenABAP) {
             this.initHighReg();
+            this.graph = new include_graph_1.IncludeGraph(reg);
         }
         return this;
     }
     run(lowObj) {
+        var _a;
         const ret = [];
         this.counter = 1;
         const version = this.lowReg.getConfig().getVersion();
@@ -92,7 +96,20 @@ Only one transformation is applied to a statement at a time, so multiple steps m
         if (highObj === undefined || !(highObj instanceof _abap_object_1.ABAPObject)) {
             return ret;
         }
-        const highSyntax = new syntax_1.SyntaxLogic(this.highReg, highObj).run();
+        let highSyntaxObj = highObj;
+        // for includes do the syntax check via a main program
+        if (lowObj instanceof objects_1.Program && lowObj.isInclude()) {
+            const mains = this.graph.listMainForInclude((_a = lowObj.getMainABAPFile()) === null || _a === void 0 ? void 0 : _a.getFilename());
+            if (mains.length <= 0) {
+                return [];
+            }
+            const f = this.highReg.getFileByName(mains[0]);
+            if (f === undefined) {
+                return [];
+            }
+            highSyntaxObj = this.highReg.findObjectForFile(f);
+        }
+        const highSyntax = new syntax_1.SyntaxLogic(this.highReg, highSyntaxObj).run();
         for (const lowFile of lowObj.getABAPFiles()) {
             const highFile = highObj.getABAPFileByName(lowFile.getFilename());
             if (highFile === undefined) {
@@ -242,7 +259,6 @@ Only one transformation is applied to a statement at a time, so multiple steps m
         if (found) {
             return found;
         }
-        // note: line_exists() must be replaced before this call
         found = this.replaceTableExpression(high, lowFile, highSyntax);
         if (found) {
             return found;
@@ -284,7 +300,7 @@ Only one transformation is applied to a statement at a time, so multiple steps m
                 addFix(c.getFirstToken());
             }
         }
-        for (const fieldList of high.findAllExpressionsRecursive(Expressions.SQLFieldList)) {
+        for (const fieldList of high.findAllExpressionsMulti([Expressions.SQLFieldList, Expressions.SQLFieldListLoop], true)) {
             for (const token of fieldList.getDirectTokens()) {
                 if (token.getStr() === ",") {
                     addFix(token);
@@ -366,10 +382,10 @@ Only one transformation is applied to a statement at a time, so multiple steps m
                 const fieldName = f.concatTokens();
                 fieldDefinition += indentation + "        " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
             }
-            fieldDefinition = `DATA: BEGIN OF ${name},
+            fieldDefinition = `DATA: BEGIN OF ${name},
 ${fieldDefinition}${indentation}      END OF ${name}.`;
         }
-        const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
+        const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
 ${indentation}`);
         const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
         const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -410,12 +426,12 @@ ${indentation}`);
         }
         const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
         const name = ((_c = inlineData.findFirstExpression(Expressions.TargetField)) === null || _c === void 0 ? void 0 : _c.concatTokens()) || "error";
-        let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
-${fieldDefinitions}${indentation}      END OF ${uniqueName}.
-${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
+        let fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
+${fieldDefinitions}${indentation}      END OF ${uniqueName}.
+${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
 ${indentation}`);
         if (fieldDefinitions === "") {
-            fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
+            fix1 = edit_helper_1.EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
 ${indentation}`);
         }
         const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
@@ -436,7 +452,7 @@ ${indentation}`);
             const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
             const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
             const firstToken = high.getFirstToken();
-            const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
+            const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target === null || target === void 0 ? void 0 : target.concatTokens()}.
 ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
             const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
             const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -450,6 +466,11 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
             if (tableExpression === undefined) {
                 continue;
             }
+            const concat = node.concatTokens().toUpperCase();
+            if (concat.includes(" LINE_EXISTS( ") || concat.includes(" LINE_INDEX( ")) {
+                // note: line_exists() must be replaced before handling table expressions
+                continue;
+            }
             let pre = "";
             let startToken = undefined;
             for (const child of fieldChain.getChildren()) {
@@ -480,11 +501,11 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
             const uniqueName = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
             const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
             const firstToken = node.getFirstToken();
-            const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
-${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
-${indentation}IF sy-subrc <> 0.
-${indentation}  RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
-${indentation}ENDIF.
+            const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
+${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
+${indentation}IF sy-subrc <> 0.
+${indentation}  RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
+${indentation}ENDIF.
 ${indentation}`);
             const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, startToken.getStart(), tableExpression.getLastToken().getEnd(), uniqueName);
             const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
@@ -509,7 +530,7 @@ ${indentation}`);
         const className = classNames[0].concatTokens();
         const targetName = (_b = target.findFirstExpression(Expressions.TargetField)) === null || _b === void 0 ? void 0 : _b.concatTokens();
         const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
-        const code = `  DATA ${targetName} TYPE REF TO ${className}.
+        const code = `  DATA ${targetName} TYPE REF TO ${className}.
 ${indentation}CATCH ${className} INTO ${targetName}.`;
         const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), code);
         return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Outline DATA", this.getMetadata().key, this.conf.severity, fix);
@@ -620,11 +641,11 @@ ${indentation}CATCH ${className} INTO ${targetName}.`;
             const uniqueName1 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
             const uniqueName2 = this.uniqueName(node.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
             const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
-            const abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
-${indentation}${uniqueName1}-msgid = ${id}.
-${indentation}${uniqueName1}-msgno = ${number}.
-${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
-${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.
+            const abap = `DATA ${uniqueName1} LIKE if_t100_message=>t100key.
+${indentation}${uniqueName1}-msgid = ${id}.
+${indentation}${uniqueName1}-msgno = ${number}.
+${indentation}DATA ${uniqueName2} TYPE REF TO ${className}.
+${indentation}CREATE OBJECT ${uniqueName2} EXPORTING textid = ${uniqueName1}.
 ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
             const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getStart(), node.getEnd(), abap);
             return issue_1.Issue.atToken(lowFile, startToken, "Downport RAISE MESSAGE", this.getMetadata().key, this.conf.severity, fix);
@@ -761,10 +782,10 @@ ${indentation}RAISE EXCEPTION ${uniqueName2}.`;
         const indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
         const source = (_b = templateSource === null || templateSource === void 0 ? void 0 : templateSource.findDirectExpression(Expressions.Source)) === null || _b === void 0 ? void 0 : _b.concatTokens();
         const topTarget = (_c = node.findDirectExpression(Expressions.Target)) === null || _c === void 0 ? void 0 : _c.concatTokens();
-        const code = `CALL FUNCTION '${functionName}'
-${indentation}  EXPORTING
-${indentation}    input  = ${source}
-${indentation}  IMPORTING
+        const code = `CALL FUNCTION '${functionName}'
+${indentation}  EXPORTING
+${indentation}    input  = ${source}
+${indentation}  IMPORTING
 ${indentation}    output = ${topTarget}.`;
         const fix = edit_helper_1.EditHelper.replaceRange(lowFile, node.getFirstToken().getStart(), node.getLastToken().getEnd(), code);
         return issue_1.Issue.atToken(lowFile, node.getFirstToken(), "Downport ALPHA", this.getMetadata().key, this.conf.severity, fix);
@@ -971,17 +992,26 @@ ${indentation}    output = ${topTarget}.`;
         return undefined;
     }
     outlineValue(node, lowFile, highSyntax) {
+        var _a;
         const allSources = node.findAllExpressionsRecursive(Expressions.Source);
-        for (const i of allSources) {
-            const firstToken = i.getFirstToken();
+        for (const s of allSources) {
+            const firstToken = s.getFirstToken();
             if (firstToken.getStr().toUpperCase() !== "VALUE") {
                 continue;
             }
-            const type = this.findType(i, lowFile, highSyntax);
+            let type = this.findType(s, lowFile, highSyntax);
             if (type === undefined) {
-                continue;
+                if (node.get() instanceof Statements.Move && node.findDirectExpression(Expressions.Source) === s) {
+                    type = "LIKE " + ((_a = node.findDirectExpression(Expressions.Target)) === null || _a === void 0 ? void 0 : _a.concatTokens());
+                }
+                if (type === undefined) {
+                    continue;
+                }
+            }
+            else {
+                type = "TYPE " + type;
             }
-            const valueBody = i.findDirectExpression(Expressions.ValueBody);
+            const valueBody = s.findDirectExpression(Expressions.ValueBody);
             const uniqueName = this.uniqueName(firstToken.getStart(), lowFile.getFilename(), highSyntax);
             let indentation = " ".repeat(node.getFirstToken().getStart().getCol() - 1);
             let body = "";
@@ -1021,11 +1051,11 @@ ${indentation}    output = ${topTarget}.`;
                 indentation = indentation.substring(2);
                 body += indentation + outlineFor.end + `.\n`;
             }
-            const abap = `DATA ${uniqueName} TYPE ${type}.\n` +
+            const abap = `DATA ${uniqueName} ${type}.\n` +
                 body +
                 indentation;
             const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, node.getFirstToken().getStart(), abap);
-            const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, firstToken.getStart(), i.getLastToken().getEnd(), uniqueName);
+            const fix2 = edit_helper_1.EditHelper.replaceRange(lowFile, firstToken.getStart(), s.getLastToken().getEnd(), uniqueName);
             const fix = edit_helper_1.EditHelper.merge(fix2, fix1);
             return issue_1.Issue.atToken(lowFile, firstToken, "Downport VALUE", this.getMetadata().key, this.conf.severity, fix);
         }
@@ -1136,12 +1166,10 @@ ${indentation}    output = ${topTarget}.`;
                 continue;
             }
             const found = spag.findVariable(name);
-            if (found === undefined) {
+            if (found === undefined
+                || found.getType() instanceof basic_1.VoidType) {
                 continue;
             }
-            else if (found.getType() instanceof basic_1.VoidType) {
-                return issue_1.Issue.atToken(lowFile, i.getFirstToken(), "Error outlining voided type", this.getMetadata().key, this.conf.severity);
-            }
             const type = found.getType().getQualifiedName() ? (_b = found.getType().getQualifiedName()) === null || _b === void 0 ? void 0 : _b.toLowerCase() : found.getType().toABAP();
             const code = `DATA ${name} TYPE ${type}.\n` +
                 " ".repeat(node.getFirstToken().getStart().getCol() - 1);
@@ -1297,9 +1325,11 @@ ${indentation}    output = ${topTarget}.`;
         var _a, _b;
         const spag = highSyntax.spaghetti.lookupPosition(node.getFirstToken().getStart(), lowFile.getFilename());
         for (const r of (spag === null || spag === void 0 ? void 0 : spag.getData().references) || []) {
+            if (r.referenceType !== _reference_1.ReferenceType.BuiltinMethodReference) {
+                continue;
+            }
             const func = r.position.getName().toUpperCase();
-            if (r.referenceType === _reference_1.ReferenceType.BuiltinMethodReference
-                && (func === "LINE_EXISTS" || func === "LINE_INDEX")) {
+            if (func === "LINE_EXISTS" || func === "LINE_INDEX") {
                 const token = r.position.getToken();
                 const expression = this.findMethodCallExpression(node, token);
                 if (expression === undefined) {

package/build/src/rules/exit_or_check.js

@@ -24,10 +24,10 @@ class ExitOrCheck extends _abap_rule_1.ABAPRule {
         return {
             key: "exit_or_check",
             title: "Find EXIT or CHECK outside loops",
-            shortDescription: `Detects usages of EXIT or CHECK statements outside of loops.
+            shortDescription: `Detects usages of EXIT or CHECK statements outside of loops.
 Use RETURN to leave procesing blocks instead.`,
-            extendedInformation: `https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenleave_processing_blocks.htm
-https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapcheck_processing_blocks.htm
+            extendedInformation: `https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenleave_processing_blocks.htm
+https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abapcheck_processing_blocks.htm
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#check-vs-return`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
         };

package/build/src/rules/exporting.js

@@ -22,7 +22,7 @@ class Exporting extends _abap_rule_1.ABAPRule {
             shortDescription: `Detects EXPORTING statements which can be omitted.`,
             badExample: `call_method( EXPORTING foo = bar ).`,
             goodExample: `call_method( foo = bar ).`,
-            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#omit-the-optional-keyword-exporting
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#omit-the-optional-keyword-exporting
 https://docs.abapopenchecks.org/checks/30/`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/forbidden_identifier.js

@@ -26,7 +26,7 @@ class ForbiddenIdentifier extends _abap_rule_1.ABAPRule {
             key: "forbidden_identifier",
             title: "Forbidden Identifier",
             shortDescription: `Forbid use of specified identifiers, list of regex.`,
-            extendedInformation: `Used in the transpiler to find javascript keywords in ABAP identifiers,
+            extendedInformation: `Used in the transpiler to find javascript keywords in ABAP identifiers,
 https://github.com/abaplint/transpiler/blob/bda94b8b56e2b7f2f87be2168f12361aa530220e/packages/transpiler/src/validation.ts#L44`,
             tags: [_irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/forbidden_void_type.js

@@ -28,8 +28,8 @@ class ForbiddenVoidType {
             key: "forbidden_void_type",
             title: "Forbidden Void Types",
             shortDescription: `Avoid usage of specified void types.`,
-            extendedInformation: `Inspiration:
-BOOLEAN, BOOLE_D, CHAR01, CHAR1, CHAR10, CHAR12, CHAR128, CHAR2, CHAR20, CHAR4, CHAR70,
+            extendedInformation: `Inspiration:
+BOOLEAN, BOOLE_D, CHAR01, CHAR1, CHAR10, CHAR12, CHAR128, CHAR2, CHAR20, CHAR4, CHAR70,
 DATS, TIMS, DATUM, FLAG, INT4, NUMC3, NUMC4, SAP_BOOL, TEXT25, TEXT80, X255, XFELD`,
         };
     }

package/build/src/rules/functional_writing.js

@@ -28,26 +28,26 @@ class FunctionalWriting extends _abap_rule_1.ABAPRule {
             key: "functional_writing",
             title: "Use functional writing",
             shortDescription: `Detects usage of call method when functional style calls can be used.`,
-            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-calls
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-calls
 https://docs.abapopenchecks.org/checks/07/`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
-            badExample: `CALL METHOD zcl_class=>method( ).
-CALL METHOD cl_abap_typedescr=>describe_by_name
-  EXPORTING
-    p_name         = 'NAME'
-  RECEIVING
-    p_descr_ref    = lr_typedescr
-  EXCEPTIONS
-    type_not_found = 1
+            badExample: `CALL METHOD zcl_class=>method( ).
+CALL METHOD cl_abap_typedescr=>describe_by_name
+  EXPORTING
+    p_name         = 'NAME'
+  RECEIVING
+    p_descr_ref    = lr_typedescr
+  EXCEPTIONS
+    type_not_found = 1
     OTHERS         = 2.`,
-            goodExample: `zcl_class=>method( ).
-cl_abap_typedescr=>describe_by_name(
-  EXPORTING
-    p_name         = 'NAME'
-  RECEIVING
-    p_descr_ref    = lr_typedescr
-  EXCEPTIONS
-    type_not_found = 1
+            goodExample: `zcl_class=>method( ).
+cl_abap_typedescr=>describe_by_name(
+  EXPORTING
+    p_name         = 'NAME'
+  RECEIVING
+    p_descr_ref    = lr_typedescr
+  EXCEPTIONS
+    type_not_found = 1
     OTHERS         = 2 ).`,
         };
     }

package/build/src/rules/global_class.js

@@ -18,16 +18,16 @@ class GlobalClass extends _abap_rule_1.ABAPRule {
         return {
             key: "global_class",
             title: "Global class checks",
-            shortDescription: `Checks related to global classes.
-
-* global classes must be in own files
-
-* file names must match class name
-
-* file names must match interface name
-
-* global classes must be global definitions
-
+            shortDescription: `Checks related to global classes.
+
+* global classes must be in own files
+
+* file names must match class name
+
+* file names must match interface name
+
+* global classes must be global definitions
+
 * global interfaces must be global definitions`,
             tags: [_irule_1.RuleTag.Syntax],
         };

package/build/src/rules/identical_conditions.js

@@ -33,8 +33,8 @@ class IdenticalConditions extends _abap_rule_1.ABAPRule {
         return {
             key: "identical_conditions",
             title: "Identical conditions",
-            shortDescription: `Find identical conditions in IF + CASE + WHILE etc
-
+            shortDescription: `Find identical conditions in IF + CASE + WHILE etc
+
 Prerequsites: code is pretty printed with identical cAsE`,
             tags: [_irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/identical_contents.js

@@ -20,23 +20,23 @@ class IdenticalContents extends _abap_rule_1.ABAPRule {
             key: "identical_contents",
             title: "Identical contents",
             shortDescription: `Find identical contents in blocks inside IFs, both in the beginning and in the end.`,
-            extendedInformation: `
-Prerequsites: code is pretty printed with identical cAsE
-
+            extendedInformation: `
+Prerequsites: code is pretty printed with identical cAsE
+
 Chained statments are ignored`,
             tags: [_irule_1.RuleTag.SingleFile],
-            badExample: `IF foo = bar.
-  WRITE 'bar'.
-  WRITE 'world'.
-ELSE.
-  WRITE 'foo'.
-  WRITE 'world'.
+            badExample: `IF foo = bar.
+  WRITE 'bar'.
+  WRITE 'world'.
+ELSE.
+  WRITE 'foo'.
+  WRITE 'world'.
 ENDIF.`,
-            goodExample: `IF foo = bar.
-  WRITE 'bar'.
-ELSE.
-  WRITE 'foo'.
-ENDIF.
+            goodExample: `IF foo = bar.
+  WRITE 'bar'.
+ELSE.
+  WRITE 'foo'.
+ENDIF.
 WRITE 'world'.`,
         };
     }

package/build/src/rules/identical_descriptions.js

@@ -16,10 +16,10 @@ class IdenticalDescriptions {
             key: "identical_descriptions",
             title: "Identical descriptions",
             shortDescription: `Searches for objects with the same type and same description`,
-            extendedInformation: `Case insensitive
-
-Only checks the master language descriptions
-
+            extendedInformation: `Case insensitive
+
+Only checks the master language descriptions
+
 Works for: INTF, CLAS, DOMA, DTEL, FUNC in same FUGR`,
             tags: [],
         };

package/build/src/rules/if_in_if.js

@@ -19,15 +19,15 @@ class IfInIf extends _abap_rule_1.ABAPRule {
             key: "if_in_if",
             title: "IF in IF",
             shortDescription: `Detects nested ifs which can be refactored to a single condition using AND.`,
-            extendedInformation: `https://docs.abapopenchecks.org/checks/01/
+            extendedInformation: `https://docs.abapopenchecks.org/checks/01/
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-the-nesting-depth-low`,
-            badExample: `IF condition1.
-  IF condition2.
-    ...
-  ENDIF.
+            badExample: `IF condition1.
+  IF condition2.
+    ...
+  ENDIF.
 ENDIF.`,
-            goodExample: `IF ( condition1 ) AND ( condition2 ).
-  ...
+            goodExample: `IF ( condition1 ) AND ( condition2 ).
+  ...
 ENDIF.`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/implement_methods.js

@@ -102,9 +102,9 @@ class ImplementMethods extends _abap_rule_1.ABAPRule {
         for (const i of ((_a = file.getStructure()) === null || _a === void 0 ? void 0 : _a.findAllStatements(Statements.ClassImplementation)) || []) {
             const name = (_b = i.findFirstExpression(Expressions.ClassName)) === null || _b === void 0 ? void 0 : _b.getFirstToken().getStr().toUpperCase();
             if (name === impl.identifier.getName().toUpperCase()) {
-                return edit_helper_1.EditHelper.insertAt(file, i.getLastToken().getEnd(), `
-  METHOD ${methodName.toLowerCase()}.
-    RETURN. " todo, implement method
+                return edit_helper_1.EditHelper.insertAt(file, i.getLastToken().getEnd(), `
+  METHOD ${methodName.toLowerCase()}.
+    RETURN. " todo, implement method
   ENDMETHOD.`);
             }
         }

package/build/src/rules/in_statement_indentation.js

@@ -31,19 +31,19 @@ class InStatementIndentation extends _abap_rule_1.ABAPRule {
             key: "in_statement_indentation",
             title: "In-statement indentation",
             shortDescription: "Checks alignment within statements which span multiple lines.",
-            extendedInformation: `Lines following the first line should be indented once (2 spaces).
-      
-For block declaration statements, lines after the first should be indented an additional time (default: +2 spaces)
+            extendedInformation: `Lines following the first line should be indented once (2 spaces).
+      
+For block declaration statements, lines after the first should be indented an additional time (default: +2 spaces)
 to distinguish them better from code within the block.`,
-            badExample: `IF 1 = 1
-  AND 2 = 2.
-  WRITE 'hello' &&
-  'world'.
+            badExample: `IF 1 = 1
+  AND 2 = 2.
+  WRITE 'hello' &&
+  'world'.
 ENDIF.`,
-            goodExample: `IF 1 = 1
-    AND 2 = 2.
-  WRITE 'hello' &&
-    'world'.
+            goodExample: `IF 1 = 1
+    AND 2 = 2.
+  WRITE 'hello' &&
+    'world'.
 ENDIF.`,
             tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/intf_referencing_clas.js

@@ -26,9 +26,9 @@ class IntfReferencingClas {
             key: "intf_referencing_clas",
             title: "INTF referencing CLAS",
             shortDescription: `Interface contains references to class`,
-            extendedInformation: `Only global interfaces are checked.
-      Only first level references are checked.
-      Exception class references are ignored.
+            extendedInformation: `Only global interfaces are checked.
+      Only first level references are checked.
+      Exception class references are ignored.
       Void references are ignored.`,
         };
     }

package/build/src/rules/line_break_style.js

@@ -15,8 +15,8 @@ class LineBreakStyle {
         return {
             key: "line_break_style",
             title: "Makes sure line breaks are consistent in the ABAP code",
-            shortDescription: `Enforces LF as newlines in ABAP files
-
+            shortDescription: `Enforces LF as newlines in ABAP files
+
 abapGit does not work with CRLF`,
             tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/line_length.js

@@ -23,7 +23,7 @@ class LineLength extends _abap_rule_1.ABAPRule {
             key: "line_length",
             title: "Line length",
             shortDescription: `Detects lines exceeding the provided maximum length.`,
-            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#stick-to-a-reasonable-line-length
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#stick-to-a-reasonable-line-length
 https://docs.abapopenchecks.org/checks/04/`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/line_only_punc.js

@@ -27,7 +27,7 @@ class LineOnlyPunc extends _abap_rule_1.ABAPRule {
             key: "line_only_punc",
             title: "Line containing only punctuation",
             shortDescription: `Detects lines containing only punctuation.`,
-            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#close-brackets-at-line-end
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#close-brackets-at-line-end
 https://docs.abapopenchecks.org/checks/16/`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
             badExample: "zcl_class=>method(\n).",

package/build/src/rules/local_variable_names.js

@@ -30,8 +30,8 @@ class LocalVariableNames extends _abap_rule_1.ABAPRule {
         return {
             key: "local_variable_names",
             title: "Local variable naming conventions",
-            shortDescription: `
-Allows you to enforce a pattern, such as a prefix, for local variables, constants and field symbols.
+            shortDescription: `
+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],
         };