Skip to content

arktt/MagpieBridge

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

What is MagpieBridge? Build Status

MapgieBridge is a framework for integrating Static Analyses into IDEs and Editors with the Language Server Protocol. It is a part of the FutureSoot project. MagpieBridge offers a default implementation of a language server---MagpieServer which runs analysis; a default TextDocumentService--MagpieTextDocumentService which handles requests like didOpen, didChange, didSave; a default WorkspaceService--MagpieWorkspaceService which handles different kinds of code actions and many other useful APIs for static analysis. For more information, please read our paper (ECOOP 2019) MagpieBridge: A General Approach to Integrating Static Analyses into IDEs and Editors. A Poster is also available.

Why is it called MagpieBridge?

In a Chinese legend, a human and a fairy fall in love, but this love angers the gods, who separate them on opposite sides of the Milky Way. However, on the seventh day of the seventh lunar month each year, thousands of magpies form a bridge, called 鹊桥 in Chinese and Queqiao in pinyin, allowing the lovers to meet. We use MagpieBridge as a metaphor for a system that connects arbitrary static analysis to arbitrary IDE.

Integrated Static Analyses using MagpieBridge

How to use MapgieBridge for your own analysis?

Build MagpieBridge with Maven

  1. check out the develop branch with git clone -b develop [email protected]:MagpieBridge/MagpieBridge.git
  2. run mvn install in the project root directory to build the tool and run all tests. To skip tests, run mvn install -DskipTests.

Build MagpieBridge in IDE

  1. Simply import the project as maven project in your IDE, Maven should take care of all required dependences. For Eclipse:
Eclipse> File> Import > Maven > Existing Maven Projects > Enter the path to your local repository > Finish

Contributors:

Get Involved

  • Pull requests are welcome!
  • Submit github issues for any feature enhancements, bugs or documentation problems
  • Please format the code with mvn com.coveo:fmt-maven-plugin:format before git push

Contact

✉ linghui[at]outlook.de

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%