@abaplint/core 2.108.1 → 2.108.3

package/build/abaplint.d.ts

@@ -2445,6 +2445,11 @@ declare class FindType extends Expression {
     getRunnable(): IStatementRunnable;
 }
 
+declare type Fix = {
+    description: string;
+    edit: IEdit;
+};
+
 declare class FloatingPointType extends AbstractType {
     private readonly length;
     constructor(length: number, qualifiedName?: string);
@@ -3179,7 +3184,7 @@ declare interface IIssueData {
      */
     defaultFix?: IEdit;
     /** Alternative quick fixes, the developer must choose which to apply */
-    alternativeFixes?: IEdit[];
+    alternativeFixes?: Fix[];
 }
 
 declare interface IKeyword {
@@ -3799,10 +3804,10 @@ export declare interface ISpaghettiScopeNode {
 export declare class Issue {
     private readonly data;
     static atRow(file: IFile, row: number, message: string, key: string, severity?: Severity): Issue;
-    static atStatement(file: IFile, statement: StatementNode, message: string, key: string, severity?: Severity, fix?: IEdit): Issue;
+    static atStatement(file: IFile, statement: StatementNode, message: string, key: string, severity?: Severity, fix?: IEdit, alternativeFixes?: Fix[]): Issue;
     static atPosition(file: IFile, start: Position, message: string, key: string, severity?: Severity, fix?: IEdit): Issue;
     static atRowRange(file: IFile, row: number, startCol: number, endCol: number, message: string, key: string, severity?: Severity, fix?: IEdit): Issue;
-    static atRange(file: IFile, start: Position, end: Position, message: string, key: string, severity?: Severity, fix?: IEdit): Issue;
+    static atRange(file: IFile, start: Position, end: Position, message: string, key: string, severity?: Severity, fix?: IEdit, alternativeFixes?: Fix[]): Issue;
     static atToken(file: IFile, token: Token, message: string, key: string, severity?: Severity, fix?: IEdit): Issue;
     static atIdentifier(identifier: Identifier, message: string, key: string, severity?: Severity, fix?: IEdit): Issue;
     constructor(data: IIssueData);
@@ -3813,7 +3818,7 @@ export declare class Issue {
     getEnd(): Position;
     getFilename(): string;
     getDefaultFix(): IEdit | undefined;
-    getAlternativeFixes(): IEdit[] | undefined;
+    getAlternativeFixes(): Fix[] | undefined;
     getSeverity(): Severity;
 }
 

package/build/src/issue.js

@@ -19,8 +19,8 @@ class Issue {
             severity,
         });
     }
-    static atStatement(file, statement, message, key, severity, fix) {
-        return this.atRange(file, statement.getStart(), statement.getEnd(), message, key, severity, fix);
+    static atStatement(file, statement, message, key, severity, fix, alternativeFixes) {
+        return this.atRange(file, statement.getStart(), statement.getEnd(), message, key, severity, fix, alternativeFixes);
     }
     static atPosition(file, start, message, key, severity, fix) {
         const row = start.getRow();
@@ -50,7 +50,7 @@ class Issue {
             severity,
         });
     }
-    static atRange(file, start, end, message, key, severity, fix) {
+    static atRange(file, start, end, message, key, severity, fix, alternativeFixes) {
         severity = severity !== null && severity !== void 0 ? severity : severity_1.Severity.Error;
         return new Issue({
             filename: file.getFilename(),
@@ -60,6 +60,7 @@ class Issue {
             end,
             defaultFix: fix,
             severity,
+            alternativeFixes,
         });
     }
     static atToken(file, token, message, key, severity, fix) {

package/build/src/lsp/code_actions.js

@@ -17,26 +17,36 @@ class CodeActions {
         const ret = [];
         for (const i of issues) {
             const fix = i.getDefaultFix();
-            if (fix === undefined) {
-                continue;
-            }
-            if (totals[i.getKey()] === undefined) {
-                totals[i.getKey()] = 1;
+            if (fix !== undefined) {
+                if (totals[i.getKey()] === undefined) {
+                    totals[i.getKey()] = 1;
+                }
+                else {
+                    totals[i.getKey()]++;
+                }
+                if (this.inRange(i, params.range) === true) {
+                    ret.push({
+                        title: "Apply fix, " + i.getKey(),
+                        kind: LServer.CodeActionKind.QuickFix,
+                        diagnostics: [diagnostics_1.Diagnostics.mapDiagnostic(i)],
+                        isPreferred: true,
+                        edit: _edit_1.LSPEdit.mapEdit(fix),
+                    });
+                    shown.add(i.getKey());
+                }
             }
-            else {
-                totals[i.getKey()]++;
-            }
-            if (this.inRange(i, params.range) === false) {
-                continue;
+            for (const alternative of i.getAlternativeFixes() || []) {
+                if (this.inRange(i, params.range) === true) {
+                    ret.push({
+                        title: alternative.description,
+                        kind: LServer.CodeActionKind.QuickFix,
+                        diagnostics: [diagnostics_1.Diagnostics.mapDiagnostic(i)],
+                        isPreferred: true,
+                        edit: _edit_1.LSPEdit.mapEdit(alternative.edit),
+                    });
+                    shown.add(i.getKey());
+                }
             }
-            ret.push({
-                title: "Apply fix, " + i.getKey(),
-                kind: LServer.CodeActionKind.QuickFix,
-                diagnostics: [diagnostics_1.Diagnostics.mapDiagnostic(i)],
-                isPreferred: true,
-                edit: _edit_1.LSPEdit.mapEdit(fix),
-            });
-            shown.add(i.getKey());
         }
         for (const s of shown) {
             if (totals[s] > 1) {

package/build/src/registry.js

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

package/build/src/rules/align_pseudo_comments.js

@@ -6,6 +6,8 @@ const _basic_rule_config_1 = require("./_basic_rule_config");
 const _irule_1 = require("./_irule");
 const issue_1 = require("../issue");
 const _statement_1 = require("../abap/2_statements/statements/_statement");
+const position_1 = require("../position");
+const edit_helper_1 = require("../edit_helper");
 class AlignPseudoCommentsConf extends _basic_rule_config_1.BasicRuleConfig {
 }
 exports.AlignPseudoCommentsConf = AlignPseudoCommentsConf;
@@ -19,7 +21,7 @@ class AlignPseudoComments extends _abap_rule_1.ABAPRule {
             key: "align_pseudo_comments",
             title: "Align pseudo comments",
             shortDescription: `Align code inspector pseudo comments in statements`,
-            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace],
+            tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix],
             badExample: `WRITE 'sdf'. "#EC sdf`,
             goodExample: `WRITE 'sdf'.                                                "#EC sdf`,
         };
@@ -46,16 +48,22 @@ class AlignPseudoComments extends _abap_rule_1.ABAPRule {
             else if (previousEnd === undefined) {
                 continue;
             }
-            else if (commentLength > 10) {
-                const expectedColumn = 72 - commentLength;
-                if (previousEnd.getCol() < expectedColumn && firstCommentToken.getStart().getCol() !== expectedColumn) {
-                    const message = "Align pseudo comment to column " + expectedColumn;
-                    issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
-                }
+            let expectedColumn = 61;
+            if (commentLength > 10) {
+                expectedColumn = 72 - commentLength;
             }
-            else if (previousEnd.getCol() < 61 && firstCommentToken.getStart().getCol() !== 61) {
-                const message = "Align pseudo comment to column 61";
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+            const col = firstCommentToken.getStart().getCol();
+            if (previousEnd.getCol() < expectedColumn && col !== expectedColumn) {
+                let fix = undefined;
+                if (col < expectedColumn) {
+                    fix = edit_helper_1.EditHelper.insertAt(file, firstCommentToken.getStart(), " ".repeat(expectedColumn - col));
+                }
+                else {
+                    const from = new position_1.Position(firstCommentToken.getStart().getRow(), expectedColumn);
+                    fix = edit_helper_1.EditHelper.deleteRange(file, from, firstCommentToken.getStart());
+                }
+                const message = "Align pseudo comment to column " + expectedColumn;
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, fix));
             }
         }
         return issues;

package/build/src/rules/check_subrc.js

@@ -8,6 +8,7 @@ const _basic_rule_config_1 = require("./_basic_rule_config");
 const _abap_rule_1 = require("./_abap_rule");
 const _irule_1 = require("./_irule");
 const _statement_1 = require("../abap/2_statements/statements/_statement");
+const edit_helper_1 = require("../edit_helper");
 class CheckSubrcConf extends _basic_rule_config_1.BasicRuleConfig {
     constructor() {
         super(...arguments);
@@ -54,6 +55,12 @@ FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
     setConfig(conf) {
         this.conf = conf;
     }
+    buildFix(file, statement) {
+        return {
+            description: "Add ##SUBRC_OK",
+            edit: edit_helper_1.EditHelper.insertAt(file, statement.getLastToken().getEnd(), " ##SUBRC_OK"),
+        };
+    }
     runParsed(file) {
         const issues = [];
         const statements = file.getStatements();
@@ -68,11 +75,13 @@ FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
             if (config.openDataset === true
                 && statement.get() instanceof Statements.OpenDataset
                 && this.isChecked(i, statements) === false) {
+                // it doesnt make sense to ignore the subrc for open dataset, so no quick fix
                 issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
             }
             else if (config.authorityCheck === true
                 && statement.get() instanceof Statements.AuthorityCheck
                 && this.isChecked(i, statements) === false) {
+                // it doesnt make sense to ignore the subrc for authority checks, so no quick fix
                 issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
             }
             else if (config.selectSingle === true
@@ -84,7 +93,8 @@ FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
                 if (concat.startsWith("SELECT SINGLE @ABAP_TRUE FROM ")) {
                     continue;
                 }
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+                const fix = this.buildFix(file, statement);
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, undefined, [fix]));
             }
             else if (config.selectTable === true
                 && statement.get() instanceof Statements.Select
@@ -93,42 +103,49 @@ FIND statement with MATCH COUNT is considered okay if subrc is not checked`,
                 && statement.concatTokens().toUpperCase().startsWith("SELECT COUNT(*) ") === false
                 && this.isChecked(i, statements) === false
                 && this.checksDbcnt(i, statements) === false) {
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+                const fix = this.buildFix(file, statement);
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, undefined, [fix]));
             }
             else if (config.updateDatabase === true
                 && statement.get() instanceof Statements.UpdateDatabase
                 && this.isChecked(i, statements) === false
                 && this.checksDbcnt(i, statements) === false) {
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+                const fix = this.buildFix(file, statement);
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, undefined, [fix]));
             }
             else if (config.insertDatabase === true
                 && statement.get() instanceof Statements.InsertDatabase
                 && this.isChecked(i, statements) === false
                 && this.checksDbcnt(i, statements) === false) {
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+                const fix = this.buildFix(file, statement);
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, undefined, [fix]));
             }
             else if (config.modifyDatabase === true
                 && statement.get() instanceof Statements.ModifyDatabase
                 && this.isChecked(i, statements) === false
                 && this.checksDbcnt(i, statements) === false) {
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+                const fix = this.buildFix(file, statement);
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, undefined, [fix]));
             }
             else if (config.readTable === true
                 && statement.get() instanceof Statements.ReadTable
                 && this.isChecked(i, statements) === false) {
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+                const fix = this.buildFix(file, statement);
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, undefined, [fix]));
             }
             else if (config.assign === true
                 && statement.get() instanceof Statements.Assign
                 && this.isSimpleAssign(statement) === false
                 && this.isChecked(i, statements) === false) {
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+                const fix = this.buildFix(file, statement);
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, undefined, [fix]));
             }
             else if (config.find === true
                 && statement.get() instanceof Statements.Find
                 && this.isExemptedFind(statement) === false
                 && this.isChecked(i, statements) === false) {
-                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+                const fix = this.buildFix(file, statement);
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity, undefined, [fix]));
             }
         }
         return issues;

package/build/src/rules/empty_structure.js

@@ -12,6 +12,8 @@ class EmptyStructureConf extends _basic_rule_config_1.BasicRuleConfig {
         super(...arguments);
         /** Checks for empty LOOP blocks */
         this.loop = true;
+        /** Allow empty LOOP if subrc is checked after the loop */
+        this.loopAllowIfSubrc = true;
         /** Checks for empty IF blocks */
         this.if = true;
         /** Checks for empty WHILE blocks */
@@ -44,6 +46,14 @@ class EmptyStructure extends _abap_rule_1.ABAPRule {
             shortDescription: `Checks that the code does not contain empty blocks.`,
             extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#no-empty-if-branches`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
+            badExample: `IF foo = bar.
+ENDIF.
+
+DO 2 TIMES.
+ENDDO.`,
+            goodExample: `LOOP AT itab WHERE qty = 0 OR date > sy-datum.
+ENDLOOP.
+result = xsdbool( sy-subrc = 0 ).`,
         };
     }
     getDescription(name) {
@@ -61,15 +71,13 @@ class EmptyStructure extends _abap_rule_1.ABAPRule {
         if (stru === undefined) {
             return [];
         }
-        for (const statement of file.getStatements()) {
+        const statements = file.getStatements();
+        for (const statement of statements) {
             if (statement.get() instanceof _statement_1.Unknown) {
                 return []; // contains parser errors
             }
         }
         const candidates = [];
-        if (this.getConfig().loop === true) {
-            candidates.push(...stru.findAllStructuresRecursive(Structures.Loop));
-        }
         if (this.getConfig().while === true) {
             candidates.push(...stru.findAllStructuresRecursive(Structures.While));
         }
@@ -105,6 +113,22 @@ class EmptyStructure extends _abap_rule_1.ABAPRule {
                 }
             }
         }
+        if (this.getConfig().loop === true) {
+            const loops = stru.findAllStructuresRecursive(Structures.Loop);
+            for (const loop of loops) {
+                if (loop.getChildren().length === 2) {
+                    const endloopStatement = loop.getLastChild();
+                    const endloopIndex = statements.findIndex((s) => s === endloopStatement);
+                    const afterEndloop = statements[endloopIndex + 1];
+                    if (afterEndloop !== undefined && afterEndloop.concatTokens().toUpperCase().includes("SY-SUBRC")) {
+                        continue;
+                    }
+                    const token = loop.getFirstToken();
+                    const issue = issue_1.Issue.atToken(file, token, this.getDescription(loop.get().constructor.name), this.getMetadata().key, this.conf.severity);
+                    issues.push(issue);
+                }
+            }
+        }
         if (this.getConfig().if === true) {
             const tries = stru.findAllStructuresRecursive(Structures.If)
                 .concat(stru.findAllStructuresRecursive(Structures.Else))

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.108.1",
+    "version": "2.108.3",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",
@@ -50,7 +50,7 @@
     },
     "homepage": "https://abaplint.org",
     "devDependencies": {
-        "@microsoft/api-extractor": "^7.43.2",
+        "@microsoft/api-extractor": "^7.43.4",
         "@types/chai": "^4.3.16",
         "@types/mocha": "^10.0.6",
         "@types/node": "^20.12.11",