lsp-server-name-too-short
LSP server names should be descriptive
Rule Details
This rule checks the top-level keys in lsp.json, which serve as server names, and warns when any name is shorter than the configured minimum length. Descriptive server names like typescript-language-server or python-lsp improve readability and maintainability of LSP configuration files. Single-character or very short names make it hard to identify which language server is being configured.
Incorrect
Server name that is too short
{
"t": {
"command": "/usr/bin/tsserver"
}
}Correct
Descriptive server name
{
"typescript-server": {
"command": "/usr/bin/tsserver"
}
}How To Fix
Rename the server key to a more descriptive name that identifies the language or purpose, such as typescript-server, python-lsp, or rust-analyzer.
Options
Default options:
{
"minLength": 2
}Require server names of at least 3 characters:
{
"minLength": 3
}Allow single-character server names:
{
"minLength": 1
}When Not To Use It
Disable this rule if you have an established convention using short abbreviations for server names that are well-understood by your team.
Related Rules
Resources
Version
Available since: v0.2.0