ABAP Cleaner

When opening the interactive ABAP cleaner from ADT without a prior selection, you can define a 'Default cleanup range':

• Current command: The command at the cursor position.
• Current method / declaration section / FORM etc.: The logical block containing the cursor.
• Current class: The entire CLASS definition or implementation.
• Entire code document: The whole file.

Important: If you have already selected code in the editor before opening the tool, ABAP cleaner will ignore the default range and only clean the selected statements.

The EmptyLinesWithinMethodsRule enforces consistent spacing within ABAP methods by restricting consecutive empty lines and ensuring a single empty line separates declarations from the first executable statement (or the comments preceding it).

This rule is part of the essential profile and is designed to comply with the Clean ABAP Styleguide.

For function modules, the rule preserves additional empty lines at the beginning to maintain alignment with ADT and SE37 behavior.

  METHOD empty_lines_within_methods.
    DATA lv_any_integer TYPE i.
    DATA lv_any_string  TYPE string.
    do_something( ).

    do_something_else( ).

    finish_doing_something( ).
  ENDMETHOD.

The ChainOfOneRule simplifies ABAP code by removing the colon (:) from chains that consist of only a single element. This applies to declarations (like DATA, CONSTANTS, FIELD-SYMBOLS) and non-declaration commands (like CHECK, CLEAR).

Configuration Options

You can configure where this rule is applied:

• Execute on declarations in CLASS ... DEFINITION sections: Applies the simplification within class definition blocks.
• Execute on declarations in methods etc.: Applies the simplification within method implementations and other local blocks.
• Execute on non-declaration commands: Applies the simplification to commands that are not part of a declaration (e.g., CHECK, CLEAR).

The AlignSelectClausesRule aligns keywords such as SELECT, FROM, FIELDS, WHERE, GROUP BY, etc., within the main or sub-query clauses of ABAP SQL statements (SELECT, WITH, and OPEN CURSOR).

Note on related rules: This rule focuses on the alignment of the clause keywords themselves. It does not handle the alignment of field lists, joins, or logical expressions. For those, use the following dedicated rules:

• Align SELECT ... FROM ... JOIN
• Align SELECT lists
• Align logical expressions

The AlignSelectFromRule aligns the FROM clause, including various JOIN operations, within ABAP SQL statements such as SELECT, WITH, and OPEN CURSOR.

Behavioral Notes:

• One-liners: Statements written on a single line are preserved and not modified.
• Logical Expressions: Expressions following JOIN ... ON are not handled by this rule; they are instead managed by the Align logical expressions rule.
• Hierarchies: HIERARCHY... ( ) structures are left unchanged.
• Prerequisite: This rule assumes that the positions of keywords like FROM, FIELDS, and WHERE have already been established by the Align SELECT clauses rule.

The Align SELECT lists rule formats field lists within ABAP SQL statements to improve readability. It aligns the fields following specific keywords in SELECT, WITH, and OPEN CURSOR statements.

Targeted Keywords:

• SELECT
• FIELDS
• ORDER BY
• GROUP BY
• INTO ( ... )

Note: GROUPING SETS ( ... ) is explicitly excluded from this rule and remains unchanged.

The DdlSpacesAroundBracketsRule ensures consistent spacing around brackets [...] and parentheses (...) within Data Definition Language (DDL) files. It targets cardinality in associations, path expressions, built-in functions, ABAP types, and arithmetic expressions.

Note: Spacing within annotations is managed by the Standardize annotation layout rule, not this one.

The NeedlessParenthesesRule removes unnecessary parentheses from logical expressions in ABAP code.

Side Effect: If parentheses are removed, the 'Align logical expressions' rule is automatically executed, even if it is otherwise deactivated.

Caution: While removing parentheses does not change the logic, it may occasionally reduce code readability. Use the available options to balance cleanliness and clarity.