abap

ABAP

Check and improve ABAP code quality using two complementary approaches:

• abaplint: Automated static analysis via CLI, checking syntax, types, and configurable rules
• Clean ABAP: Manual review against Clean ABAP style guide principles

Workflow

1. Determine check type based on user request:

   • If the user asks to lint, run abaplint, or check syntax: use abaplint
   • If the user asks for clean code review, best practices, or code quality: use Clean ABAP review
   • If unclear or the user asks for a full check: use both

2. For abaplint checks:

   • Verify abaplint is installed (npx @abaplint/cli --version or abaplint --version)
   • If not installed, install with: npm install @abaplint/cli -g
   • Check if abaplint.json exists in the project root
   • If no config exists, help the user create one (see starter configs in references/abaplint.md)
   • Run abaplint in the project root directory
   • Parse and present findings to the user

3. For Clean ABAP reviews:

   • Read the ABAP code provided by the user
   • Check against Clean ABAP categories: Names, Language, Constants, Variables, Tables, Strings, Booleans, Conditions, Ifs, Classes, Methods, Error Handling, Comments, Formatting, Testing
   • Identify violations with specific line references
   • Provide actionable recommendations with code examples
   • Prioritize issues by impact (critical, major, minor)

abaplint Quick Start

Run in project root:

abaplint

Generate default config (all rules):

abaplint -d > abaplint.json

For detailed abaplint configuration including starter configs for On-Premise, Steampunk/BTP, and HANA compatibility, read references/abaplint.md.

Clean ABAP Check Categories

Names

• Use descriptive names, snakecase, no Hungarian notation (iv, lv*, lt*)
• Nouns for classes, verbs for methods, no noise words

Language

• Prefer OO over procedural, functional over imperative
• Use modern syntax: NEW, inline declarations, table expressions