abaplint rules documentation
abaplint can be configured by placing a abaplint.json file in the root of the git repository. If no configuration file is found, the default configuration will be used, which contains have all rules enabled.Get default configuration by running abaplint -d > abaplint.json
abaplint-clean-code contains rule documentation as well as abaplint.json definitions which attempt to align abaplint with the official Clean ABAP styleguide.
104 Rules
5
5
1
14
8
22
12
29
abapdoc - Check abapdoc
Various checks regarding abapdoc. Base rule checks for existence of abapdoc for public class methods and all interface methods.
Various checks regarding abapdoc. Base rule checks for existence of abapdoc for public class methods and all interface methods.
allowed_object_naming - Allowed object naming
Enforces basic name length and namespace restrictions, see note SAP 104010
Naming
Enforces basic name length and namespace restrictions, see note SAP 104010
ambiguous_statement - Check for ambigious statements
Checks for ambiguity between deleting or modifying from internal and database table Add "TABLE" keyword or "@" for escaping SQL variables
Checks for ambiguity between deleting or modifying from internal and database table Add "TABLE" keyword or "@" for escaping SQL variables
begin_single_include - BEGIN contains single INCLUDE
Finds TYPE BEGIN with just one INCLUDE TYPE, and DATA with single INCLUDE STRUCTURE
Finds TYPE BEGIN with just one INCLUDE TYPE, and DATA with single INCLUDE STRUCTURE
chain_mainly_declarations - Chain mainly declarations
Chain mainly declarations, allows chaining for the configured statements, reports errors for other statements.
Chain mainly declarations, allows chaining for the configured statements, reports errors for other statements.
check_abstract - Check abstract methods and classes
Checks abstract methods and classes: - class defined as abstract and final, - non-abstract class contains abstract methods
Checks abstract methods and classes: - class defined as abstract and final, - non-abstract class contains abstract methods
check_ddic - Check DDIC
Checks the types of DDIC objects can be resolved, the namespace of the development/errors can be configured in "errorNamespace"
Syntax
Checks the types of DDIC objects can be resolved, the namespace of the development/errors can be configured in "errorNamespace"
check_no_handler_pragma - Check if NO_HANDLER can be removed
Checks NO_HANDLER pragmas that can be removed
Checks NO_HANDLER pragmas that can be removed
check_transformation_exists - Check transformation exists
Checks that used XSLT transformations exist.
Syntax
Checks that used XSLT transformations exist.
class_attribute_names - Class attributes naming
Allows you to enforce a pattern, such as a prefix, for class variable names.
Naming
Allows you to enforce a pattern, such as a prefix, for class variable names.
cloud_types - Check cloud types
Checks that the package does not contain any object types unsupported in cloud ABAP.
Checks that the package does not contain any object types unsupported in cloud ABAP.
colon_missing_space - Colon missing space
Checks for missing spaces after colons in chained statements.
Whitespace,Quickfix
Checks for missing spaces after colons in chained statements.
constructor_visibility_public - Check constructor visibility is public
Constructor must be placed in the public section, even if the class is not CREATE PUBLIC.
Styleguide
Constructor must be placed in the public section, even if the class is not CREATE PUBLIC.
contains_tab - Code contains tab
Checks for usage of tabs (enable to enforce spaces)
Whitespace,Quickfix,Styleguide
Checks for usage of tabs (enable to enforce spaces)
definitions_top - Place definitions in top of routine
Checks that definitions are placed at the beginning of methods.
Checks that definitions are placed at the beginning of methods.
double_space - Double space
Checks that only a single space follows certain common statements.
Whitespace,Quickfix
Checks that only a single space follows certain common statements.
empty_line_in_statement - Find empty lines in statements
Checks that statements do not contain empty lines.
Checks that statements do not contain empty lines.
empty_statement - Remove emty statement
Checks for empty statements (an empty statement is a single dot)
Quickfix
Checks for empty statements (an empty statement is a single dot)
exit_or_check - Find EXIT or CHECK outside loops
Detects usages of EXIT or CHECK statements outside of loops. Use RETURN to leave procesing blocks instead.
Styleguide
Detects usages of EXIT or CHECK statements outside of loops. Use RETURN to leave procesing blocks instead.
exporting - EXPORTING can be omitted
Detects EXPORTING statements which can be omitted.
Styleguide,Quickfix
Detects EXPORTING statements which can be omitted.
forbidden_pseudo_and_pragma - Forbidden pseudo comments and pragma
Checks for unwanted pseudo comments and pragma
Quickfix
Checks for unwanted pseudo comments and pragma
fully_type_constants - Fully type constants
Checks constants for full typing - no implicit typing allowed.
Checks constants for full typing - no implicit typing allowed.
functional_writing - Use functional writing
Detects usage of call method when functional style calls can be used.
Styleguide
Detects usage of call method when functional style calls can be used.
global_class - Global class checks
Checks related to global classes. * global classes must be in own files * file names must match class name * global classes must be global definitions
Syntax
Checks related to global classes. * global classes must be in own files * file names must match class name * global classes must be global definitions
if_in_if - IF in IF
Detects nested ifs which can be refactored to a single condition using AND.
Styleguide
Detects nested ifs which can be refactored to a single condition using AND.
implement_methods - Implement methods
Checks for abstract methods and methods from interfaces which need implementing.
Syntax
Checks for abstract methods and methods from interfaces which need implementing.
in_statement_indentation - In-statement indentation
Checks alignment within block statement declarations which span multiple lines, such as multiple conditions in IF statements.
Whitespace,Quickfix
Checks alignment within block statement declarations which span multiple lines, such as multiple conditions in IF statements.
inline_data_old_versions - Inline data, old versions
Checks for inline data declarations in older releases. Only active for versions less than v740sp02
Syntax
Checks for inline data declarations in older releases. Only active for versions less than v740sp02
keep_single_parameter_on_one_line - Keep single parameters on one line
Keep single parameter calls on one line
Whitespace,Styleguide
Keep single parameter calls on one line
keyword_case - Keyword case
Checks that keywords have the same case. Non-keywords must be lower case.
Styleguide
Checks that keywords have the same case. Non-keywords must be lower case.
line_break_multiple_parameters - Line break multiple parameters
Line break multiple parameters
Whitespace,Styleguide,Quickfix
Line break multiple parameters
line_break_style - Makes sure line breaks are consistent in the ABAP code
Enforces LF as newlines in ABAP files abapGit does not work with CRLF
Whitespace
Enforces LF as newlines in ABAP files abapGit does not work with CRLF
line_only_punc - Line containing only punctuation
Detects lines containing only punctuation.
Styleguide,Quickfix
Detects lines containing only punctuation.
local_class_naming - Local class naming conventions
Allows you to enforce a pattern, such as a prefix, for local class names.
Naming
Allows you to enforce a pattern, such as a prefix, for local class names.
local_testclass_location - Local testclass location
Checks that local test classes are placed in the test include.
Checks that local test classes are placed in the test include.
local_variable_names - Local variable naming conventions
Allows you to enforce a pattern, such as a prefix, for local variables, constants and field symbols. Regexes are case-insensitive.
Naming
Allows you to enforce a pattern, such as a prefix, for local variables, constants and field symbols. Regexes are case-insensitive.
max_one_statement - Max one statement per line
Checks that each line contains only a single statement.
Styleguide,Quickfix
Checks that each line contains only a single statement.
method_parameter_names - Method parameter naming conventions
Allows you to enforce a pattern, such as a prefix, for method parameter names
Naming
Allows you to enforce a pattern, such as a prefix, for method parameter names
mix_returning - Mix of returning and exporting
Checks that methods don't have a mixture of returning and exporting/changing parameters
Styleguide
Checks that methods don't have a mixture of returning and exporting/changing parameters
newline_between_methods - New line between methods
Checks for newlines between method implementations.
Whitespace
Checks for newlines between method implementations.
no_public_attributes - No public attributes
Checks that classes and interfaces don't contain any public attributes. Exceptions are excluded from this rule.
Styleguide
Checks that classes and interfaces don't contain any public attributes. Exceptions are excluded from this rule.
object_naming - Object naming conventions
Allows you to enforce a pattern, such as a prefix, for object names
Naming
Allows you to enforce a pattern, such as a prefix, for object names
parser_error - Parser error
Checks for syntax not recognized by abaplint. See recognized syntax at https://syntax.abaplint.org
Syntax
Checks for syntax not recognized by abaplint. See recognized syntax at https://syntax.abaplint.org
parser_missing_space - Parser Error, missing space
In special cases the ABAP language allows for not having spaces before or after string literals. This rule makes sure the spaces are consistently required across the language.
Syntax
In special cases the ABAP language allows for not having spaces before or after string literals. This rule makes sure the spaces are consistently required across the language.
prefer_inline - Prefer Inline Declarations
Prefer inline to up-front declarations. Activates if language version is v740sp02 or above. Variables must be local(METHOD or FORM). No generic or void typed variables. First position used must be a full/pure write.
Styleguide,Upport,Experimental,Quickfix
Prefer inline to up-front declarations. Activates if language version is v740sp02 or above. Variables must be local(METHOD or FORM). No generic or void typed variables. First position used must be a full/pure write.
prefer_returning_to_exporting - Prefer RETURNING to EXPORTING
Prefer RETURNING to EXPORTING. Generic types cannot be RETURNING.
Styleguide
Prefer RETURNING to EXPORTING. Generic types cannot be RETURNING.
prefix_is_current_class - Prefix is current class
Reports errors if the current class or interface references itself with "current_class=>"
Styleguide,Quickfix
Reports errors if the current class or interface references itself with "current_class=>"
remove_descriptions - Remove descriptions
Ensures you have no descriptions in metadata of methods, parameters, etc. Class descriptions are required, see rule description_empty. Consider using ABAP Doc for documentation.
Ensures you have no descriptions in metadata of methods, parameters, etc. Class descriptions are required, see rule description_empty. Consider using ABAP Doc for documentation.
rfc_error_handling - RFC error handling
Checks that exceptions 'system_failure' and 'communication_failure' are handled in RFC calls
Checks that exceptions 'system_failure' and 'communication_failure' are handled in RFC calls
selection_screen_naming - Selection screen naming conventions
Allows you to enforce a pattern, such as a prefix, for selection-screen variable names.
Naming
Allows you to enforce a pattern, such as a prefix, for selection-screen variable names.
sequential_blank - Sequential blank lines
Checks that code does not contain more than the configured number of blank lines in a row.
Whitespace,Quickfix
Checks that code does not contain more than the configured number of blank lines in a row.
short_case - Short CASE
Checks for CASE statements which have fewer than the specified number of branches
Checks for CASE statements which have fewer than the specified number of branches
sicf_consistency - SICF consistency
Checks the validity of ICF services: * Class defined in handler must exist * Class must not have any syntax errors * Class must implement interface IF_HTTP_EXTENSION
Checks the validity of ICF services: * Class defined in handler must exist * Class must not have any syntax errors * Class must implement interface IF_HTTP_EXTENSION
space_before_colon - Space before colon
Checks that there are no spaces in front of colons in chained statements.
Whitespace
Checks that there are no spaces in front of colons in chained statements.
space_before_dot - Space before dot
Checks for extra spaces before dots at the ends of statements
Whitespace,Quickfix
Checks for extra spaces before dots at the ends of statements
sql_escape_host_variables - Escape SQL host variables
Escape SQL host variables, from 740sp05
Upport,Styleguide
Escape SQL host variables, from 740sp05
superclass_final - Super class final
Checks that classes which are inherited from are not declared as FINAL.
Syntax
Checks that classes which are inherited from are not declared as FINAL.
tabl_enhancement_category - TABL enhancement category must be set
Checks that tables do not have the enhancement category 'not classified'
Checks that tables do not have the enhancement category 'not classified'
unknown_types - Unknown types
Enables check for unknown data types, respects errorNamespace
Experimental,Syntax
Enables check for unknown data types, respects errorNamespace
use_bool_expression - Use boolean expression
Use boolean expression, xsdbool from 740sp08 and up, boolc from 702 and up
Upport,Styleguide
Use boolean expression, xsdbool from 740sp08 and up, boolc from 702 and up
when_others_last - WHEN OTHERS last
Checks that WHEN OTHERS is placed the last within a CASE statement.
Checks that WHEN OTHERS is placed the last within a CASE statement.
whitespace_end - Whitespace at end of line
Checks for redundant whitespace at the end of each line.
Whitespace,Quickfix
Checks for redundant whitespace at the end of each line.