MagpieBridge

Was ist Magpiebridge?

Magpiebridge ist ein Framework zum Integrieren statischer Analysen in IDEs und Redakteure mit dem Sprachserverprotokoll. Magpiebridge ist nicht auf LSP beschränkt, sondern nutzt auch das HTTP, um Webseiten in einer IDE anzuzeigen. Dies ermöglicht eine neue Ebene der unterstützenden Visualisierung und einer anpassbaren Benutzeroberfläche, mit der der Benutzer interagieren kann. Magpiebridge ist eine Brücke zwischen Programmanalysen und Entwicklerwerkzeugen. Magpiebridge bietet eine erweiterbare Implementierung eines Sprachservers- MagpieServer , der eine Analyse ausführt. ein Standard-TextdocumentService- MagpieTextDocumentService , der gemeinsame LSP-Anfragen abwickelt; ein Standard-WorkSpaceService- MagpieWorkspaceService , der verschiedene Arten von Codeaktionen und viele andere nützliche APIs für die statische Analyse übernimmt; und neuere Projektdienste, die den Projektumfang (Quellcode -Pfad, Bibliothekscode -Pfad, Klassenpfad usw.) beheben, die durch ganze Programmanalysen konsumiert werden können. Weitere Informationen finden Sie im Folgenden:

• Ein Tutorial (auf der Seite angehängte Folien) am Stolz 2022.
• Auf SOAP 2020 über Magpiebridge gibt es einen Vortrag. Die Folien des Gesprächs finden Sie hier.
• Tutorials auf unserer Wiki -Seite.
• Das Papier Magpiebridge: Ein allgemeiner Ansatz zur Integration statischer Analysen in IDES und Redakteure (ECOOP 2019).
• Ein Poster ist ebenfalls verfügbar.

Für Soot -Benutzer finden Sie einen Irconverter unter https://github.com/magpiebridge/irconverter für die Konvertierung von Wala IR in Soot IR, wenn Sie den Java -Quellcode mit Ruß analysieren möchten.

Zitieren das Forschungspapier

Für die wissenschaftliche Verwendung zitieren bitte das Papier [Bibtex].

Warum heißt es Magpiebridge?

In einer chinesischen Legende verlieben sich ein Mensch und eine Fee in die Liebe, aber diese Liebe verärgert die Götter, die sie auf gegenüberliegenden Seiten der Milchstraße trennen. Am siebten Tag des siebten Mondmonats pro Jahr bilden Tausende von Elstern jedoch eine Brücke, die in Chinesisch und Queqiao in Pinyin bezeichnet wird und es den Liebenden ermöglicht, sich zu treffen. Wir verwenden Magpiebridge als Metapher für ein System, das eine willkürliche statische Analyse mit einer willkürlichen IDE verbindet.

Verwenden Sie Magpiebridge in Ihrem Maven -Projekt

Sie können entweder

1. Seit Version 0.1.0 ist Magpiebridge auf Maven Central erhältlich. Fügen Sie einfach die folgenden Zeilen in Ihre pom.xml ein.

 <dependency>
    <groupId>com.github.magpiebridge</groupId>
    <artifactId>magpiebridge</artifactId>
    <version>0.1.5</version>
</dependency>

Die alten Versionen bis zu 0,0,9 Magpiebridge wurden in der GitHub -Paketregistrierung veröffentlicht. Sie können die Version verwenden, indem Sie Ihren folgenden Zeilen zu Ihrem pom.xml hinzufügen (siehe alle Github -Paket) und Ihr GitHub -Zugriffstoken einrichten, indem Sie diese Anweisungen befolgen.

 <dependencies>
  <dependency>
    <groupId>magpiebridge</groupId>
    <artifactId>magpiebridge</artifactId>
    <version>0.0.9</version>
  </dependency>
</dependencies>

<repositories>
  <repository>
    <id>github</id>
    <name>GitHub MagpieBridge Apache Maven Packages</name>
    <url>https://maven.pkg.github.com/MagpieBridge/MagpieBridge</url>
  </repository>
</repositories>

2. Oder bauen Sie Magpiebridge alleine
   • Schauen Sie sich den Entwicklerzweig mit git clone -b develop https://github.com/MagpieBridge/MagpieBridge.git
   • Führen Sie mvn install im Projekt Root -Verzeichnis aus, um das Tool zu erstellen und alle Tests auszuführen. Um Tests zu überspringen, führen Sie mvn install -DskipTests aus.

Tutorials

• Überprüfen Sie die Tutorials, um Ihr erstes Projekt mit Magpiebridge zu erstellen? Aktualisiert ?

Integrierte statische Analysen mit Magpiebridge

• Secucheck
• MAGPIEBRIDGE BASED FACEBOOM in Abschluss
• Cognicrypt aus Magpiebridge
• Magpiebridge-basierte Flowdroid

Bauen Sie Magpiebridge in ide

1. Importieren Sie einfach das Projekt als Maven -Projekt in Ihrer IDE, Maven sollte sich um alle erforderlichen Abhängigkeiten kümmern. Für Sonnenfinsternis:

 Eclipse> File> Import > Maven > Existing Maven Projects > Enter the path to your local repository > Finish

Sich beteiligen

• Pull -Anfragen sind willkommen!
• Senden Sie GitHub -Probleme für Feature -Verbesserungen, Fehler oder Dokumentationsprobleme
• Bitte formatieren Sie den Code mit mvn com.coveo:fmt-maven-plugin:format vor git push

Mitwirkende

Vielen Dank an diese wunderbaren Menschen (Emoji -Schlüssel):

Linghui Luo ?	Julian Dolby ?	Christian Brüggemann	Jonas Manuel	Markus Schmidt Euen ?	João Pereira ?	Sven Erik Vinkemeier ?
Goran Piskachev ?	Ranjith k ?	Ejardak	Challe535	Julian t

Dieses Projekt folgt der All-Contributors-Spezifikation. Beiträge jeglicher Art willkommen!

Kontakt

linghui [at] Outlook.de