clean-abap

Enforces SAP's official Clean ABAP style guide on ABAP code.

369|89|Updated Oct 19, 2018
One-click install
npx skills add https://github.com/marcellourbani/vscode_abap_remote_fs --skill clean-abap
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: clean-abap
Source: https://github.com/marcellourbani/vscode_abap_remote_fs/tree/main/client/media/skills/clean-abap
Command: npx skills add https://github.com/marcellourbani/vscode_abap_remote_fs --skill clean-abap

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures ABAP code adheres to SAP's official Clean ABAP style guide, improving code quality, maintainability, and consistency across projects.

Core Features & Use Cases

  • Code Review: Automatically checks ABAP code against Clean ABAP rules for naming, language constructs, error handling, and more.
  • Refactoring Assistance: Provides guidance on modernizing ABAP code to align with best practices.
  • Use Case: When reviewing a new ABAP development, use this Skill to identify any deviations from Clean ABAP standards before it's merged.

Quick Start

Use the clean-abap skill to review the provided ABAP code for adherence to Clean ABAP standards.

Frequently Asked Questions about clean-abap

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check my ABAP code against Clean ABAP coding standards?

To check ABAP code against Clean ABAP coding standards, submit the code for review to receive automated checks on naming conventions, modern language constructs, class design, error handling, formatting, comments, and unit testing patterns.

What are the key rules for refactoring ABAP code to modern best practices?

Refactoring ABAP code to modern best practices requires adopting specific rules for variables, tables, strings, booleans, conditions, ifs, regular expressions, classes, methods, error handling, comments, formatting, and testing as defined by SAP's official style guide.

Can I use this to review ABAP code before merging a new development?

Yes, you can review ABAP code before merging a new development to identify any deviations from Clean ABAP standards, ensuring code quality, maintainability, and consistency across projects.

What is Clean ABAP and when do I need to enforce it?

Clean ABAP is SAP's official style guide for writing, reviewing, and refactoring ABAP code. You need to enforce it to improve code quality, maintainability, and consistency across SAP projects.

Does the Clean ABAP style guide cover unit testing patterns for SAP?

Yes, the Clean ABAP style guide covers unit testing patterns for SAP alongside naming conventions, modern language constructs, class and method design, error handling, formatting, and comments.

What are the limitations of enforcing Clean ABAP coding standards?

Enforcing Clean ABAP coding standards is limited to reviewing and refactoring ABAP code specifically against SAP's official style guide, covering naming, language constructs, error handling, formatting, comments, and testing without addressing external platform integrations.