Title: efm-langserver
Description: If configuring via DidChangeConfiguration (e.g. an editor API such as nvim-lspconfig), all properties should be in camelCase instead of kebab-case.
Property
Pattern
Type
Deprecated
Definition
Title/Description
- commands
No
array of object
No
In #/definitions/command-definition
list of commands
- languages
No
object
No
-
list of language
- tools
No
object
No
-
definition of tools
- version
No
number
No
-
version of this yaml format
- root-markers
No
array of string
No
-
markers to find root directory
- log-file
No
string
No
-
(YAML only) path to log file
- log-level
No
number
No
-
log level
- format-debounce
No
string
No
-
duration to debounce calls to the formatter executable. e.g: 1s
- lint-debounce
No
string
No
-
duration to debounce calls to the linter executable. e.g.: 1s
- provide-definition
No
boolean
No
-
(YAML only) Whether this language server should be used for go-to-definition requests
- trigger-chars
No
array of string
No
-
trigger characters for completion
Type array of object
Required No
Defined in #/definitions/command-definition
Description: list of commands
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Property
Pattern
Type
Deprecated
Definition
Title/Description
- arguments
No
array of string
No
-
arguments for the command
- command
No
string
No
-
command to execute
- os
No
string
No
-
command executable OS environment
- title
No
string
No
-
title for clients
arguments
Type array of string
Required No
Description: arguments for the command
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Description: command to execute
Description: command executable OS environment
Description: title for clients
Description: list of language
Property
Pattern
Type
Deprecated
Definition
Title/Description
- ^([a-z0-9_-]+)+$
Yes
array
No
-
-
^([a-z0-9_-]+)+$
All properties whose name matches the regular expression
^([a-z0-9_-]+)+$ (Test )
must respect the following conditions
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be
Description
tool-definition definition of the tool
Type object
Required No
Additional properties [Not allowed]
Defined in #/definitions/tool-definition
Description: definition of the tool
Property
Pattern
Type
Deprecated
Definition
Title/Description
- prefix
No
string
No
-
If lint-source doesn't work, you can set a prefix here instead, which will render the messages as "[prefix] message".
- format-can-range
No
boolean
No
-
Whether the formatting command handles range start and range end
- format-command
No
string
No
-
Formatting command. Input filename can be injected using ${INPUT}, and flags can be injected using ${--flag:key} (adds --flag <value> if value exists for key), ${--flag=key} (adds --flag=<value> if value exists for key), or ${--flag:!key} (adds --flag if value for key is falsy).efm-langserver may provide values for keys charStart, charEnd, rowStart, rowEnd, colStart, colEnd, or any key in interface FormattingOptionsprettier --stdin --stdin-filepath ${INPUT} ${--tab-width:tabWidth} ${--use-tabs:insertSpaces} ${--range-start=charStart} ${--range-start=charEnd}
- format-stdin
No
boolean
No
-
use stdin for the format
- hover-command
No
string
No
-
hover command
- hover-stdin
No
boolean
No
-
use stdin for the hover
- hover-type
No
enum (of string)
No
-
hover result type
- hover-chars
No
string
No
-
-
- env
No
array of string
No
-
command environment variables and values
- lint-command
No
string
No
-
Lint command. Input filename can be injected using ${INPUT}.
- lint-offset-columns
No
number
No
-
offset value to skip columns
- lint-category-map
No
object
No
-
Map linter categories to LSP categories
- lint-formats
No
array of string
No
-
List of Vim errorformats to capture. See: https://vimhelp.org/quickfix.txt.html#errorformats . If this is not expressive enough, you can edit the lint-command to do some preprocessing, e.g. using sed or jq.efm-langserver uses a Go implementation to parse the errors, which comes with a CLI for quick testing: https://github.com/reviewdog/errorformat
- lint-ignore-exit-code
No
boolean
No
-
ignore exit code of lint
- lint-offset
No
number
No
-
offset value to skip lines
- lint-on-save
No
boolean
No
-
only lint on save, i.e. don't lint on text changed
- lint-severity
No
number
No
-
default severity to show if violation doesn't provide severity. 1 = error, 2 = warning, 3 = info, 4 = hint
- lint-source
No
string
No
-
show where the lint came from, e.g. 'eslint'
- lint-stdin
No
boolean
No
-
use stdin for the lint
- lint-workspace
No
boolean
No
-
indicates that the command lints the whole workspace and thus doesn't need a filename argument nor stdin
- completion-command
No
string
No
-
completion command
- completion-stdin
No
boolean
No
-
use stdin for the completion
- symbol-command
No
string
No
-
-
- symbol-stdin
No
boolean
No
-
-
- symbol-formats
No
array of string
No
-
-
- root-markers
No
array of string
No
-
markers to find root directory
- require-marker
No
boolean
No
-
require a marker to run linter
- commands
No
array of object
No
Same as commands
list of commands
Description: If lint-source doesn't work, you can set a prefix here instead, which will render the messages as "[prefix] message".
format-can-rangeDescription: Whether the formatting command handles range start and range end
format-commandDescription: Formatting command. Input filename can be injected using ${INPUT}, and flags can be injected using ${--flag:key} (adds --flag <value> if value exists for key), ${--flag=key} (adds --flag=<value> if value exists for key), or ${--flag:!key} (adds --flag if value for key is falsy).
efm-langserver may provide values for keys charStart, charEnd, rowStart, rowEnd, colStart, colEnd, or any key in interface FormattingOptions
Example: prettier --stdin --stdin-filepath ${INPUT} ${--tab-width:tabWidth} ${--use-tabs:insertSpaces} ${--range-start=charStart} ${--range-start=charEnd}
format-stdinDescription: use stdin for the format
hover-commandDescription: hover command
hover-stdinDescription: use stdin for the hover
hover-type
Type enum (of string)
Required No
Description: hover result type
Must be one of:
hover-chars
Type array of string
Required No
Description: command environment variables and values
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be
Description
env items -
Restrictions
Must match regular expression ^.+=.+$ Test
lint-commandDescription: Lint command. Input filename can be injected using ${INPUT}.
lint-offset-columnsDescription: offset value to skip columns
lint-category-mapDescription: Map linter categories to LSP categories
lint-formats
Type array of string
Required No
Description: List of Vim errorformats to capture. See: https://vimhelp.org/quickfix.txt.html#errorformats . If this is not expressive enough, you can edit the lint-command to do some preprocessing, e.g. using sed or jq.
efm-langserver uses a Go implementation to parse the errors, which comes with a CLI for quick testing: https://github.com/reviewdog/errorformat
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
lint-ignore-exit-code
Type boolean
Required No
Default true
Description: ignore exit code of lint
lint-offsetDescription: offset value to skip lines
lint-on-saveDescription: only lint on save, i.e. don't lint on text changed
lint-severityDescription: default severity to show if violation doesn't provide severity. 1 = error, 2 = warning, 3 = info, 4 = hint
lint-sourceDescription: show where the lint came from, e.g. 'eslint'
lint-stdin
Type boolean
Required No
Default true
Description: use stdin for the lint
lint-workspaceDescription: indicates that the command lints the whole workspace and thus doesn't need a filename argument nor stdin
completion-commandDescription: completion command
completion-stdin
Type boolean
Required No
Default true
Description: use stdin for the completion
symbol-commandsymbol-stdinsymbol-formats
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
root-markers
Type array of string
Required No
Description: markers to find root directory
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
require-markerDescription: require a marker to run linter
commands
Type array of object
Required No
Same definition as commands
Description: list of commands
Description: definition of tools
tool-definition
All properties whose name matches the regular expression
^([a-z0-9_-]+)+$ (Test )
must respect the following conditions
Description: definition of the tool
Description: version of this yaml format
Type array of string
Required No
Description: markers to find root directory
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Description: (YAML only) path to log file
Description: log level
format-debounceDescription: duration to debounce calls to the formatter executable. e.g: 1s
lint-debounceDescription: duration to debounce calls to the linter executable. e.g.: 1s
provide-definitionDescription: (YAML only) Whether this language server should be used for go-to-definition requests
trigger-chars
Type array of string
Required No
Description: trigger characters for completion
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Generated using json-schema-for-humans on 2023-09-06 at 04:43:26 -0700