@abaplint/core 2.108.7 → 2.108.9

package/build/src/rules/unnecessary_return.js

@@ -7,7 +7,13 @@ const _basic_rule_config_1 = require("./_basic_rule_config");
 const _irule_1 = require("./_irule");
 const Statements = require("../abap/2_statements/statements");
 const edit_helper_1 = require("../edit_helper");
+const _statement_1 = require("../abap/2_statements/statements/_statement");
 class UnnecessaryReturnConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        /** Allow empty METHODs + FORMs + FUNCTION-MODULEs */
+        this.allowEmpty = false;
+    }
 }
 exports.UnnecessaryReturnConf = UnnecessaryReturnConf;
 class UnnecessaryReturn extends _abap_rule_1.ABAPRule {
@@ -22,18 +28,18 @@ class UnnecessaryReturn extends _abap_rule_1.ABAPRule {
             shortDescription: `Finds unnecessary RETURN statements`,
             extendedInformation: `Finds unnecessary RETURN statements`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
-            badExample: `FORM hello1.
-  WRITE 'world'.
-  RETURN.
-ENDFORM.
-
-FORM foo.
-  IF 1 = 2.
-    RETURN.
-  ENDIF.
+            badExample: `FORM hello1.
+  WRITE 'world'.
+  RETURN.
+ENDFORM.
+
+FORM foo.
+  IF 1 = 2.
+    RETURN.
+  ENDIF.
 ENDFORM.`,
-            goodExample: `FORM hello2.
-  WRITE 'world'.
+            goodExample: `FORM hello2.
+  WRITE 'world'.
 ENDFORM.`,
         };
     }
@@ -51,15 +57,29 @@ ENDFORM.`,
         }
         const message = "Unnecessary RETURN";
         const statements = file.getStatements();
+        let statementCounter = 0;
         for (let i = 0; i < statements.length; i++) {
             const node = statements[i];
-            if (!(node.get() instanceof Statements.EndMethod
-                || node.get() instanceof Statements.EndForm
-                || node.get() instanceof Statements.EndFunction)) {
+            const nodeType = node.get();
+            if ((nodeType instanceof Statements.MethodImplementation
+                || nodeType instanceof Statements.Form
+                || nodeType instanceof Statements.FunctionModule)) {
+                statementCounter = 0;
+                continue;
+            }
+            if (!(nodeType instanceof _statement_1.Comment)) {
+                statementCounter++;
+            }
+            if (!(nodeType instanceof Statements.EndMethod
+                || nodeType instanceof Statements.EndForm
+                || nodeType instanceof Statements.EndFunction)) {
                 continue;
             }
             const prev = statements[i - 1];
             if (prev && prev.get() instanceof Statements.Return) {
+                if (this.conf.allowEmpty === true && statementCounter === 2) {
+                    continue;
+                }
                 const fix = edit_helper_1.EditHelper.deleteStatement(file, prev);
                 issues.push(issue_1.Issue.atStatement(file, prev, message, this.getMetadata().key, this.getConfig().severity, fix));
             }

package/build/src/rules/unused_methods.js

@@ -56,17 +56,17 @@ class UnusedMethods {
             key: "unused_methods",
             title: "Unused methods",
             shortDescription: `Checks for unused methods`,
-            extendedInformation: `Checks private and protected methods.
-
-Unused methods are not reported if the object contains parser or syntax errors.
-
-Skips:
-* methods FOR TESTING
-* methods SETUP + TEARDOWN + CLASS_SETUP + CLASS_TEARDOWN in testclasses
-* class_constructor + constructor methods
-* event handlers
-* methods that are redefined
-* INCLUDEs
+            extendedInformation: `Checks private and protected methods.
+
+Unused methods are not reported if the object contains parser or syntax errors.
+
+Skips:
+* methods FOR TESTING
+* methods SETUP + TEARDOWN + CLASS_SETUP + CLASS_TEARDOWN in testclasses
+* class_constructor + constructor methods
+* event handlers
+* methods that are redefined
+* INCLUDEs
 `,
             tags: [],
             pragma: "##CALLED",

package/build/src/rules/unused_variables.js

