https://github.com/frehu/abaplint-clean-code

Abaplint.json example configs according to ABAP clean code guidelines
https://github.com/frehu/abaplint-clean-code

Last synced: about 2 months ago
JSON representation

Abaplint.json example configs according to ABAP clean code guidelines

• Host: GitHub
• URL: https://github.com/frehu/abaplint-clean-code
• Owner: FreHu
• License: unlicense
• Created: 2019-08-15T07:00:00.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-20T15:39:11.000Z (over 4 years ago)
• Last Synced: 2025-02-13T08:54:06.398Z (4 months ago)
• Homepage:
• Size: 95.7 KB
• Stars: 18
• Watchers: 5
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# abaplint-clean-code

Abaplint rule overview and definitions according to ABAP clean code guidelines and best practices.

[Clean config](./configs/clean/abaplint.json) - rules are picked in an attempt to match the Clean ABAP styleguide.

[Full config](./configs/full/abaplint.json) - example of config with every rule included

Rule documentation can be found on https://rules.abaplint.org/.

You can also find about the list of rules interactively by editing your `abaplint.json` using vscode. The [abaplint](https://marketplace.visualstudio.com/items?itemName=larshp.vscode-abaplint) plugin provides validation and autocompletion according to the [schema](https://schema.abaplint.org/schema.json) which is generated automatically from docstrings in the code.

![vscode schema autocomplete](./autocompletion.png)

## about abaplint

abaplint is an open source reimplementation of the ABAP parser written in Typescript. It works without a SAP system and is meant to be used on code serialized using abapGit. It is meant to be used in addition to, not instead of other checks such as ATC. 

Make sure to visit https://github.com/abaplint/abaplint for more information about how to get it running and https://abaplint.org/ for some cool stuff like statistics of open source ABAP projects, an interactive abaplint playground or diagrams of ABAP syntax.