-
Notifications
You must be signed in to change notification settings - Fork 65
Configuration
This page describes the configuration settings that the server will query from the LSP client.
Defines the directory from which the source files get compiled. You may need to set this property for multi-folder projects where TexLab fails to detect the root document.
Type: string | null
Default value: null
In newer versions of texlab (5.0.0 or later), the path is relative to the main document (previously, it was relative to the working directory of the server process, which is not ideal).
Defines the executable of the LaTeX build tool.
Type: string
Default value: latexmk
Defines additional arguments that are passed to the configured LaTeX build tool.
Note that flags and their arguments need to be separate
elements in this array.
To pass the arguments -foo bar to a build tool,
latex.build.args needs to be ["-foo", "bar"].
The placeholder %f will be replaced by the server.
Placeholders:
-
%f: The path of the TeX file to compile.
Type: string[]
Default value: ["-pdf", "-interaction=nonstopmode", "-synctex=1", "%f"]
Set this property to true if you want to execute a forward search after a build.
Type: boolean
Default value: false
Set this property to true if you want to compile the project after saving a file.
Type: boolean
Default value: false
Defines the directory containing the build artifacts.
Note that you need to set the output directory in latex.build.args too,
if you want to change the build directory.
In this case, use the -outdir flag for latexmk.
Type: string
Default value: . (the same directory as the TeX file)
Defines the executable of the PDF previewer. The previewer needs to support SyncTeX.
Type: string | null
Default value: null
Defines additional arguments that are passed to the configured previewer to perform the forward search.
The placeholders %f, %p, %l will be replaced by the server.
Placeholders:
-
%f: The path of the current TeX file. -
%p: The path of the current PDF file. -
%l: The current line number.
Type: string[] | null
Default value: null
Lint using chktex after opening and saving a file.
Type: boolean
Default value: false
Lint using chktex after editing a file.
Type: boolean
Default value: false
Delay in milliseconds before reporting diagnostics.
Type: integer
Default value: 300
A list of regular expressions used to filter the list of reported diagnostics. If specified, only diagnostics that match at least one of the specified patterns are sent to the client.
See also texlab.diagnostics.ignoredPatterns.
Hint:
If both allowedPatterns and ignoredPatterns are set,
then allowed patterns are applied first. Afterwards, the results are filtered with the ignored patterns.
Type: RegExp[]
Default value: []
A list of regular expressions used to filter the list of reported diagnostics. If specified, only diagnostics that match none of the specified patterns are sent to the client.
See also texlab.diagnostics.allowedPatterns.
Type: RegExp[]
Default value: []
Defines the maximum amount of characters per line (0 = disable) when formatting BibTeX files.
Type: integer
Default value: 80
Defines the formatter to use for BibTeX formatting.
Possible values are either texlab or latexindent.
Type: string
Default value: texlab
Defines the formatter to use for LaTeX formatting.
Possible values are either texlab or latexindent.
Note that texlab is not implemented yet.
Type: string
Default value: latexindent
Defines the path of a file containing the latexindent configuration.
This corresponds to the --local=file.yaml flag of latexindent.
By default the configuration inside the project root directory is used.
Type: string
Default value: null
Modifies linebreaks before, during, and at the end of code blocks
when formatting with latexindent.
This corresponds to the --modifylinebreaks flag of latexindent.
Type: boolean
Default value: false