@@ -66,23 +66,23 @@ class UnusedVariables {
             key: "unused_variables",
             title: "Unused variables",
             shortDescription: `Checks for unused variables and constants`,
-            extendedInformation: `Skips event parameters.
-
-Note that this currently does not work if the source code uses macros.
-
-Unused variables are not reported if the object contains parser or syntax errors.
-
+            extendedInformation: `Skips event parameters.
+
+Note that this currently does not work if the source code uses macros.
+
+Unused variables are not reported if the object contains parser or syntax errors.
+
 Errors found in INCLUDES are reported for the main program.`,
             tags: [_irule_1.RuleTag.Quickfix],
             pragma: "##NEEDED",
             pseudoComment: "EC NEEDED",
-            badExample: `DATA: BEGIN OF blah1,
-      test  TYPE string,
-      test2 TYPE string,
+            badExample: `DATA: BEGIN OF blah1,
+      test  TYPE string,
+      test2 TYPE string,
     END OF blah1.`,
-            goodExample: `DATA: BEGIN OF blah2 ##NEEDED,
-      test  TYPE string,
-      test2 TYPE string,
+            goodExample: `DATA: BEGIN OF blah2 ##NEEDED,
+      test  TYPE string,
+      test2 TYPE string,
     END OF blah2.`,
         };
     }

package/build/src/rules/use_bool_expression.js

@@ -27,15 +27,15 @@ class UseBoolExpression extends _abap_rule_1.ABAPRule {
             shortDescription: `Use boolean expression, xsdbool from 740sp08 and up, boolc from 702 and up`,
             extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-xsdbool-to-set-boolean-variables`,
             tags: [_irule_1.RuleTag.Upport, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
-            badExample: `IF line IS INITIAL.
-  has_entries = abap_false.
-ELSE.
-  has_entries = abap_true.
-ENDIF.
-
+            badExample: `IF line IS INITIAL.
+  has_entries = abap_false.
+ELSE.
+  has_entries = abap_true.
+ENDIF.
+
 DATA(fsdf) = COND #( WHEN foo <> bar THEN abap_true ELSE abap_false ).`,
-            goodExample: `DATA(has_entries) = xsdbool( line IS NOT INITIAL ).
-
+            goodExample: `DATA(has_entries) = xsdbool( line IS NOT INITIAL ).
+
 DATA(fsdf) = xsdbool( foo <> bar ).`,
         };
     }

package/build/src/rules/use_class_based_exceptions.js

@@ -22,15 +22,15 @@ 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.
+            badExample: `INTERFACE lif.
+  METHODS load_data
+    EXCEPTIONS
+      invalid_parameter.
 ENDINTERFACE.`,
-            goodExample: `INTERFACE lif.
-  METHODS load_data
-    RAISING
-      cx_something.
+            goodExample: `INTERFACE lif.
+  METHODS load_data
+    RAISING
+      cx_something.
 ENDINTERFACE.`,
         };
     }

package/build/src/rules/use_line_exists.js

