Skip to content

microsoft/lsif-java

Repository files navigation

Language Server Indexing Format Implementation for Java

Build status

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