@abaplint/core 2.107.1 → 2.107.3

package/build/abaplint.d.ts

@@ -1709,6 +1709,15 @@ declare class Detail implements IStatement {
     getMatcher(): IStatementRunnable;
 }
 
+export declare class Diagnostics {
+    private readonly reg;
+    constructor(reg: IRegistry);
+    findIssues(textDocument: LServer.TextDocumentIdentifier): readonly Issue[];
+    static mapDiagnostic(issue: Issue): LServer.Diagnostic;
+    find(textDocument: LServer.TextDocumentIdentifier): LServer.Diagnostic[];
+    private static mapSeverity;
+}
+
 declare class DialogModule extends AbstractObject {
     getType(): string;
     getAllowedNaming(): {
@@ -3165,7 +3174,12 @@ declare interface IIssueData {
     start: Position;
     end: Position;
     severity: Severity;
-    fix?: IEdit;
+    /** The default fix for the issue, it always makes sense to apply this fix
+     *  These are applied by "abaplint --fix" and in the document formatter in vscode extension
+     */
+    defaultFix?: IEdit;
+    /** Alternative quick fixes, the developer must choose which to apply */
+    alternativeFixes?: IEdit[];
 }
 
 declare interface IKeyword {
@@ -3798,7 +3812,8 @@ export declare class Issue {
     getStart(): Position;
     getEnd(): Position;
     getFilename(): string;
-    getFix(): IEdit | undefined;
+    getDefaultFix(): IEdit | undefined;
+    getAlternativeFixes(): IEdit[] | undefined;
     getSeverity(): Severity;
 }
 
@@ -4019,6 +4034,12 @@ declare class LoopTarget extends Expression {
     getRunnable(): IStatementRunnable;
 }
 
+export declare class LSPEdit {
+    static mapEdits(edits: IEdit[]): LServer.WorkspaceEdit;
+    static mapEdit(edit: IEdit): LServer.WorkspaceEdit;
+    private static mapText;
+}
+
 declare class MacroName extends Expression {
     getRunnable(): IStatementRunnable;
 }

package/build/src/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Visibility = exports.Info = exports.Rename = exports.PrettyPrinter = exports.Position = exports.CurrentScope = exports.ABAPFile = exports.RulesRunner = exports.SpaghettiScope = exports.SyntaxLogic = exports.ABAPObject = exports.Tokens = exports.ExpressionsCDS = exports.CDSParser = exports.LanguageServerTypes = exports.DDLParser = exports.applyEditList = exports.applyEditSingle = exports.SpaghettiScopeNode = exports.AbstractFile = exports.Token = exports.ScopeType = exports.BasicTypes = exports.TypedIdentifier = exports.AbstractType = exports.VirtualPosition = exports.Comment = exports.Unknown = exports.Empty = exports.Identifier = exports.Nodes = exports.Types = exports.Expressions = exports.Statements = exports.Structures = exports.SkipLogic = exports.Objects = exports.ArtifactsRules = exports.ArtifactsObjects = exports.ArtifactsABAP = exports.BuiltIn = exports.MethodLengthStats = exports.LanguageServer = exports.Registry = exports.CyclomaticComplexityStats = exports.ReferenceType = exports.Version = exports.Config = exports.Issue = exports.MemoryFile = void 0;
-exports.RuleTag = exports.Severity = void 0;
+exports.Info = exports.Diagnostics = exports.Rename = exports.PrettyPrinter = exports.Position = exports.CurrentScope = exports.ABAPFile = exports.RulesRunner = exports.SpaghettiScope = exports.SyntaxLogic = exports.ABAPObject = exports.Tokens = exports.ExpressionsCDS = exports.CDSParser = exports.LanguageServerTypes = exports.DDLParser = exports.applyEditList = exports.applyEditSingle = exports.SpaghettiScopeNode = exports.AbstractFile = exports.Token = exports.ScopeType = exports.BasicTypes = exports.TypedIdentifier = exports.AbstractType = exports.VirtualPosition = exports.Comment = exports.Unknown = exports.Empty = exports.Identifier = exports.Nodes = exports.Types = exports.Expressions = exports.Statements = exports.Structures = exports.SkipLogic = exports.Objects = exports.ArtifactsRules = exports.ArtifactsObjects = exports.ArtifactsABAP = exports.BuiltIn = exports.MethodLengthStats = exports.LanguageServer = exports.Registry = exports.CyclomaticComplexityStats = exports.ReferenceType = exports.Version = exports.Config = exports.Issue = exports.MemoryFile = void 0;
+exports.LSPEdit = exports.RuleTag = exports.Severity = exports.Visibility = void 0;
 const issue_1 = require("./issue");
 Object.defineProperty(exports, "Issue", { enumerable: true, get: function () { return issue_1.Issue; } });
 const config_1 = require("./config");
@@ -102,4 +102,8 @@ const cyclomatic_complexity_stats_1 = require("./utils/cyclomatic_complexity_sta
 Object.defineProperty(exports, "CyclomaticComplexityStats", { enumerable: true, get: function () { return cyclomatic_complexity_stats_1.CyclomaticComplexityStats; } });
 const skip_logic_1 = require("./skip_logic");
 Object.defineProperty(exports, "SkipLogic", { enumerable: true, get: function () { return skip_logic_1.SkipLogic; } });
+const diagnostics_1 = require("./lsp/diagnostics");
+Object.defineProperty(exports, "Diagnostics", { enumerable: true, get: function () { return diagnostics_1.Diagnostics; } });
+const _edit_1 = require("./lsp/_edit");
+Object.defineProperty(exports, "LSPEdit", { enumerable: true, get: function () { return _edit_1.LSPEdit; } });
 //# sourceMappingURL=index.js.map

package/build/src/issue.js

@@ -32,7 +32,7 @@ class Issue {
             key,
             start,
             end,
-            fix,
+            defaultFix: fix,
             severity,
         });
     }
@@ -46,7 +46,7 @@ class Issue {
             key,
             start,
             end,
-            fix,
+            defaultFix: fix,
             severity,
         });
     }
