1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
# Configuration
This document describes the configuration settings
that the server will query from the LSP client / extension.
---
## texlab.rootDirectory
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`
---
## texlab.build.executable
Defines the executable of the LaTeX build tool.
**Type:** `string`
**Default value:** `latexmk`
---
## texlab.build.args
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"]`
---
## texlab.build.forwardSearchAfter
Set this property to `true` if you want to execute a forward search after a build.
**Type:** `boolean`
**Default value:** `false`
---
## texlab.build.onSave
Set this property to `true` if you want to compile the project after saving a file.
**Type:** `boolean`
**Default value:** `false`
---
## texlab.auxDirectory
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)
---
## texlab.forwardSearch.executable
Defines the executable of the PDF previewer.
The previewer needs to support [SyncTeX](http://www.tug.org/TUGboat/tb29-3/tb93laurens.pdf).
**Type:** `string | null`
**Default value:** `null`
---
## texlab.forwardSearch.args
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`
---
## texlab.chktex.onOpenAndSave
Lint using [chktex](https://www.nongnu.org/chktex/) after opening and saving a file.
**Type:** `boolean`
**Default value:** `false`
---
## texlab.chktex.onEdit
Lint using [chktex](https://www.nongnu.org/chktex/) after editing a file.
**Type:** `boolean`
**Default value:** `false`
---
## texlab.diagnosticsDelay
Delay in milliseconds before reporting diagnostics.
**Type:** `integer`
**Default value:** `300`
---
## texlab.diagnostics.allowedPatterns
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`](#texlabdiagnosticsignoredpatterns).
_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:** `[]`
---
## texlab.diagnostics.ignoredPatterns
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`](#texlabdiagnosticsallowedpatterns).
**Type:** `RegExp[]`
**Default value:** `[]`
---
## texlab.formatterLineLength
Defines the maximum amount of characters per line (0 = disable) when formatting BibTeX files.
**Type:** `integer`
**Default value:** `80`
---
## texlab.bibtexFormatter
Defines the formatter to use for BibTeX formatting.
Possible values are either `texlab` or `latexindent`.
**Type:** `string`
**Default value:** `texlab`
---
## texlab.latexFormatter
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`
---
## texlab.latexindent.local
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`
---
## texlab.latexindent.modifyLineBreaks
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`
|
