texlab/README.md

TexLab

A cross-platform implementation of the Language Server Protocol providing rich cross-editing support for the LaTeX typesetting system.

The server is designed to be independent of the editor. We provide a reference implementation for Visual Studio Code.

Getting Started

This project uses Gradle. To compile the server and run the tests execute the following command in the project directory:

$ ./gradlew build

To use the local build with the extension, we recommend creating a symbolic link:

$ ln -s ./../texlab-vscode/server/texlab.jar ./build/libs/texlab.jar

Custom Messages

Build Request

The build request is sent from the client to the server to compile a given LaTeX document.

Request:

• method: 'textDocument/build'
• params: BuildTextDocumentParams defined as follows:

interface BuildTextDocumentParams {
    textDocument: TextDocumentIdentifier;
}

Response:

• result: BuildStatus defined as follows:

enum BuildStatus {
    Success = 0,
    Error = 1,
    Failure = 2,
}

Status Notification

The status notification is sent from the server to the client to inform the client about the status of the server.

Notification:

• method: 'window/setStatus'
• params: StatusParams defined as follows:

interface StatusParams {
    status: ServerStatus;
    uri?: string;
}

enum ServerStatus {
    Idle = 0,
    Building = 1,
    Indexing = 2,
}

Contributing

See CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.