@@ -58,7 +58,7 @@ class Issue {
             key,
             start,
             end,
-            fix,
+            defaultFix: fix,
             severity,
         });
     }
@@ -71,7 +71,7 @@ class Issue {
             start: token.getStart(),
             end: token.getEnd(),
             severity,
-            fix,
+            defaultFix: fix,
         });
     }
     static atIdentifier(identifier, message, key, severity, fix) {
@@ -83,14 +83,14 @@ class Issue {
             start: identifier.getStart(),
             end: identifier.getEnd(),
             severity,
-            fix,
+            defaultFix: fix,
         });
     }
     constructor(data) {
         this.data = data;
         if (this.data.start instanceof virtual_position_1.VirtualPosition) {
             // no quick fixes inside macros
-            this.data.fix = undefined;
+            this.data.defaultFix = undefined;
         }
         if (this.data.start.getCol() < 1) {
             throw new Error("issue, start col < 1");
@@ -117,8 +117,11 @@ class Issue {
     getFilename() {
         return this.data.filename;
     }
-    getFix() {
-        return this.data.fix;
+    getDefaultFix() {
+        return this.data.defaultFix;
+    }
+    getAlternativeFixes() {
+        return this.data.alternativeFixes;
     }
     getSeverity() {
         return this.data.severity;

package/build/src/lsp/_edit.js

@@ -15,22 +15,6 @@ class LSPEdit {
         }
         return workspace;
     }
-    /*
-      public static mapEditsDocument(edit: IEdit): LServer.WorkspaceEdit {
-        const workspace: LServer.WorkspaceEdit = {documentChanges: []};
-        for (const filename in edit) {
-          const doc: LServer.VersionedTextDocumentIdentifier = {uri: filename, version: 1};
-    
-          const e = LServer.TextDocumentEdit.create(doc, this.mapText(edit[filename]));
-          workspace.documentChanges?.push(e);
-        }
-        // @ts-ignore
-        console.dir(workspace.documentChanges![0].edits[0]);
-        // @ts-ignore
-        console.dir(workspace.documentChanges![0].edits[1]);
-        return workspace;
-      }
-    */
     static mapEdit(edit) {
         const workspace = { changes: {} };
         for (const filename in edit) {

package/build/src/lsp/code_actions.js

@@ -16,7 +16,7 @@ class CodeActions {
         const shown = new Set();
         const ret = [];
         for (const i of issues) {
-            const fix = i.getFix();
+            const fix = i.getDefaultFix();
             if (fix === undefined) {
                 continue;
             }
@@ -51,7 +51,7 @@ class CodeActions {
         const diagnostics = [];
         const fixes = [];
         for (const i of issues) {
-            const fix = i.getFix();
+            const fix = i.getDefaultFix();
             if (fix === undefined) {
                 continue;
             }

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.3";
     }
     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/chain_mainly_declarations.js

@@ -141,7 +141,7 @@ https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-US/abenchained_statement
             }
             let prevFix;
             if (previousRow === colon.getStart().getRow()) {
-                prevFix = (_a = issues.pop()) === null || _a === void 0 ? void 0 : _a.getFix();
+                prevFix = (_a = issues.pop()) === null || _a === void 0 ? void 0 : _a.getDefaultFix();
             }
             const fix = this.getFix(file, statement, statementNode, prevFix);
             const message = "Chain mainly declarations";

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.3",
     "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.16",
         "@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",