microsoft / lsif-java

Language Server Indexing Format implementation for Java

Language Server Indexing Format Implementation for Java

Language Server Index Format

The purpose of the Language Server Index Format (LSIF) is to define a standard format for language servers or other programming tools to dump their knowledge about a workspace. This dump can later be used to answer language server LSP requests for the same workspace without running the language server itself. Since much of the information would be invalidated by a change to the workspace, the dumped information typically excludes requests used when mutating a document. So, for example, the result of a code complete request is typically not part of such a dump.

A first draft specification can be found here.

Requirement

JDK 17 is required to build or run this tool.

Quickstart

• Go to the build path:

  > cd cmd

• Install the required dependencies to build the Java Language Server Indexer:

  > npm install

• Build the Java Language Server Indexer:

  > npm run build

• Run the tools:

  > ./index.bat "-Drepo.path=<your java project path>"

Note: More information can be found here.

Contributing

If you are interested in fixing issues and contributing directly to the code base, please see the document How to Contribute for more details.

Changelog

See Changelog

License

Licensed under the EPL 1.0 License

lsif-java's Issues

Using multi-thread to index

bug: target platform build failed

Due to some urls of download.eclipse.org became invalid, the target script and the running script should be updated.

Refactor the interface design for the ProtocolVisitor

revisit license

see microsoft/vscode-java-pack#823

Redirect the error logs to the std-err

Setup CI

The document vertex of the .class file should belonging to a project

Getting error while running index.bat file

Describe the bug

Getting the error while running the command for .index.bat. Please find the screenshot to refer to the problem.

Refine the README Page

Wrong reference result for the class under `java.util`

I guess it might because the range is of the definition is all fall to the same value.

Example:

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Document vertex should be emitted before event vertex

Combining efforts with sourcegraph/lsif-java

Hey @jdneo 👋 Sourcegraph has been prototyping an LSIF indexer for Java https://github.com/sourcegraph/lsif-java using JavaParser, and I'm curious about the pros/cons of using Eclipse JDT compared to JavaParser. It'd be great to combine efforts here!

From my brief research:

• https://github.com/sourcegraph/lsif-java is ~10x faster
• https://github.com/microsoft/lsif-java supports jump-to-definition on fields/methods of an object (e.g. bar in foo.bar()), whereas https://github.com/sourcegraph/lsif-java doesn't (yet, although I made an unsuccessful attempt in sourcegraph/scip-java#1)
• https://github.com/microsoft/lsif-java appears to jump-to-definition into dependencies (with jdt:// URIs), which could be combined with monikers to provide cross-repository and cross-project code intelligence
• Spoon supports cross-file j2d/refs and is bit easier to use than JavaParser sourcegraph/scip-java#2

What are your near/long-term plans for this indexer? We're interested in contributing 😄

Links in the hover text is missing

Expected behavior

Screenshots

Some of the static import hover information is missing

For example, the import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; in PetControllerTests of the Spring-petclinic

Symbols in the JavaDoc is ignored

Expected behavior

Default to cwd if 'repo.path' is not specified

Default to the current working directory if 'repo.path' is not specified.

No hover information on the package statement

Expected behavior

Symbols are missing when peeking reference on an override method

Describe the bug

Since the implementation is based on the definition, and the location of the override methods are different.

Expected behavior

Screenshots

Cannot 'Go to Definition' on the method param

Wrong document field in edge when pointing to the definition range in .class file

If the peek implementation is performed on the inherited class, no implementation.

Bits: 0.4.5
Steps to reproduce the behavior:

1. Open spring-petclinic project in vscode-insider
2. F1 >- Open LSIF databse >- select lsif.lsif under speing-petclinic.
3. Open PetRepository.java, on line34, select string Repository
4. F1 >- Peek implementation

Expected Result

Current Result
No implementation

Hover information is wrong when the definition contains generic type

Generate workspace into a temp folder instead of generating directly into the package directory

The end event of .class document never get emitted

Getting error while running index.bat file

Describe the bug

I interpret the content in index.bat to index.sh shell as a workaround.When I execute this shell, it prompts that the jar file is missing.
It seems that there is no file /cmd/repository/plugins/org.eclipse.equinox.launcher_1.6.400.v20210924-0641.jar in the repository.

Missing constructor when find reference on a type

Describe the bug

When a class has explicitly defined its constructor(s), find reference on that type should contain the constructors.

Screenshots

Unused Field

lsif-java/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/protocol/DeclarationTag.java

Line 12 in 4e84932

private SymbolKind kind;

lsif-java/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/protocol/DeclarationTag.java

Line 14 in 4e84932

private org.eclipse.lsp4j.Range fullRange;

These fields are never used.

Print out the job status in the Indexer

Cannot 'Go to Implementation' in IntelliNav

The root cause is that:

Any vertex that’s referenced by its id must be output before it is referenced

index don't work

Describe the bug
I execute in the maven base path, but it seems that only the basic information of the directory is returned, and there is no index of the code.

Do I need to change any configuration?
To Reproduce

Project link which can reproduce the bug:

Steps to reproduce the behavior:

1. Go to '...'
2. Click/Hover on '....'
3. See error

Expected behavior

A clear and concise description of what you expected to happen.

Screenshots

If applicable, add screenshots to help explain your problem.

Additional context

Add any other context about the problem here.

Duplicate end events for a document vertex