https://github.com/abaplint/abaplint-sci-client

ABAP part for running abaplint on ABAP backend
https://github.com/abaplint/abaplint-sci-client

abap abap-test-cockpit abaplint code-inspector hacktoberfest

Last synced: 26 days ago
JSON representation

ABAP part for running abaplint on ABAP backend

• Host: GitHub
• URL: https://github.com/abaplint/abaplint-sci-client
• Owner: abaplint
• License: mit
• Created: 2020-01-05T12:58:03.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T13:23:10.000Z (about 2 months ago)
• Last Synced: 2024-09-26T13:21:02.664Z (about 1 month ago)
• Topics: abap, abap-test-cockpit, abaplint, code-inspector, hacktoberfest
• Language: ABAP
• Homepage:
• Size: 1.04 MB
• Stars: 37
• Watchers: 11
• Forks: 20
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• abap-florilegium - abaplint-sci-client

README

        
# abaplint SCI client

This project enables [abaplint](https://abaplint.org) to be run in the context of SAP Code Inspector (SCI), allowing immediate feedback to the ABAP developers in their standard editor, SE24 / SE80 / SE38 / ABAP in Eclipse. And also works seamlessly with other places where the code inspector is triggered like ABAP Test Cockpit (ATC).

 

## Overview

The integration requires two parts: The [abaplint Server](https://github.com/abaplint/abaplint-sci-server) and the abaplint Client (this project). When performing code checks through one of the supported editors or transactions, the abaplint Client will collect the necessary objects and dependencies and send them to the abaplint Server to be processed. The server responds with all of the abaplint findings, which are displayed like any other check results in the SAP tools.

![Components](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/abaplint/abaplint-sci-client/master/docs/components.iuml)

**Important:** The code under test leaves your ABAP system! Be sure to use a secure and controllable abaplint Server.

**Note:** Dependencies maintained in `abaplint.json` (in your repository) are ignored when running via SCI. Instead the dependencies are taken from the running ABAP system.

## Examples

1. ATC

![atc-overview](docs/img/sci-ex-02.png)

![atc-details](docs/img/sci-ex-04.png)

Clicking the 'Check' or 'Check message' links will display the documentation of the rule in a browser. Click on the object name in the overview or 'Display object' in the details to jump to the location in the code related to the finding.

2. SCI

![sci](docs/img/sci-ex-01.png)

Clicking the 'Info' icon next to a message will display the documentation of the rule in a browser. Double-click on a message to jump to the location in the code related to the finding.

3. abapGit

![abapgit](docs/img/sci-ex-03.png)

Click on the object name to jump to the location in the code related to the finding.

## Documentation

* [Installation](docs/installation.md)

* [Tools](docs/tools.md)

* [Exporting Dependencies](docs/export_dependencies.md)

## Blog Posts

- https://blogs.sap.com/2020/02/01/running-abaplint-from-sci-atc-adt/