-
Notifications
You must be signed in to change notification settings - Fork 535
Linters
Duplicate labels are highlighted when latex-workshop.check.duplicatedLabels.enabled is set to true. The computation of the duplicates is based on the data collected for intellisense, so we cannot update the duplicates more often than intellisense. When intellisense.update.aggressive.enabled is set to false, duplicates are updated on file save. When intellisense.update.aggressive.enabled is set to true, duplicates are updated after stopped typing for longer than latex-workshop.intellisense.update.delay.
Enable checking for duplicated labels.
A new check is triggered every time the intellisense data is updated, see intellisense.update.aggressive.enabled .
| type | default value |
|---|---|
| boolean | true |
LaTeX Workshop currently supports two LaTeX linters, namely, ChkTeX and LaCheck. These two linters can be enabled/disabled separately by latex-workshop.linting.chktex.enabled and latex-workshop.linting.lacheck.enabled, respectively.
The linter behavior is controlled by the following two configuration items.
When LaTeX should be linted. If set to onSave, the whole LaTeX project will be linted upon saving. If set to onType, the active document will be linted when input is stopped for a period of time defined in latex-workshop.linting.delay, in addition to the behavior of onSave.
| type | default value |
|---|---|
| enum | "onSave" |
When latex-workshop.linting.run is set to onType, defines the delay in milliseconds for linter to wait after stopped typing.
| type | default value |
|---|---|
| number | 500 |
The ChkTeX utility is a LaTeX semantic checker. Once installed, and the relevant setting enabled it is automatically run on any open TeX documents. Its output is parsed by the extension and displayed in the Problems panel.
Auto load of .chktexrc configuration files is performed in the following order
- Manually configured
-lsetting inchktex.exec.args - The
.chktexrcfile (if exists) in the same folder as the main LaTeX file - The
.chktexrcfile (if exists) at the project root folder.
Enable linting LaTeX with ChkTeX.
The active document will be linted when no document changes for a defined period of time.
The full project will be linted from the root on file save.
| type | default value |
|---|---|
| boolean | false |
Define the location of ChkTeX executive file.
This command will be joint with latex-workshop.linting.chktex.exec.args to form a complete ChkTeX command.
| type | default value |
|---|---|
| string | "chktex" |
Linter arguments to check LaTeX syntax
Arguments must be in separate strings in the array. Additional arguments, i.e., -I0 -f%f:%l:%c:%d:%k:%n:%m\n will be appended when constructing the command. Current file contents will be piped to the command through stdin.
| type | default value |
|---|---|
| array of strings | ["-wall", "-n22", "-n30", "-e16", "-q"] |
Enable converting ChkTeX outputs' column numbers for non-ASCII characters.
| type | default value |
|---|---|
| boolean | true |
Write the TabSize number from .chktexrc. The default value -1 means that LaTeX Workshop will try to find .chktexrc and to read the value from it.
| type | default value |
|---|---|
| number | -1 |
The LaCheck utility is a consistency checker for LaTeX documents. Once installed, and the relevant setting enabled it is automatically run on any open TeX documents. Its output is parsed by the extension and displayed in the Problems panel. Detailed introduction to LaCheck can be found here.
Enable linting LaTeX with LaCheck.
The active document will be linted when no document changes for a defined period of time.
The full project will be linted from the root on file save.
| type | default value |
|---|---|
| boolean | false |
Define the location of LaCheck executive file.
"latex-workshop.linting.lacheck.exec.path": "lacheck"
| type | default value |
|---|---|
| string | "lacheck" |