Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sap/code-pal-for-abap
code pal for ABAP is a highly configurable engine, fully integrated into the ABAP development framework ensuring Cloud’s built-in quality.
https://github.com/sap/code-pal-for-abap
abap abapgit atc check clean-code code-inspector inspector open-source quality sap
Last synced: about 12 hours ago
JSON representation
code pal for ABAP is a highly configurable engine, fully integrated into the ABAP development framework ensuring Cloud’s built-in quality.
- Host: GitHub
- URL: https://github.com/sap/code-pal-for-abap
- Owner: SAP
- License: apache-2.0
- Created: 2020-04-02T14:05:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-29T11:55:01.000Z (23 days ago)
- Last Synced: 2024-12-21T15:05:00.249Z (about 12 hours ago)
- Topics: abap, abapgit, atc, check, clean-code, code-inspector, inspector, open-source, quality, sap
- Language: ABAP
- Homepage:
- Size: 2.95 MB
- Stars: 355
- Watchers: 25
- Forks: 67
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# code pal for ABAP
[](changelog.txt)
[](LICENSE)
[](https://api.reuse.software/info/github.com/SAP/code-pal-for-abap)
This tool provides a set of checks to help adhering to the [Clean ABAP style guide](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md). While not all recommendations from the guide can be checked by static code analysis and in certain situations strict adherence to the guide might not be recommended, this provides robust automated support at least for a subset of recommendations.
It's **free** and **open-source**.
This is the legacy version supporting local checks on check systems starting with SAP_BASIS release 7.40. For the remote-enabled version for ABAP Cloud, see the [Cloud Edition](https://github.com/SAP/code-pal-for-abap-cloud).
## Features
- Supported by Code Inspector (`SCI` / `SCII`) and ABAP Test Cockpit (ATC) (`SE80` / Eclipse);
- Ignores automatically generated code;
- Supports exemptions;
- Provides a new user-friendly way to create variants ([Profile Management](pages/how-to-configure.md));
- Allows configuration based on:
- Threshold;
- Severity / Priority;
- Validity for productive code, test code, or both;
- Validity for objects created since a specific date;
- Validity period;
- Allow / Deny exemption.
Severities set to `Notification` / `Priority 3` by default ([#368](https://github.com/SAP/code-pal-for-abap/issues/368)).
## Set of Checks
- [Check Documentation](docs/check_documentation.md)
## Dependencies
- Since Version 1.00 - SAP NetWeaver **7.40 SP8** or higher
- [abapGit](https://docs.abapgit.org/)
## How-to Guides
- **[Install](pages/how-to-install.md)**
- **[Configure](pages/how-to-configure.md)**
- **[Execute](pages/how-to-execute.md)**
- **[Contribute](pages/how-to-contribute.md)**
## Further Documentation
- [Known issues](pages/known-issues.md)
## Recommended Readings
- [Clean ABAP](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md)
- [ABAP 7.40 Quick Reference](https://blogs.sap.com/2015/10/25/abap-740-quick-reference/)
- [ABAP Built-in Functions](https://blogs.sap.com/2015/11/30/reminder-abap-built-in-functions/)
- [ABAP - Release-Specific Changes](https://help.sap.com/doc/abapdocu_latest_index_htm/latest/en-US/abennews.htm)
## Recommended Courses
- [Writing Testable Code for ABAP](https://open.sap.com/courses/wtc1/items/2gzG0sRlN1yjkTUREB02L9)
- [ABAP Development for S/4HANA](https://open.sap.com/courses/a4h1)