@@ -22,15 +22,15 @@ class UseLineExists extends _abap_rule_1.ABAPRule {
             key: "use_line_exists",
             title: "Use line_exists",
             shortDescription: `Use line_exists, from 740sp02 and up`,
-            extendedInformation: `
-https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-line_exists-to-read-table-or-loop-at
-
+            extendedInformation: `
+https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-line_exists-to-read-table-or-loop-at
+
 Not reported if the READ TABLE statement contains BINARY SEARCH.`,
             tags: [_irule_1.RuleTag.Upport, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
-            badExample: `READ TABLE my_table TRANSPORTING NO FIELDS WITH KEY key = 'A'.
-IF sy-subrc = 0.
+            badExample: `READ TABLE my_table TRANSPORTING NO FIELDS WITH KEY key = 'A'.
+IF sy-subrc = 0.
 ENDIF.`,
-            goodExample: `IF line_exists( my_table[ key = 'A' ] ).
+            goodExample: `IF line_exists( my_table[ key = 'A' ] ).
 ENDIF.`,
         };
     }

package/build/src/rules/use_new.js

@@ -23,10 +23,10 @@ class UseNew extends _abap_rule_1.ABAPRule {
             key: "use_new",
             title: "Use NEW",
             shortDescription: `Checks for deprecated CREATE OBJECT statements.`,
-            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-new-to-create-object
-
-If the target variable is referenced in the CREATE OBJECT statement, no errors are issued
-
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-new-to-create-object
+
+If the target variable is referenced in the CREATE OBJECT statement, no errors are issued
+
 Applicable from v740sp02 and up`,
             badExample: `CREATE OBJECT ref.`,
             goodExample: `ref = NEW #( ).`,

package/build/src/rules/when_others_last.js

@@ -21,13 +21,13 @@ class WhenOthersLast extends _abap_rule_1.ABAPRule {
             title: "WHEN OTHERS last",
             shortDescription: `Checks that WHEN OTHERS is placed the last within a CASE statement.`,
             tags: [_irule_1.RuleTag.SingleFile],
-            badExample: `CASE bar.
-  WHEN OTHERS.
-  WHEN 2.
+            badExample: `CASE bar.
+  WHEN OTHERS.
+  WHEN 2.
 ENDCASE.`,
-            goodExample: `CASE bar.
-  WHEN 2.
-  WHEN OTHERS.
+            goodExample: `CASE bar.
+  WHEN 2.
+  WHEN OTHERS.
 ENDCASE.`,
         };
     }

package/package.json

