Thank you for your interest in contributing to LSIF for Java!
There are many ways in which you can contribute, beyond writing code. Please read the following document to check how you can get involved.
You can report issues whenever:
- Identify a reproducible problem
- Have a feature request
Before creating a new issue, please do a search to see if the issue or feature request has already been filed.
If you find your issue already exists, make relevant comments and add your reaction:
- 👍 - upvote
- 👎 - downvote
In order to let us know better about the issue, please make sure the following items are included with each issue:
- The repo link which you are indexing with
- Reproducible steps
- What you expected to see, versus what you actually saw
- Images, animations, or a link to a video showing the issue occurring
If you are interested in writing code to fix issues, please check the following content to see how to set up the developing environment.
Generally speaking, the LSIF for Java uses several visitors to visit the AST(Abstract Syntax Tree) and dump the index according to the LSIF Specification.
Major modules of the LSIF for Java are listed as follow:
- AST visitors
- Language Server Index Format definitions
- Components and utilities for indexing
- Emitters to print out index information
- Fork and clone the repository:
git clone https://github.com/Microsoft/lsif-java.git
- Import
lsif-java
in Eclipse - In the
Project Exploer
, opencom.microsoft.java.lsif.tp
>com.microsoft.java.lsif.tp.target
- Click
Set as Active Target Platform
and wait for building
- Go to
lsif-java\cmd\
npm install
npm run build
- Under the root path of the project, run
./mvnw clean verify
- The tool will be generated in
com.microsoft.java.lsif.product\target\repository\
- Windows: Simply invoke the
index.bat
underlsif-java\cmd\
- Others: Invoke the command which is the same as we defined in
lsif-java\cmd\index.bat
-
We can debug the tool by attaching to the JVM, add
-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=6006
as the JVM argument to the command.
-
In Eclipse, create a new
Debug Configurations
, select the type asRemote Java Application
-
In the
Connect
panel, find thePort
setting inConnection Properties
and set it to6006
-
Click
Apply
to save the configurations -
Click
Debug
to start the debug session
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.