agentleFS
logalitechlogalitech/abap-skills/skills/clean-abap/SKILL.md

clean-abap

Skill0 starsChanged 3 months agoMITView on GitHub

Aplica los estándares de Clean ABAP (nombres, métodos cortos, control de flujo, manejo de errores, pruebas) al escribir o refactorizar código ABAP. Úsala cuando el usuario pida revisar calidad de código ABAP, refactorizar, "clean code", nombres, o buenas prácticas de estilo.

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 3 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No silencies errores: si capturas una excepción, o la manejas o la reenvías con contexto.

    line 57
  2. Distinctive:

    No abuses de comentarios: el código debe explicarse por sí mismo.

    line 66
  3. Very specific:

    No ocultes hallazgos reales de ATC con pragmas (##NEEDED) o pseudocomentarios ("#EC ...) por comodidad.

    line 68
  4. Distinctive:

    No mezcles limpieza masiva con cambios funcionales en el mismo commit.

    line 70

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Clean ABAP

Guía práctica para escribir ABAP legible, mantenible y testeable siguiendo Clean ABAP y las herramientas del ecosistema (ABAP Cleaner, ATC). Aplica tanto a ABAP clásico como a ABAP for Cloud Development.

Cuándo y cómo usarla

  1. Identifica el objetivo: ¿revisión de calidad, refactor de un método largo, mejora de nombres o preparación para code review?
  2. Sitúa el contexto: versión de ABAP (clásico u ABAP Cloud), si hay ATC activo y con qué variante, y si el equipo usa ABAP Cleaner con un perfil compartido.
  3. Aplica las reglas de forma incremental: primero nombres y estructura, luego control de flujo y manejo de errores, y valida siempre con ATC y las pruebas unitarias antes de cerrar.

Nombres

  • Nombres descriptivos orientados al dominio, no al tipo técnico. Prefiere sales_order a it_tab o lt_data.
  • Consistencia sobre brevedad: un mismo concepto se llama igual en todo el código.
  • En objetos RAP y CDS sigue la nomenclatura OData: alias de componentes en UpperCamelCase (por ejemplo TravelId, LastChangedAt).
  • Prefijos de artefactos Z coherentes: ZI_ (interface), ZC_ (consumption), ZP_ (basic/persistencia), ZR_ (root entity).

Métodos cortos y una sola responsabilidad

Un método debe hacer una cosa. Si necesitas comentarios para separar bloques, probablemente son métodos distintos. Extrae la lógica de negocio a métodos privados con nombre expresivo.

METHOD calculate_total_price.
  DATA(discount) = get_discount_for_customer( customer_id ).
  result = apply_discount( amount   = base_amount
                           discount = discount ).
ENDMETHOD.

Control de flujo y expresiones modernas

Sustituye construcciones antiguas por expresiones. Usa variables host con @ en ABAP SQL y declaraciones en línea con DATA(...).

SELECT FROM sflight
  FIELDS carrid, connid, price, currency
  WHERE currency = @currency
  INTO TABLE @DATA(flights).

DATA(label) = COND #( WHEN flights IS INITIAL
                      THEN 'Sin resultados'
                      ELSE |{ lines( flights ) } vuelos| ).
  • Prefiere VALUE, COND, SWITCH, REDUCE y FOR frente a bucles con acumuladores manuales.
  • Evita SELECT ... ENDSELECT y cualquier acceso a base de datos dentro de un bucle.
  • Return temprano: sal del método en cuanto se cumpla una condición de salida en lugar de anidar IF.

Manejo de errores

  • Usa excepciones de clase (RAISE EXCEPTION TYPE) en lugar de códigos de retorno sy-subrc propagados a mano.
  • No silencies errores: si capturas una excepción, o la manejas o la reenvías con contexto.
  • En RAP, reporta errores por la tabla failed y mensajes por reported, nunca con MESSAGE directo dentro del behavior pool.

Herramientas de apoyo

ABAP Cleaner (plugin de Eclipse, open source) automatiza más de 95 reglas de limpieza: elimina código muerto, reordena declaraciones y moderniza sintaxis. Trabaja con perfiles compartibles (ficheros .cfj) para unificar el estilo del equipo, y ofrece modo interactivo (Ctrl + Shift + 4) para revisar cada cambio antes de aplicarlo. Combínalo con ATC (variante ABAP_CLOUD_DEVELOPMENT_DEFAULT) como filtro de calidad previo a la liberación de la orden de transporte.

Buenas prácticas y errores comunes

  • No abuses de comentarios: el código debe explicarse por sí mismo. Reserva comentarios para el porqué, no el qué.
  • Evita variables globales y estado compartido; pásalo por parámetros para mantener los métodos testeables de forma aislada.
  • No ocultes hallazgos reales de ATC con pragmas (##NEEDED) o pseudocomentarios ("#EC ...) por comodidad; úsalos solo cuando el mensaje es un falso positivo justificado.
  • Refactoriza siempre con red de seguridad: escribe o ejecuta las pruebas ABAP Unit antes de tocar el código.
  • No mezcles limpieza masiva con cambios funcionales en el mismo commit; separa refactor y feature.

Referencias

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.