Workspace commands

The server provides the some commands through the workspace/executeCommand request.

Note: For simplicity, all commands take at most one argument, that is, the arguments array should contain exactly one element or no elements depending on the command.

texlab.cleanAuxiliary

Removes the auxiliary files produced by compiling the specified LaTeX document. At the moment, this command simply calls latexmk -c with the currently configured output directory.

Parameters

export type CleanAuxiliaryParams = TextDocumentIdentifier;

texlab.cleanArtifacts

Removes the auxiliary files and the artifacts produced by compiling the specified LaTeX document. At the moment, this command simply calls latexmk -C with the currently configured output directory.

Parameters

export type CleanArtifactsParams = TextDocumentIdentifier;

texlab.changeEnvironment

Upon receiving a newName through the params, changes the name of the inner-most environment that contains the specified position.

Parameters

export interface ChangeEnvironmentParams extends TextDocumentPositionParams {
    newName: string;
}

texlab.findEnvironments

Returns a list of all environments that contain the specified position.

Parameters

export type FindEnvironmentsParams = TextDocumentPositionParams;

Returns

EnvironmentLocation[], where

export interface EnvironmentLocation {
    name: {
        text: string;
        range: Range;
    };
    fullRange: Range;
}

texlab.showDependencyGraph

Returns a description of the dependency graph in DOT format.

Parameters

None

Returns

string (A description of the graph in DOT format)

texlab.cancelBuild

Cancels all currently active build requests (including builds triggered by texlab.build.onSave)

Parameters

None