@@ -1,70 +1,70 @@
-{
-    "name": "@abaplint/core",
-    "version": "2.108.7",
-    "description": "abaplint - Core API",
-    "main": "build/src/index.js",
-    "typings": "build/abaplint.d.ts",
-    "funding": "https://github.com/sponsors/larshp",
-    "scripts": {
-        "lint": "eslint src/**/*.ts test/**/*.ts --format unix",
-        "lint:fix": "eslint src/**/*.ts test/**/*.ts --format unix --fix",
-        "compile": "tsc && sh scripts/version.sh",
-        "test": "npm run compile && mocha --timeout 1000 && npm run lint && npm run schema && api-extractor run",
-        "test:only": "npm run compile && mocha",
-        "test:parallel": "npm run compile && mocha --timeout 1000 --parallel --reporter dot",
-        "coverage": "npm run compile && c8 mocha && c8 report --reporter=html",
-        "lexer_performance": "tsc && curl -o lexer_performance.abap https://raw.githubusercontent.com/abapGit/build/main/zabapgit_standalone.prog.abap && node build/adhoc/lexer_performance.js",
-        "parser_performance": "tsc && curl -o lexer_performance.abap https://raw.githubusercontent.com/abapGit/build/main/zabapgit_standalone.prog.abap && node build/adhoc/parser_performance.js",
-        "syntax_performance": "tsc && curl -o lexer_performance.abap https://raw.githubusercontent.com/abapGit/build/main/zabapgit_standalone.prog.abap && node build/adhoc/syntax_performance.js",
-        "typed_array": "tsc && node build/adhoc/typed_array.js",
-        "schema": "node scripts/schema.js > scripts/schema.ts && ts-json-schema-generator --tsconfig tsconfig_schema.json --jsDoc extended --path scripts/schema.ts > scripts/schema.json && node scripts/schema_post.js",
-        "publish:minor": "npm --no-git-tag-version version minor && rm -rf build && npm install && npm run test && npm publish --access public",
-        "publish:patch": "npm --no-git-tag-version version patch && rm -rf build && npm install && npm run test && npm publish --access public"
-    },
-    "mocha": {
-        "recursive": true,
-        "reporter": "progress",
-        "spec": "build/test/**/*.js",
-        "require": "source-map-support/register"
-    },
-    "c8": {
-        "include": [
-            "build/src/**/*.js"
-        ]
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/abaplint/abaplint.git"
-    },
-    "engines": {
-        "node": ">=12.0.0"
-    },
-    "keywords": [
-        "ABAP",
-        "lint"
-    ],
-    "author": "Lars Hvam Petersen",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/abaplint/abaplint/issues"
-    },
-    "homepage": "https://abaplint.org",
-    "devDependencies": {
-        "@microsoft/api-extractor": "^7.43.5",
-        "@types/chai": "^4.3.16",
-        "@types/mocha": "^10.0.6",
-        "@types/node": "^20.12.12",
-        "chai": "^4.4.1",
-        "eslint": "^8.57.0",
-        "mocha": "^10.4.0",
-        "c8": "^9.1.0",
-        "source-map-support": "^0.5.21",
-        "ts-json-schema-generator": "=2.0.1",
-        "typescript": "^5.4.5"
-    },
-    "dependencies": {
-        "fast-xml-parser": "^4.3.6",
-        "json5": "^2.2.3",
-        "vscode-languageserver-types": "^3.17.5"
-    }
-}
+{
+    "name": "@abaplint/core",
+    "version": "2.108.9",
+    "description": "abaplint - Core API",
+    "main": "build/src/index.js",
+    "typings": "build/abaplint.d.ts",
+    "funding": "https://github.com/sponsors/larshp",
+    "scripts": {
+        "lint": "eslint src/**/*.ts test/**/*.ts --format unix",
+        "lint:fix": "eslint src/**/*.ts test/**/*.ts --format unix --fix",
+        "compile": "tsc && sh scripts/version.sh",
+        "test": "npm run compile && mocha --timeout 1000 && npm run lint && npm run schema && api-extractor run",
+        "test:only": "npm run compile && mocha",
+        "test:parallel": "npm run compile && mocha --timeout 1000 --parallel --reporter dot",
+        "coverage": "npm run compile && c8 mocha && c8 report --reporter=html",
+        "lexer_performance": "tsc && curl -o lexer_performance.abap https://raw.githubusercontent.com/abapGit/build/main/zabapgit_standalone.prog.abap && node build/adhoc/lexer_performance.js",
+        "parser_performance": "tsc && curl -o lexer_performance.abap https://raw.githubusercontent.com/abapGit/build/main/zabapgit_standalone.prog.abap && node build/adhoc/parser_performance.js",
+        "syntax_performance": "tsc && curl -o lexer_performance.abap https://raw.githubusercontent.com/abapGit/build/main/zabapgit_standalone.prog.abap && node build/adhoc/syntax_performance.js",
+        "typed_array": "tsc && node build/adhoc/typed_array.js",
+        "schema": "node scripts/schema.js > scripts/schema.ts && ts-json-schema-generator --tsconfig tsconfig_schema.json --jsDoc extended --path scripts/schema.ts > scripts/schema.json && node scripts/schema_post.js",
+        "publish:minor": "npm --no-git-tag-version version minor && rm -rf build && npm install && npm run test && npm publish --access public",
+        "publish:patch": "npm --no-git-tag-version version patch && rm -rf build && npm install && npm run test && npm publish --access public"
+    },
+    "mocha": {
+        "recursive": true,
+        "reporter": "progress",
+        "spec": "build/test/**/*.js",
+        "require": "source-map-support/register"
+    },
+    "c8": {
+        "include": [
+            "build/src/**/*.js"
+        ]
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/abaplint/abaplint.git"
+    },
+    "engines": {
+        "node": ">=12.0.0"
+    },
+    "keywords": [
+        "ABAP",
+        "lint"
+    ],
+    "author": "Lars Hvam Petersen",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/abaplint/abaplint/issues"
+    },
+    "homepage": "https://abaplint.org",
+    "devDependencies": {
+        "@microsoft/api-extractor": "^7.43.8",
+        "@types/chai": "^4.3.16",
+        "@types/mocha": "^10.0.6",
+        "@types/node": "^20.12.12",
+        "chai": "^4.4.1",
+        "eslint": "^8.57.0",
+        "mocha": "^10.4.0",
+        "c8": "^9.1.0",
+        "source-map-support": "^0.5.21",
+        "ts-json-schema-generator": "=2.0.1",
+        "typescript": "^5.4.5"
+    },
+    "dependencies": {
+        "fast-xml-parser": "^4.4.0",
+        "json5": "^2.2.3",
+        "vscode-languageserver-types": "^3.17.5"
+    }
+}