1.15.0 (#379)

* 1.15.0

* Update changelog.txt

* CALL METHOD Usage does not check if the method call is dynamic (#397)

* fixes #396

fixes #396

* Update changelog.txt

* disabling fields (#395)

* comment usage bugfix (#406)

* bugfix

* abaplint

* small changes

* some anti magic

* unit test update

* update

* removal of constants

* line break

* Update changelog.txt

Co-authored-by: Lucas Borin <[email protected]>

* fixes #400 (#411)

* fixes #400

* Update changelog.txt

* False positive assert (#410)

* fixes #400

* Update changelog.txt

* Nesting Depth - Macro (#425)

* resolves #422

* Update changelog.txt

* Use | to assemble text  (#416)

* new check

* Fixing Contains non 7 bit ascii character

* Update changelog.txt

* Update check_documentation.md

* Update check_documentation.md

* Create text-assembly.md

* Update check_documentation.md

* Update text-assembly.md

* Update text-assembly.md

* new name

* new example

* Update text-assembly.md

* Prefer RETURNING to EXPORTING (#418)

* new check

* Update changelog.txt

* exceptional cases

* Update check_documentation.md

* Create prefer-returning-to-exporting.md

* Delete prefer-returning-to-exporting.md

* Create prefer-returning-to-exporting.md

* renaming file

* Update prefer-returning-to-exporting.md

* Variable "statement" not used

* IF in IF. Use IF cond1 AND cond2 instead

* adding example

* Update equals-sign-chaining.md (#423)

* Avoid Default Key (#414)

* new check

* skip comments and pragmas

* Update check_documentation.md

* Create avoid-default-key.md

* Update changelog.txt

* Make messages translatable (#428)

* implements #420

* Update check_documentation.md

* Update check_documentation.md

* renaming

* Create message-translation.md

* new tests

* Update changelog.txt

* Update check_documentation.md

* Update message-translation.md

* simple-cspell (#432)

* adding tool

* Create main.yml

* Update main.yml

* Update main.yml

* Update main.yml

* Update main.yml

* Create main.yml

* Create .cspell.json

* Update main.yml

* Update main.yml

* Delete .cspell.json

* Create cspell.json

* Update main.yml

* Delete cspell.json

* Create cspell.json

* Update main.yml

* Update cspell.json

* Update cspell.json

* fixing typos

* Delete .github/actions/spelling directory

* Delete spelling.yml

* typos

* typo

* Update cspell.json

* master => main

* typos

* Update cspell.json

* Update cspell.json

* Update cspell.json

* Update main.yml

* Rename cspell.json to .cspell.json

* Update bug-report.md

* Update README.md

* Update README.md

* style guide -> clean abap

* style guide -> clean abap

* short urls

* Update README.md

* Update check-in-loop.md

* Make Messages Easy to Find (#426)

* new check

* Escape SQL host variables

* Line break multiple parameters

* fixing hardcoded msgs

* Update changelog.txt

* Update check_documentation.md

* fixing false positives

* Create undetectable-message-statement.md

* Update undetectable-message-statement.md

* Update .cspell.json

* renaming

* Update check_documentation.md

* Update and rename undetectable-message-statement.md to message-easy-to-find.md

* Update message-easy-to-find.md

* Fix syntax errors in code example (#435)

method->methods
definition public
c is not a valid returning parameter (not fully typed)

Co-authored-by: Eugen Günther <[email protected]>

* Wrong pragma in example code (#434)

Co-authored-by: Eugen Günther <[email protected]>

* Update changelog.txt

Adding fixes into the changelog:
#434
#435

* Comment Usage Bug (#438)

* enhancements

* Missing space between string or character literal and parentheses

* fixing issue detected in 1.15.0 (#439)

* Update check_documentation.md

Co-authored-by: Eugen Günther <[email protected]>
Co-authored-by: Frederik Hudák <[email protected]>
Co-authored-by: Jan Ježek <[email protected]>

Author: 4 people

.cspell.json

@@ -0,0 +1,62 @@
+// cSpell Settings
+{
+  // Version of the setting file.  Always 0.1
+  "version": "0.1",
+  // language - current active spelling language
+  "language": "en",
+  // words - list of words to be always considered correct
+  "words": [
+    "ABAP",
+    "abap",
+    "tadir",
+    "Cyclomatic",
+    "cyclomatic",
+    "mandt",
+    "delflag",
+    "ENDLOOP",
+    "ENDMETHOD",
+    "symsgty",
+    "INTF",
+    "ENDINTERFACE",
+    "ENDTRY",
+    "ENDCLASS",
+    "DDIC",
+    "AMDP",
+    "OSQL",
+    "aunit",
+    "ENDCATCH",
+    "xsdbool",
+    "SHORTDUMP",
+    "SUBRC",
+    "tabix",
+    "imgs",
+    "prio",
+    "SCII",
+    "SCI",
+    "SATC",
+    "SICF",
+    "HANA",
+    "SAP",
+    "CLAS",
+    "ENDFORM",
+    "modularization",
+    "ENDFUNCTION",
+    "ENDDO",
+    "NMBR",
+    "OPTL",
+    "ENDCASE",
+    "itab",
+    "reimplement",
+    "USAG",
+    "msgid",
+    "msgty",
+    "msgno",
+    "UNDETEC"
+  ],
+  // flagWords - list of words to be always considered incorrect
+  // This is useful for offensive words and common spelling errors.
+  // For example "hte" should be "the"
+  "flagWords": [
+    "hte"
+  ]
+}

.github/ISSUE_TEMPLATE/bug-report.md

@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-> 💡 Code pal for ABAP follows the [Clean ABAP](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md) style guide. If the issue relates to coding style, please submit it [here](https://github.com/SAP/styleguides/issues). 
+> 💡 Code pal for ABAP follows the [Clean ABAP](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md). If the issue relates to coding style, please submit it [here](https://github.com/SAP/styleguides/issues). 
 
 **Check Name**
 > Use this section to identify the affected Check.

.github/workflows/main.yml

@@ -0,0 +1,14 @@
+name: lint
+
+"on":
+  pull_request:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zwaldowski/cspell-action@v1
+        with:
+          config: .cspell.json
+          paths: "**/*.md"

README.md

@@ -4,7 +4,7 @@
 [![license](https://img.shields.io/github/license/SAP/code-pal-for-abap)](LICENSE)
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/code-pal-for-abap)](https://api.reuse.software/info/github.com/SAP/code-pal-for-abap)
 
-Based on the [Clean ABAP](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md) style guide, this tool contains a set of checks to guarantee the [Clean ABAP](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md) adherence.  
+Based on the [Clean ABAP](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md), this tool contains a set of checks to guarantee the [Clean ABAP](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md) adherence.  
 Together, we both support you in writing a clean ABAP code. 
 
 ❣️ It's **free** and **open-source**.

changelog.txt

@@ -12,6 +12,20 @@ Upgrade Note
 ------------------
 Whenever you upgrade code pal for ABAP, it is highly recommended to execute the Y_CI_CHECK_REGISTRATION report to activate/reactivate the Checks (SE38 transaction) and regenerate the respective Code Inspector Variant (SCI transaction)
 
+2021-05-XX v.1.15.0
+------------------
++ Make Messages Easy to Find (#419)
++ Make Messages Translatable (#420)
++ Avoid DEFAULT KEY (#413)
++ Prefer RETURNING to EXPORTING (#417)
++ Use | to assemble text (#287)
+* Nesting Depth - Macro (#422)
+* False-Positive: Assert=>Fail (#400)
+* False-Positive: Generated Comments (#402)
+* CALL METHOD Usage does not check if the method call is dynamic (#396)
+* Pragma in the docu for "Interface in Class"
+* Code example in the docu for "Method Ouput Parameter"
+
 2021-05-07 v.1.14.2
 ------------------
 * Y_CHECK_UNIT_TEST_ASSERT: False-positive (#388)

docs/check_documentation.md

@@ -4,6 +4,7 @@
 
 ## Check Documentation
 
+- [Avoid DEFAULT KEY](checks/avoid-default-key.md)
 - [Boolean Input Parameter](checks/boolean-input-parameter.md)
 - [CALL Method Usage](checks/call-method-usage.md)
 - [Chain Declaration Usage](checks/chain-declaration-usage.md)
@@ -26,9 +27,11 @@
 - [External Call in Unit Test](checks/external-call-in-ut.md)
 - [FORM Routine Usage](checks/form-routine.md)
 - [FUNCTION Module Usage](checks/function-routine.md)
-- [Missing Interface](checks/interface-in-class.md)
 - [Magic Number Usage](checks/magic-number.md)
+- [Message Easy To Find](checks/message-easy-to-find.md)
+- [Message Translation](checks/message-translation.md)
 - [Method Return Bool](checks/method-return-bool.md)
+- [Missing Interface](checks/interface-in-class.md)
 - [Nesting Depth](checks/maximum-nesting-depth.md)
 - [Non-Class Exception Usage](checks/non-class-exception.md)
 - [Number of Attributes](checks/number-attributes.md)
@@ -39,6 +42,7 @@
 - [Number of Public Attributes](checks/number-public-attributes.md)
 - [Number of Output Parameter](checks/number-output-parameter.md)
 - [Prefer CASE to ELSEIF](checks/prefer-case-to-elseif.md)
+- [Prefer RETURNING to EXPORTING](checks/prefer-returning-to-exporting.md)
 - [Prefer IS NOT to NOT IS](checks/prefer-is-not-to-not-is.md)
 - [Prefer LINE_EXISTS or LINE_INDEX to READ TABLE or LOOP AT](checks/prefer-line-exists.md)
 - [Prefer NEW to CREATE OBJECT](checks/prefer-new-to-create-object.md)
@@ -51,5 +55,6 @@
 - [Scope of Variable](checks/scope-of-variable.md)
 - [Self-Reference](checks/self-reference.md)
 - [TEST-SEAM Statement Usage](checks/test-seam-usage.md)
+- [Text Assembly](checks/text-assembly.md)
 - [Unit-Test Coverages (Statement, Branch and Procedure)](checks/unit-test-coverages.md)
 - [Unit-Test Assert Validator](checks/unit_test_assert.md)

docs/checks/avoid-default-key.md

@@ -0,0 +1,63 @@
+[code pal for ABAP](../../README.md) > [Documentation](../check_documentation.md) > [Avoid DEFAULT KEY](avoid-default-key.md)
+
+## Avoid DEFAULT KEY
+
+### What is the Intent of the Check?
+
+> Default keys are often only added to get the newer functional statements working. The keys themselves in fact are usually superfluous and waste resources for nothing. They can even lead to obscure mistakes because they ignore numeric data types. The `SORT` and `DELETE ADJACENT` statements without explicit field list will resort to the primary key of the internal table, which in case of usage of `DEFAULT KEY` can lead to very unexpected results when having e.g. numeric fields as component of the key, in particular in combination with `READ TABLE ... BINARY` etc.
+
+Source: [Clean ABAP - Avoid DEFAULT KEY](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key).
+
+Therefore, this check searches for the internal table definitions which forces the use of the default key. 
+
+### How to solve the issue?
+
+> Either specify the key components explicitly  
+> ```abap
+> DATA itab1 TYPE STANDARD TABLE OF row_type WITH NON-UNIQUE KEY comp1 comp2.
+> ``` 
+> or resort to `EMPTY KEY` if you don't need a key at all.  
+> ```abap
+> DATA itab1 TYPE STANDARD TABLE OF row_type WITH EMPTY KEY.
+> ```
+
+Source: [Clean ABAP - Avoid DEFAULT KEY](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key).
+
+### What to do in case of exception?
+
+In exceptional cases, you can suppress this finding by using the pseudo comment `"#EC DEFAULT_KEY` which has to be placed after the declaration:
+
+```abap
+CLASS-DATA itab1 TYPE STANDARD TABLE OF row_type WITH DEFAULT KEY. "#EC DEFAULT_KEY
+```
+```abap
+DATA itab1 TYPE STANDARD TABLE OF row_type WITH DEFAULT KEY. "#EC DEFAULT_KEY
+```
+```abap
+TYPES: BEGIN OF type1, ' )
+         non_unique TYPE STANDARD TABLE OF row_type WITH NON-UNIQUE KEY object,
+         default_key TYPE STANDARD TABLE OF row_type WITH DEFAULT KEY, "#EC DEFAULT_KEY'
+         empty_key TYPE STANDARD TABLE OF row_type WITH EMPTY KEY,
+       END OF type1. 
+```
+
+### Example
+
+Before the check:
+
+```abap
+DATA itab1 TYPE STANDARD TABLE OF row_type WITH DEFAULT KEY.
+```
+
+After the check:
+
+```abap
+DATA itab1 TYPE STANDARD TABLE OF row_type WITH NON-UNIQUE KEY comp1 comp2.
+```
+```abap
+DATA itab1 TYPE STANDARD TABLE OF row_type WITH EMPTY KEY.
+```
+
+### Further Readings & Knowledge
+
+* [Clean ABAP: Avoid DEFAULT KEY](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#avoid-default-key)

docs/checks/boolean-input-parameter.md

@@ -37,4 +37,4 @@ After the check:
 
 ### Further Readings & Knowledge
 
-* [ABAP Styleguides on Clean Code: Boolean Input Parameter(s)](https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#split-method-instead-of-boolean-input-parameter)
+* [Clean ABAP: Boolean Input Parameter(s)](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#split-method-instead-of-boolean-input-parameter)

docs/checks/call-method-usage.md

@@ -40,4 +40,4 @@ class->method( ).
 
 ### Further Readings & Knowledge
 
-* [ABAP Styleguides on Clean Code: Avoid CALL METHOD Statement](https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#prefer-functional-to-procedural-calls)
+* [Clean ABAP: Avoid CALL METHOD Statement](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-functional-to-procedural-calls)

docs/checks/chain-declaration-usage.md

@@ -51,4 +51,4 @@ DATA a            TYPE c.
 
 ### Further Readings & Knowledge
 
-* [ABAP Styleguides on Clean Code: Do not chain up-front declarations](https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#do-not-chain-up-front-declarations)
+* [Clean ABAP: Do not chain up-front declarations](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#do-not-chain-up-front-declarations)