# Configurations The following LSP configs are included. This documentation is autogenerated from the lua files. Follow a link to find documentation for that config. - [als](#als) - [angularls](#angularls) - [bashls](#bashls) - [beancount](#beancount) - [ccls](#ccls) - [clangd](#clangd) - [clojure_lsp](#clojure_lsp) - [cmake](#cmake) - [codeqlls](#codeqlls) - [cssls](#cssls) - [dartls](#dartls) - [denols](#denols) - [dhall_lsp_server](#dhall_lsp_server) - [diagnosticls](#diagnosticls) - [dockerls](#dockerls) - [dotls](#dotls) - [efm](#efm) - [elixirls](#elixirls) - [elmls](#elmls) - [erlangls](#erlangls) - [flow](#flow) - [fortls](#fortls) - [fsautocomplete](#fsautocomplete) - [gdscript](#gdscript) - [ghcide](#ghcide) - [gopls](#gopls) - [graphql](#graphql) - [groovyls](#groovyls) - [haxe_language_server](#haxe_language_server) - [hie](#hie) - [hls](#hls) - [html](#html) - [intelephense](#intelephense) - [jdtls](#jdtls) - [jedi_language_server](#jedi_language_server) - [jsonls](#jsonls) - [julials](#julials) - [kotlin_language_server](#kotlin_language_server) - [leanls](#leanls) - [metals](#metals) - [nimls](#nimls) - [ocamlls](#ocamlls) - [ocamllsp](#ocamllsp) - [omnisharp](#omnisharp) - [perlls](#perlls) - [phpactor](#phpactor) - [powershell_es](#powershell_es) - [purescriptls](#purescriptls) - [pyls](#pyls) - [pyls_ms](#pyls_ms) - [pyright](#pyright) - [r_language_server](#r_language_server) - [racket_langserver](#racket_langserver) - [rls](#rls) - [rnix](#rnix) - [rome](#rome) - [rust_analyzer](#rust_analyzer) - [scry](#scry) - [solargraph](#solargraph) - [sorbet](#sorbet) - [sourcekit](#sourcekit) - [sqlls](#sqlls) - [sqls](#sqls) - [sumneko_lua](#sumneko_lua) - [svelte](#svelte) - [terraformls](#terraformls) - [texlab](#texlab) - [tflint](#tflint) - [tsserver](#tsserver) - [vala_ls](#vala_ls) - [vimls](#vimls) - [vls](#vls) - [vuels](#vuels) - [yamlls](#yamlls) - [zls](#zls) ## als https://github.com/AdaCore/ada_language_server Installation instructions can be found [here](https://github.com/AdaCore/ada_language_server#Install). Can be configured by passing a "settings" object to `als.setup{}`: ```lua require('lspconfig').als.setup{ settings = { ada = { projectFile = "project.gpr"; scenarioVariables = { ... }; } } } ``` ```lua require'lspconfig'.als.setup{} Commands: Default Values: cmd = { "ada_language_server" } filetypes = { "ada" } root_dir = util.root_pattern("Makefile", ".git") ``` ## angularls https://github.com/angular/vscode-ng-language-service `angular-language-server` can be installed via npm `npm install -g @angular/language-server`. Note, that if you override the default `cmd`, you must also update `on_new_config` to set `new_config.cmd` during startup. ```lua local project_library_path = "/path/to/project/lib" local cmd = {"ngserver", "--stdio", "--tsProbeLocations", project_library_path , "--ngProbeLocations", project_library_path} require'lspconfig'.angularls.setup{ cmd = cmd, on_new_config = function(new_config,new_root_dir) new_config.cmd = cmd end, } ``` ```lua require'lspconfig'.angularls.setup{} Commands: Default Values: cmd = { "ngserver", "--stdio", "--tsProbeLocations", "", "--ngProbeLocations", "" } filetypes = { "typescript", "html", "typescriptreact", "typescript.tsx" } root_dir = root_pattern("angular.json", ".git") ``` ## bashls https://github.com/mads-hartmann/bash-language-server Language server for bash, written using tree sitter in typescript. ```lua require'lspconfig'.bashls.setup{} Commands: Default Values: cmd = { "bash-language-server", "start" } cmd_env = { GLOB_PATTERN = "*@(.sh|.inc|.bash|.command)" } filetypes = { "sh" } root_dir = vim's starting directory ``` ## beancount https://github.com/polarmutex/beancount-language-server#installation See https://github.com/polarmutex/beancount-language-server#configuration for configuration options ```lua require'lspconfig'.beancount.setup{} Commands: Default Values: cmd = { "beancount-langserver" } filetypes = { "beancount" } init_options = { journalFile = "", pythonPath = "python3" } root_dir = root_pattern("elm.json") ``` ## ccls https://github.com/MaskRay/ccls/wiki ccls relies on a [JSON compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html) specified as compile_commands.json or, for simpler projects, a compile_flags.txt. For details on how to automatically generate one using CMake look [here](https://cmake.org/cmake/help/latest/variable/CMAKE_EXPORT_COMPILE_COMMANDS.html). Customization options are passed to ccls at initialization time via init_options, a list of available options can be found [here](https://github.com/MaskRay/ccls/wiki/Customization#initialization-options). For example: ```lua local lspconfig = require'lspconfig' lspconfig.ccls.setup { init_options = { compilationDatabaseDirectory = "build"; index = { threads = 0; }; clang = { excludeArgs = { "-frounding-math"} ; }; } } ``` ```lua require'lspconfig'.ccls.setup{} Commands: Default Values: cmd = { "ccls" } filetypes = { "c", "cpp", "objc", "objcpp" } root_dir = root_pattern("compile_commands.json", "compile_flags.txt", ".git") ``` ## clangd https://clangd.llvm.org/installation.html **NOTE:** Clang >= 9 is recommended! See [this issue for more](https://github.com/neovim/nvim-lsp/issues/23). clangd relies on a [JSON compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html) specified as compile_commands.json or, for simpler projects, a compile_flags.txt. For details on how to automatically generate one using CMake look [here](https://cmake.org/cmake/help/latest/variable/CMAKE_EXPORT_COMPILE_COMMANDS.html). ```lua require'lspconfig'.clangd.setup{} Commands: - ClangdSwitchSourceHeader: Switch between source/header Default Values: capabilities = default capabilities, with offsetEncoding utf-8 cmd = { "clangd", "--background-index" } filetypes = { "c", "cpp", "objc", "objcpp" } on_init = function to handle changing offsetEncoding root_dir = root_pattern("compile_commands.json", "compile_flags.txt", ".git") or dirname ``` ## clojure_lsp https://github.com/snoe/clojure-lsp Clojure Language Server ```lua require'lspconfig'.clojure_lsp.setup{} Commands: Default Values: cmd = { "clojure-lsp" } filetypes = { "clojure", "edn" } root_dir = root_pattern("project.clj", "deps.edn", ".git") ``` ## cmake https://github.com/regen100/cmake-language-server CMake LSP Implementation ```lua require'lspconfig'.cmake.setup{} Commands: Default Values: cmd = { "cmake-language-server" } filetypes = { "cmake" } init_options = { buildDirectory = "build" } root_dir = root_pattern(".git", "compile_commands.json", "build") or dirname ``` ## codeqlls Reference: https://help.semmle.com/codeql/codeql-cli.html Binaries: https://github.com/github/codeql-cli-binaries This server accepts configuration via the `settings` key.
Available settings: - **`codeQL.cli.executablePath`**: `string` Default: `""` Path to the CodeQL executable that should be used by the CodeQL extension\. The executable is named \`codeql\` on Linux\/Mac and \`codeql\.exe\` on Windows\. If empty\, the extension will look for a CodeQL executable on your shell PATH\, or if CodeQL is not on your PATH\, download and manage its own CodeQL executable\. - **`codeQL.queryHistory.format`**: `string` Default: `"%q on %d - %s, %r result count [%t]"` Default string for how to label query history items\. \%t is the time of the query\, \%q is the query name\, \%d is the database name\, \%r is the number of results\, and \%s is a status string\. - **`codeQL.resultsDisplay.pageSize`**: `integer` Default: `200` Max number of query results to display per page in the results view\. - **`codeQL.runningQueries.autoSave`**: `boolean` Enable automatically saving a modified query file when running a query\. - **`codeQL.runningQueries.cacheSize`**: `integer|null` Default: `vim.NIL` Maximum size of the disk cache \(in MB\)\. Leave blank to allow the evaluator to automatically adjust the size of the disk cache based on the size of the codebase and the complexity of the queries being executed\. - **`codeQL.runningQueries.debug`**: `boolean` Enable debug logging and tuple counting when running CodeQL queries\. This information is useful for debugging query performance\. - **`codeQL.runningQueries.maxQueries`**: `integer` Default: `20` Max number of simultaneous queries to run using the \'CodeQL\: Run Queries\' command\. - **`codeQL.runningQueries.memory`**: `integer|null` Default: `vim.NIL` Memory \(in MB\) to use for running queries\. Leave blank for CodeQL to choose a suitable value based on your system\'s available memory\. - **`codeQL.runningQueries.numberOfThreads`**: `integer` Default: `1` Number of threads for running queries\. - **`codeQL.runningQueries.saveCache`**: `boolean` Aggressively save intermediate results to the disk cache\. This may speed up subsequent queries if they are similar\. Be aware that using this option will greatly increase disk usage and initial evaluation time\. - **`codeQL.runningQueries.timeout`**: `integer|null` Default: `vim.NIL` Timeout \(in seconds\) for running queries\. Leave blank or set to zero for no timeout\. - **`codeQL.runningTests.additionalTestArguments`**: `array` Default: `{}` null - **`codeQL.runningTests.numberOfThreads`**: `integer` Default: `1` Number of threads for running CodeQL tests\. - **`codeQL.telemetry.enableTelemetry`**: `boolean` null - **`codeQL.telemetry.logTelemetry`**: `boolean` Specifies whether or not to write telemetry events to the extension log\.
```lua require'lspconfig'.codeqlls.setup{} Commands: Default Values: before_init = function(initialize_params, config) initialize_params['workspaceFolders'] = {{ name = 'workspace', uri = initialize_params['rootUri'] }} end; cmd = { "codeql", "execute", "language-server", "--check-errors", "ON_CHANGE", "-q" } filetypes = { "ql" } log_level = 2 root_dir = function(fname) return root_pattern("qlpack.yml") or util.path.dirname(fname) end; settings = { search_path = "list containing all search paths, eg: '~/codeql-home/codeql-repo'" } ``` ## cssls https://github.com/vscode-langservers/vscode-css-languageserver-bin `css-languageserver` can be installed via `npm`: ```sh npm install -g vscode-css-languageserver-bin ``` ```lua require'lspconfig'.cssls.setup{} Commands: Default Values: cmd = { "css-languageserver", "--stdio" } filetypes = { "css", "scss", "less" } root_dir = root_pattern("package.json") settings = { css = { validate = true }, less = { validate = true }, scss = { validate = true } } ``` ## dartls https://github.com/dart-lang/sdk/tree/master/pkg/analysis_server/tool/lsp_spec Language server for dart. This server accepts configuration via the `settings` key.
Available settings: - **`dart.additionalAnalyzerFileExtensions`**: `array` Default: `{}` Array items: `{type = "string"}` Additional file extensions that should be analyzed \(usually used in combination with analyzer plugins\)\. - **`dart.allowAnalytics`**: `boolean` Default: `true` Whether to send analytics such as startup timings\, frequency of use of features and analysis server crashes\. - **`dart.allowTestsOutsideTestFolder`**: `boolean` null - **`dart.analysisExcludedFolders`**: `array` Default: `{}` Array items: `{type = "string"}` An array of paths to be excluded from Dart analysis\. This option should usually be set at the Workspace level\. Excluded folders will also be ignored when detecting project types\. - **`dart.analysisServerFolding`**: `boolean` Default: `true` Whether to use folding data from the Dart analysis server instead of the built\-in VS Code indent\-based folding\. - **`dart.analyzeAngularTemplates`**: `boolean` Default: `true` null - **`dart.analyzerAdditionalArgs`**: `array` Default: `{}` Array items: `{type = "string"}` Additional arguments to pass to the Dart analysis server\. - **`dart.analyzerDiagnosticsPort`**: `null|number` Default: `vim.NIL` The port number to be used for the Dart analyzer diagnostic server\. - **`dart.analyzerInstrumentationLogFile`**: `null|string` Default: `vim.NIL` The path to a log file for very detailed logging in the Dart analysis server that may be useful when trying to diagnose analysis server issues\. - **`dart.analyzerLogFile`**: `null|string` Default: `vim.NIL` The path to a log file for communication between Dart Code and the analysis server\. - **`dart.analyzerPath`**: `null|string` Default: `vim.NIL` The path to a custom Dart analysis server\. - **`dart.analyzerSshHost`**: `null|string` Default: `vim.NIL` An SSH host to run the analysis server\. This can be useful when modifying code on a remote machine using SSHFS\. - **`dart.analyzerVmServicePort`**: `null|number` Default: `vim.NIL` The port number to be used for the Dart analysis server VM service\. - **`dart.autoImportCompletions`**: `boolean` Default: `true` Whether to include symbols that have not been imported in the code completion list and automatically insert the required import when selecting them \(requires restart\)\. - **`dart.buildRunnerAdditionalArgs`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`dart.checkForSdkUpdates`**: `boolean` Default: `true` Whether to check you are using the latest version of the Dart SDK at startup\. - **`dart.closingLabels`**: `boolean` Default: `true` Whether to show annotations against constructor\, method invocations and lists that span multiple lines\. - **`dart.completeFunctionCalls`**: `boolean` Default: `true` null - **`dart.debugExtensionBackendProtocol`**: `enum { "sse", "ws" }` Default: `"ws"` The protocol to use for the Dart Debug Extension backend service and injected client\. Using WebSockets can improve performance but may fail when connecting through some proxy servers\. - **`dart.debugExternalLibraries`**: `boolean` null - **`dart.debugSdkLibraries`**: `boolean` null - **`dart.devToolsBrowser`**: `enum { "chrome", "default" }` Default: `"chrome"` Whether to launch external DevTools windows using Chrome or the system default browser\. - **`dart.devToolsLogFile`**: `null|string` Default: `vim.NIL` The path to a low\-traffic log file for the Dart DevTools service\. - **`dart.devToolsPort`**: `null|number` Default: `vim.NIL` The port number to be used for the Dart DevTools\. - **`dart.devToolsReuseWindows`**: `boolean` Default: `true` Whether to try to reuse existing DevTools windows instead of launching new ones\. Only works for instances of DevTools launched by the DevTools server on the local machine\. - **`dart.devToolsTheme`**: `enum { "dark", "light" }` Default: `"dark"` The theme to use for Dart DevTools\. - **`dart.doNotFormat`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`dart.embedDevTools`**: `boolean` Default: `true` null - **`dart.enableCompletionCommitCharacters`**: `boolean` null - **`dart.enableSdkFormatter`**: `boolean` Default: `true` null - **`dart.enableSnippets`**: `boolean` Default: `true` Whether to include Dart and Flutter snippets in code completion\. - **`dart.env`**: `object` Default: `vim.empty_dict()` Additional environment variables to be added to all Dart\/Flutter processes spawned by the Dart and Flutter extensions\. - **`dart.evaluateGettersInDebugViews`**: `boolean` Default: `true` Whether to evaluate getters in order to display them in debug views \(such as the Variables\, Watch and Hovers views\)\. - **`dart.evaluateToStringInDebugViews`**: `boolean` Default: `true` Whether to call toString\(\) on objects when rendering them in debug views \(such as the Variables\, Watch and Hovers views\)\. Only applies to views of 100 or fewer values for performance reasons\. - **`dart.extensionLogFile`**: `null|string` Default: `vim.NIL` The path to a low\-traffic log file for basic extension and editor issues\. - **`dart.flutterAdbConnectOnChromeOs`**: `boolean` null - **`dart.flutterAdditionalArgs`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`dart.flutterAttachAdditionalArgs`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`dart.flutterCreateAndroidLanguage`**: `enum { "java", "kotlin" }` Default: `"kotlin"` The programming language to use for Android apps when creating new projects using the \'Flutter\: New Application Project\' command\. - **`dart.flutterCreateIOSLanguage`**: `enum { "objc", "swift" }` Default: `"swift"` The programming language to use for iOS apps when creating new projects using the \'Flutter\: New Application Project\' command\. - **`dart.flutterCreateOffline`**: `boolean` Whether to use offline mode when creating new projects with the \'Flutter\: New Application Project\' command\. - **`dart.flutterCreateOrganization`**: `null|string` Default: `vim.NIL` null - **`dart.flutterCustomEmulators`**: `array` Default: `{}` Array items: `{properties = {args = {items = {type = "string"},type = "array"},executable = {type = "string"},id = {type = "string"},name = {type = "string"}},type = "object"}` Custom emulators to show in the emulator list for easier launching\. If IDs match existing emulators returned by Flutter\, the custom emulators will override them\. - **`dart.flutterDaemonLogFile`**: `null|string` Default: `vim.NIL` null - **`dart.flutterGutterIcons`**: `boolean` Default: `true` Whether to show Flutter icons and colors in the editor gutter\. - **`dart.flutterHotReloadOnSave`**: `enum { "never", "always", "manual" }` Default: `"manual"` null - **`dart.flutterHotRestartOnSave`**: `boolean` Default: `true` Whether to automatically send a Hot Restart request during a debug session when saving files if Hot Reload is not available but Hot Restart is\. - **`dart.flutterOutline`**: `boolean` Default: `true` Whether to show the Flutter Outline tree in the sidebar\. - **`dart.flutterRunAdditionalArgs`**: `null|array` Default: `vim.NIL` Array items: `{type = "string"}` null - **`dart.flutterRunLogFile`**: `null|string` Default: `vim.NIL` null - **`dart.flutterScreenshotPath`**: `null|string` Default: `vim.NIL` The path to a directory to save Flutter screenshots\. - **`dart.flutterSdkPath`**: `null|string` Default: `vim.NIL` null - **`dart.flutterSdkPaths`**: `array` Default: `{}` Array items: `{type = "string"}` An array of paths that either directly point to a Flutter SDK or the parent directory of multiple Flutter SDKs\. When set\, the version number in the status bar can be used to quickly switch between SDKs\. - **`dart.flutterSelectDeviceWhenConnected`**: `boolean` Default: `true` Whether to set newly connected devices as the current device in Flutter projects\. - **`dart.flutterShowWebServerDevice`**: `enum { "remote", "always" }` Default: `"remote"` null - **`dart.flutterStructuredErrors`**: `boolean` Default: `true` null - **`dart.flutterTestAdditionalArgs`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`dart.flutterTestLogFile`**: `null|string` Default: `vim.NIL` null - **`dart.flutterTrackWidgetCreation`**: `boolean` Default: `true` null - **`dart.flutterWebRenderer`**: `enum { "auto", "html", "canvaskit" }` Default: `"auto"` null - **`dart.hotReloadProgress`**: `enum { "notification", "statusBar" }` Default: `"notification"` Determines how to display Hot Restart and Hot Reload progress\. - **`dart.insertArgumentPlaceholders`**: `boolean` Default: `true` null - **`dart.lineLength`**: `integer` Default: `80` The maximum length of a line of code\. This is used by the document formatter\. - **`dart.lspSnippetTextEdits`**: `boolean` Default: `true` null - **`dart.maxLogLineLength`**: `number` Default: `2000` The maximum length of a line in the log file\. Lines longer than this will be truncated and suffixed with an ellipsis\. - **`dart.notifyAnalyzerErrors`**: `boolean` Default: `true` Whether to show a notification the first few times an analysis server exception occurs\. - **`dart.openDevTools`**: `enum { "never", "flutter", "always" }` Default: `"never"` Whether to automatically open DevTools at the start of a debug session\. If embedded DevTools is enabled\, this will launch the Widget Inspector embedded for Flutter projects\, or launch DevTools externally in a browser for Dart projects\. - **`dart.openTestView`**: `array` Default: `{ "testRunStart" }` Array items: `{enum = { "testRunStart", "testFailure" }}` When to automatically switch focus to the test list \(array to support multiple values\)\. - **`dart.previewBazelWorkspaceCustomScripts`**: `boolean` null - **`dart.previewCommitCharacters`**: `boolean` EXPERIMENTAL\: Whether to enable commit characters for the LSP server\. In a future release\, the dart\.enableCompletionCommitCharacters setting will also apply to LSP\. - **`dart.previewFlutterUiGuides`**: `boolean` null - **`dart.previewFlutterUiGuidesCustomTracking`**: `boolean` Whether to enable custom tracking of Flutter UI guidelines \(to hide some latency of waiting for the next Flutter Outline\)\. - **`dart.previewHotReloadOnSaveWatcher`**: `boolean` null - **`dart.previewLsp`**: `null|boolean` Default: `vim.NIL` null - **`dart.promptToGetPackages`**: `boolean` Default: `true` Whether to prompt to get packages when opening a project with out of date packages\. - **`dart.promptToRunIfErrors`**: `boolean` Default: `true` Whether to prompt before running if there are errors in your project\. Test scripts will be excluded from the check unless they\'re the script being run\. - **`dart.pubAdditionalArgs`**: `array` Default: `{}` Array items: `{type = "string"}` Additional args to pass to all pub commands\. - **`dart.pubTestLogFile`**: `null|string` Default: `vim.NIL` null - **`dart.runPubGetOnPubspecChanges`**: `boolean` Default: `true` null - **`dart.sdkPath`**: `null|string` Default: `vim.NIL` null - **`dart.sdkPaths`**: `array` Default: `{}` Array items: `{type = "string"}` An array of paths that either directly point to a Dart SDK or the parent directory of multiple Dart SDKs\. When set\, the version number in the status bar can be used to quickly switch between SDKs\. - **`dart.shareDevToolsWithFlutter`**: `boolean` Default: `true` Whether to eagerly run DevTools for Flutter workspaces and share the spawned server with \`flutter run\`\. - **`dart.showDartDeveloperLogs`**: `boolean` Default: `true` null - **`dart.showDartPadSampleCodeLens`**: `boolean` Default: `true` Whether to show CodeLens actions in the editor for opening online DartPad samples\. - **`dart.showDevToolsDebugToolBarButtons`**: `boolean` Default: `true` Whether to show DevTools buttons in the Debug toolbar\. - **`dart.showIgnoreQuickFixes`**: `boolean` Default: `true` Whether to show quick fixes for ignoring hints and lints\. - **`dart.showInspectorNotificationsForWidgetErrors`**: `boolean` Default: `true` null - **`dart.showMainCodeLens`**: `boolean` Default: `true` Whether to show CodeLens actions in the editor for quick running \/ debugging scripts with main functions\. - **`dart.showSkippedTests`**: `boolean` Default: `true` null - **`dart.showTestCodeLens`**: `boolean` Default: `true` Whether to show CodeLens actions in the editor for quick running \/ debugging tests\. - **`dart.showTodos`**: `boolean` Default: `true` Whether to show TODOs in the Problems list\. - **`dart.triggerSignatureHelpAutomatically`**: `boolean` Whether to automatically trigger signature help when pressing keys such as \, and \(\. - **`dart.updateImportsOnRename`**: `boolean` Default: `true` Whether to automatically update imports when moving or renaming files\. Currently only supports single file moves \/ renames\. - **`dart.useKnownChromeOSPorts`**: `boolean` Default: `true` Whether to use specific ports for the VM service and DevTools when running in Chrome OS\. This is required to connect from the native Chrome OS browser but will prevent apps from launching if the ports are already in\-use \(for example if trying to run a second app\)\. - **`dart.vmAdditionalArgs`**: `array` Default: `{}` Array items: `{type = "string"}` Additional args to pass to the Dart VM when running\/debugging command line apps\. - **`dart.vmServiceLogFile`**: `null|string` Default: `vim.NIL` null - **`dart.warnWhenEditingFilesInPubCache`**: `boolean` Default: `true` null - **`dart.warnWhenEditingFilesOutsideWorkspace`**: `boolean` Default: `true` Whether to show a warning when modifying files outside of the workspace\. - **`dart.webDaemonLogFile`**: `null|string` Default: `vim.NIL` null
```lua require'lspconfig'.dartls.setup{} Commands: Default Values: cmd = { "dart", "./snapshots/analysis_server.dart.snapshot", "--lsp" } filetypes = { "dart" } init_options = { closingLabels = false, flutterOutline = false, onlyAnalyzeProjectsWithOpenFiles = false, outline = false, suggestFromUnimportedLibraries = true } root_dir = root_pattern("pubspec.yaml") ``` ## denols https://github.com/denoland/deno Deno's built-in language server ```lua require'lspconfig'.denols.setup{} Commands: - DenolsCache: Cache a module and all of its dependencies. - DenolsDefinition: Jump to definition. This handle deno:/ schema in deno:// buffer. - DenolsReferences: List references. This handle deno:/ schema in deno:// buffer. Default Values: cmd = { "deno", "lsp" } filetypes = { "javascript", "javascriptreact", "javascript.jsx", "typescript", "typescriptreact", "typescript.tsx" } handlers = { ["textDocument/definition"] = , ["textDocument/references"] = } init_options = { enable = true, lint = false, unstable = false } root_dir = root_pattern("package.json", "tsconfig.json", ".git") ``` ## dhall_lsp_server ```lua require'lspconfig'.dhall_lsp_server.setup{} Commands: Default Values: cmd = { "dhall-lsp-server" } docs = { default_config = { root_dir = 'root_pattern(".git", vim.fn.getcwd())' }, description = "https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-lsp-server\n\nlanguage server for dhall\n\n`dhall-lsp-server` can be installed via cabal:\n```sh\ncabal install dhall-lsp-server\n```\nprebuilt binaries can be found [here](https://github.com/dhall-lang/dhall-haskell/releases).\n" } filetypes = { "dhall" } root_dir = function(startpath) return M.search_ancestors(startpath, matcher) end ``` ## diagnosticls https://github.com/iamcco/diagnostic-languageserver Diagnostic language server integrate with linters. ```lua require'lspconfig'.diagnosticls.setup{} Commands: Default Values: cmd = { "diagnostic-languageserver", "--stdio" } filetypes = Empty by default, override to add filetypes root_dir = Vim's starting directory ``` ## dockerls https://github.com/rcjsuen/dockerfile-language-server-nodejs `docker-langserver` can be installed via `npm`: ```sh npm install -g dockerfile-language-server-nodejs ``` ```lua require'lspconfig'.dockerls.setup{} Commands: Default Values: cmd = { "docker-langserver", "--stdio" } filetypes = { "Dockerfile", "dockerfile" } root_dir = root_pattern("Dockerfile") ``` ## dotls https://github.com/nikeee/dot-language-server `dot-language-server` can be installed via `npm`: ```sh npm install -g dot-language-server ``` ```lua require'lspconfig'.dotls.setup{} Commands: Default Values: cmd = { "dot-language-server", "--stdio" } filetypes = { "dot" } root_dir = function(filename) return util.root_pattern(unpack(root_files))(filename) or util.path.dirname(filename) end; ``` ## efm https://github.com/mattn/efm-langserver General purpose Language Server that can use specified error message format generated from specified command. ```lua require'lspconfig'.efm.setup{} Commands: Default Values: cmd = { "efm-langserver" } root_dir = root_pattern(".git") ``` ## elixirls https://github.com/elixir-lsp/elixir-ls `elixir-ls` can be installed by following the instructions [here](https://github.com/elixir-lsp/elixir-ls#building-and-running). ```bash curl -fLO https://github.com/elixir-lsp/elixir-ls/releases/latest/download/elixir-ls.zip unzip elixir-ls.zip -d /path/to/elixir-ls # Unix chmod +x /path/to/elixir-ls/language_server.sh ``` **By default, elixir-ls doesn't have a `cmd` set.** This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set `cmd` to the absolute path ($HOME and ~ are not expanded) of your unzipped elixir-ls. ```lua require'lspconfig'.elixirls.setup{ -- Unix cmd = { "/path/to/elixir-ls/language_server.sh" }; -- Windows cmd = { "/path/to/elixir-ls/language_server.bat" }; ... } ``` This server accepts configuration via the `settings` key.
Available settings: - **`elixirLS.dialyzerEnabled`**: `boolean` Default: `true` Run ElixirLS\'s rapid Dialyzer when code is saved - **`elixirLS.dialyzerFormat`**: `enum { "dialyzer", "dialyxir_short", "dialyxir_long" }` Default: `"dialyzer"` Formatter to use for Dialyzer warnings - **`elixirLS.dialyzerWarnOpts`**: `array` Default: `{}` Array items: `{enum = { "error_handling", "no_behaviours", "no_contracts", "no_fail_call", "no_fun_app", "no_improper_lists", "no_match", "no_missing_calls", "no_opaque", "no_return", "no_undefined_callbacks", "no_unused", "underspecs", "unknown", "unmatched_returns", "overspecs", "specdiffs" },type = "string"}` Dialyzer options to enable or disable warnings\. See Dialyzer\'s documentation for options\. Note that the \"race\_conditions\" option is unsupported - **`elixirLS.fetchDeps`**: `boolean` Default: `true` Automatically fetch project dependencies when compiling - **`elixirLS.mixEnv`**: `string` Default: `"test"` Mix environment to use for compilation - **`elixirLS.projectDir`**: `string` Subdirectory containing Mix project if not in the project root - **`elixirLS.suggestSpecs`**: `boolean` Default: `true` Suggest \@spec annotations inline using Dialyzer\'s inferred success typings \(Requires Dialyzer\)
```lua require'lspconfig'.elixirls.setup{} Commands: Default Values: filetypes = { "elixir", "eelixir" } root_dir = root_pattern("mix.exs", ".git") or vim.loop.os_homedir() ``` ## elmls https://github.com/elm-tooling/elm-language-server#installation If you don't want to use Nvim to install it, then you can use: ```sh npm install -g elm elm-test elm-format @elm-tooling/elm-language-server ``` This server accepts configuration via the `settings` key.
Available settings: - **`elmLS.disableElmLSDiagnostics`**: `boolean` Disable linting diagnostics from the language server\. - **`elmLS.elmFormatPath`**: `string` Default: `""` The path to your elm\-format executable\. Should be empty by default\, in that case it will assume the name and try to first get it from a local npm installation or a global one\. If you set it manually it will not try to load from the npm folder\. - **`elmLS.elmPath`**: `string` Default: `""` The path to your elm executable\. Should be empty by default\, in that case it will assume the name and try to first get it from a local npm installation or a global one\. If you set it manually it will not try to load from the npm folder\. - **`elmLS.elmTestPath`**: `string` Default: `""` The path to your elm\-test executable\. Should be empty by default\, in that case it will assume the name and try to first get it from a local npm installation or a global one\. If you set it manually it will not try to load from the npm folder\. - **`elmLS.onlyUpdateDiagnosticsOnSave`**: `boolean` Only update compiler diagnostics on save\, not on document change\. - **`elmLS.skipInstallPackageConfirmation`**: `boolean` Skips confirmation for the Install Package code action\. - **`elmLS.trace.server`**: `enum { "off", "messages", "verbose" }` Default: `"off"` Traces the communication between VS Code and the language server\.
```lua require'lspconfig'.elmls.setup{} Commands: Default Values: cmd = { "elm-language-server" } filetypes = { "elm" } init_options = { elmAnalyseTrigger = "change", elmFormatPath = "elm-format", elmPath = "elm", elmTestPath = "elm-test" } root_dir = root_pattern("elm.json") ``` ## erlangls https://erlang-ls.github.io Language Server for Erlang. Clone [erlang_ls](https://github.com/erlang-ls/erlang_ls) Compile the project with `make` and copy resulting binaries somewhere in your $PATH eg. `cp _build/*/bin/* ~/local/bin` Installation instruction can be found [here](https://github.com/erlang-ls/erlang_ls). Installation requirements: - [Erlang OTP 21+](https://github.com/erlang/otp) - [rebar3 3.9.1+](https://github.com/erlang/rebar3) ```lua require'lspconfig'.erlangls.setup{} Commands: Default Values: cmd = { "erlang_ls" } filetypes = { "erlang" } root_dir = root_pattern('rebar.config', 'erlang.mk', '.git') or util.path.dirname(fname) ``` ## flow https://flow.org/ https://github.com/facebook/flow See below for how to setup Flow itself. https://flow.org/en/docs/install/ See below for lsp command options. ```sh npx flow lsp --help ``` This server accepts configuration via the `settings` key.
Available settings: - **`flow.coverageSeverity`**: `enum { "error", "warn", "info" }` Default: `"info"` Type coverage diagnostic severity - **`flow.enabled`**: `boolean` Default: `true` Is flow enabled - **`flow.fileExtensions`**: `array` Default: `{ ".js", ".mjs", ".jsx", ".flow", ".json" }` Array items: `{type = "string"}` \(Supported only when useLSP\: false\)\. File extensions to consider for flow processing - **`flow.lazyMode`**: `string` Default: `vim.NIL` Set value to enable flow lazy mode - **`flow.logLevel`**: `enum { "error", "warn", "info", "trace" }` Default: `"info"` Log level for output panel logs - **`flow.pathToFlow`**: `string` Default: `"flow"` Absolute path to flow binary\. Special var \$\{workspaceFolder\} or \$\{flowconfigDir\} can be used in path \(NOTE\: in windows you can use \'\/\' and can omit \'\.cmd\' in path\) - **`flow.runOnAllFiles`**: `boolean` \(Supported only when useLSP\: false\) Run Flow on all files\, No need to put \/\/\@flow comment on top of files\. - **`flow.runOnEdit`**: `boolean` Default: `true` If true will run flow on every edit\, otherwise will run only when changes are saved \(Note\: \'useLSP\: true\' only supports syntax errors\) - **`flow.showStatus`**: `boolean` Default: `true` \(Supported only when useLSP\: false\) If true will display flow status is the statusbar - **`flow.showUncovered`**: `boolean` If true will show uncovered code by default - **`flow.stopFlowOnExit`**: `boolean` Default: `true` Stop Flow on Exit - **`flow.trace.server`** Default: `"off"` Traces the communication between VSCode and the flow lsp service\. - **`flow.useBundledFlow`**: `boolean` Default: `true` If true will use flow bundled with this plugin if nothing works - **`flow.useCodeSnippetOnFunctionSuggest`**: `boolean` Default: `true` Complete functions with their parameter signature\. - **`flow.useLSP`**: `boolean` Default: `true` Turn off to switch from the official Flow Language Server implementation to talking directly to flow\. - **`flow.useNPMPackagedFlow`**: `boolean` Default: `true` Support using flow through your node\_modules folder\, WARNING\: Checking this box is a security risk\. When you open a project we will immediately run code contained within it\.
```lua require'lspconfig'.flow.setup{} Commands: Default Values: cmd = { "npx", "--no-install", "flow", "lsp" } filetypes = { "javascript", "javascriptreact", "javascript.jsx" } root_dir = root_pattern(".flowconfig") ``` ## fortls https://github.com/hansec/fortran-language-server Fortran Language Server for the Language Server Protocol This server accepts configuration via the `settings` key.
Available settings: - **`fortran-ls.autocompletePrefix`**: `boolean` Filter autocomplete suggestions with variable prefix - **`fortran-ls.disableDiagnostics`**: `boolean` Disable diagnostics \(requires v1\.12\.0+\)\. - **`fortran-ls.displayVerWarning`**: `boolean` Default: `true` Provides notifications when the underlying language server is out of date\. - **`fortran-ls.enableCodeActions`**: `boolean` Enable experimental code actions \(requires v1\.7\.0+\)\. - **`fortran-ls.executablePath`**: `string` Default: `"fortls"` Path to the Fortran language server \(fortls\)\. - **`fortran-ls.hoverSignature`**: `boolean` Show signature information in hover for argument \(also enables \'variableHover\'\)\. - **`fortran-ls.includeSymbolMem`**: `boolean` Default: `true` Include type members in document outline \(also used for \'Go to Symbol in File\'\) - **`fortran-ls.incrementalSync`**: `boolean` Default: `true` Use incremental synchronization for file changes\. - **`fortran-ls.lowercaseIntrinsics`**: `boolean` Use lowercase for intrinsics and keywords in autocomplete requests\. - **`fortran-ls.maxCommentLineLength`**: `number` Default: `-1` Maximum comment line length \(requires v1\.8\.0+\)\. - **`fortran-ls.maxLineLength`**: `number` Default: `-1` Maximum line length \(requires v1\.8\.0+\)\. - **`fortran-ls.notifyInit`**: `boolean` Notify when workspace initialization is complete \(requires v1\.7\.0+\)\. - **`fortran-ls.useSignatureHelp`**: `boolean` Default: `true` Use signature help instead of snippets when available\. - **`fortran-ls.variableHover`**: `boolean` Show hover information for variables\.
```lua require'lspconfig'.fortls.setup{} Commands: Default Values: cmd = { "fortls" } filetypes = { "fortran" } root_dir = root_pattern(".fortls") settings = { nthreads = 1 } ``` ## fsautocomplete https://github.com/fsharp/FsAutoComplete Language Server for F# provded by FsAutoComplete (FSAC). Download a release of FsAutoComplete from [here](https://github.com/fsharp/FsAutoComplete/releases). Instructions to compile from source are found on the main repository. FsAutoComplete requires the [dotnet-sdk](https://dotnet.microsoft.com/download) to be installed. You may also need to configure the filetype as Vim defaults to Forth for `*.fs` files: `autocmd BufNewFile,BufRead *.fs,*.fsx,*.fsi set filetype=fsharp` This is automatically done by plugins such as [vim-polyglot](https://github.com/sheerun/vim-polyglot), [PhilT/vim-fsharp](https://github.com/PhilT/vim-fsharp) or [fsharp/vim-fsharp](https://github.com/fsharp/vim-fsharp). **By default, this config doesn't have a `cmd` set.** This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set `cmd` to the absolute path ($HOME and ~ are not expanded) of your unzipped and compiled fsautocomplete.dll. ```lua require'lspconfig'.fsautocomplete.setup{ cmd = {'dotnet', 'path/to/fsautocomplete.dll', '--background-service-enabled'} } ``` ```lua require'lspconfig'.fsautocomplete.setup{} Commands: Default Values: filetypes = { "fsharp" } init_options = { AutomaticWorkspaceInit = true } root_dir = function(startpath) return M.search_ancestors(startpath, matcher) end ``` ## gdscript https://github.com/godotengine/godot Language server for GDScript, used by Godot Engine. ```lua require'lspconfig'.gdscript.setup{} Commands: Default Values: cmd = { "nc", "localhost", "6008" } filetypes = { "gd", "gdscript", "gdscript3" } root_dir = util.root_pattern("project.godot", ".git") ``` ## ghcide https://github.com/digital-asset/ghcide A library for building Haskell IDE tooling. "ghcide" isn't for end users now. Use "haskell-language-server" instead of "ghcide". ```lua require'lspconfig'.ghcide.setup{} Commands: Default Values: cmd = { "ghcide", "--lsp" } filetypes = { "haskell", "lhaskell" } root_dir = root_pattern("stack.yaml", "hie-bios", "BUILD.bazel", "cabal.config", "package.yaml") ``` ## gopls https://github.com/golang/tools/tree/master/gopls Google's lsp server for golang. ```lua require'lspconfig'.gopls.setup{} Commands: Default Values: cmd = { "gopls" } filetypes = { "go", "gomod" } root_dir = root_pattern("go.mod", ".git") ``` ## graphql https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-cli `graphql-lsp` can be installed via `npm`: ```sh npm install -g graphql-language-service-cli ``` ```lua require'lspconfig'.graphql.setup{} Commands: Default Values: cmd = { "graphql-lsp", "server", "-m", "stream" } filetypes = { "graphql" } root_dir = root_pattern('.git', '.graphqlrc') ``` ## groovyls https://github.com/prominic/groovy-language-server.git Requirements: - Linux/macOS (for now) - Java 11+ `groovyls` can be installed by following the instructions [here](https://github.com/prominic/groovy-language-server.git#build). If you have installed groovy language server, you can set the `cmd` custom path as follow: ```lua require'lspconfig'.groovyls.setup{ -- Unix cmd = { "java", "-jar", "path/to/groovyls/groovy-language-server-all.jar" }, ... } ``` ```lua require'lspconfig'.groovyls.setup{} Commands: Default Values: cmd = { "java", "-jar", "groovy-language-server-all.jar" } filetypes = { "groovy" } root_dir = root_pattern(".git") or vim.loop.os_homedir() ``` ## haxe_language_server https://github.com/vshaxe/haxe-language-server The Haxe language server can be built by running the following commands from the project's root directory: npm install npx lix run vshaxe-build -t language-server This will create `bin/server.js`. Note that the server requires Haxe 3.4.0 or higher. After building the language server, set the `cmd` setting in your setup function: ```lua lspconfig.haxe_language_server.setup({ cmd = {"node", "path/to/bin/server.js"}, }) ``` By default, an HXML compiler arguments file named `build.hxml` is expected in your project's root directory. If your file is named something different, specify it using the `init_options.displayArguments` setting. ```lua require'lspconfig'.haxe_language_server.setup{} Commands: Default Values: cmd = { "haxe-language-server" } filetypes = { "haxe" } init_options = { displayArguments = { "build.hxml" } } root_dir = root_pattern("*.hxml") settings = { haxe = { executable = "haxe" } } ``` ## hie https://github.com/haskell/haskell-ide-engine the following init_options are supported (see https://github.com/haskell/haskell-ide-engine#configuration): ```lua init_options = { languageServerHaskell = { hlintOn = bool; maxNumberOfProblems = number; diagnosticsDebounceDuration = number; liquidOn = bool (default false); completionSnippetsOn = bool (default true); formatOnImportOn = bool (default true); formattingProvider = string (default "brittany", alternate "floskell"); } } ``` This server accepts configuration via the `settings` key.
Available settings: - **`haskell.completionSnippetsOn`**: `boolean` Default: `true` Show snippets with type information when using code completion - **`haskell.diagnosticsOnChange`**: `boolean` Default: `true` Compute diagnostics continuously as you type\. Turn off to only generate diagnostics on file save\. - **`haskell.formatOnImportOn`**: `boolean` Default: `true` When adding an import\, use the formatter on the result - **`haskell.formattingProvider`**: `enum { "brittany", "floskell", "fourmolu", "ormolu", "stylish-haskell", "none" }` Default: `"ormolu"` The formatter to use when formatting a document or range\. Ensure the plugin is enabled\. - **`haskell.hlintOn`**: `boolean` Default: `true` Get suggestions from hlint - **`haskell.logFile`**: `string` Default: `""` If set\, redirects the logs to a file\. - **`haskell.plugin.class.globalOn`**: `boolean` Default: `true` Enables type class plugin - **`haskell.plugin.eval.globalOn`**: `boolean` Default: `true` Enables eval plugin - **`haskell.plugin.ghcide-type-lenses.config.mode`**: `enum { "always", "exported", "diagnostics" }` Default: `true` Control how type lenses are shown - **`haskell.plugin.ghcide-type-lenses.globalOn`**: `boolean` Default: `true` Enables type lenses plugin - **`haskell.plugin.haddockComments.globalOn`**: `boolean` Default: `true` Enables haddock comments plugin - **`haskell.plugin.hlint.codeActionsOn`**: `boolean` Default: `true` Enables hlint code actions \(apply hints\) - **`haskell.plugin.hlint.diagnosticsOn`**: `boolean` Default: `true` Enables hlint diagnostics - **`haskell.plugin.importLens.codeActionsOn`**: `boolean` Default: `true` Enables explicit imports code actions - **`haskell.plugin.importLens.codeLensOn`**: `boolean` Default: `true` Enables explicit imports code lenses - **`haskell.plugin.moduleName.globalOn`**: `boolean` Default: `true` Enables module name plugin - **`haskell.plugin.pragmas.codeActionsOn`**: `boolean` Default: `true` Enables pragmas code actions - **`haskell.plugin.pragmas.completionOn`**: `boolean` Default: `true` Enables pragmas completions - **`haskell.plugin.retrie.globalOn`**: `boolean` Default: `true` Enables retrie plugin - **`haskell.plugin.splice.globalOn`**: `boolean` Default: `true` Enables splice plugin \(expand template haskell definitions\) - **`haskell.plugin.tactic.config.features`**: `string` Default: `true` null - **`haskell.plugin.tactic.config.max_use_ctor_actions`**: `integer` Default: `true` null - **`haskell.plugin.tactic.globalOn`**: `boolean` Default: `true` Enables wingman \(tactic\) plugin - **`haskell.releasesURL`**: `string` Default: `""` An optional URL to override where to check for haskell\-language\-server releases - **`haskell.serverExecutablePath`**: `string` Default: `""` Manually set a language server executable\. Can be something on the \$PATH or a path to an executable itself\. Works with ~\, \$\{HOME\} and \$\{workspaceFolder\}\. - **`haskell.trace.server`**: `enum { "off", "messages" }` Default: `"off"` Traces the communication between VS Code and the language server\. - **`haskell.updateBehavior`**: `enum { "keep-up-to-date", "prompt", "never-check" }` Default: `"keep-up-to-date"` null
```lua require'lspconfig'.hie.setup{} Commands: Default Values: cmd = { "hie-wrapper", "--lsp" } filetypes = { "haskell" } root_dir = root_pattern("stack.yaml", "package.yaml", ".git") ``` ## hls https://github.com/haskell/haskell-language-server Haskell Language Server ```lua require'lspconfig'.hls.setup{} Commands: Default Values: cmd = { "haskell-language-server-wrapper", "--lsp" } filetypes = { "haskell", "lhaskell" } lspinfo = function (cfg) -- return "specific" if cfg.settings.languageServerHaskell.logFile or false then return "logfile: "..cfg.settings.languageServerHaskell.logFile end return "" end; root_dir = root_pattern("*.cabal", "stack.yaml", "cabal.project", "package.yaml", "hie.yaml") settings = { languageServerHaskell = { formattingProvider = "ormolu" } } ``` ## html https://github.com/vscode-langservers/vscode-html-languageserver-bin `vscode-html-languageserver` can be installed via `npm`: ```sh npm install -g vscode-html-languageserver-bin ``` Neovim does not currently include built-in snippets. `vscode-html-languageserver` only provides completions when snippet support is enabled. To enable completion, install a snippet plugin and add the following override to your language client capabilities during setup. ```lua --Enable (broadcasting) snippet capability for completion local capabilities = vim.lsp.protocol.make_client_capabilities() capabilities.textDocument.completion.completionItem.snippetSupport = true require'lspconfig'.html.setup { capabilities = capabilities, } ``` ```lua require'lspconfig'.html.setup{} Commands: Default Values: cmd = { "html-languageserver", "--stdio" } filetypes = { "html" } init_options = { configurationSection = { "html", "css", "javascript" }, embeddedLanguages = { css = true, javascript = true } } root_dir = function(fname) return root_pattern(fname) or vim.loop.os_homedir() end; settings = {} ``` ## intelephense https://intelephense.com/ `intelephense` can be installed via `npm`: ```sh npm install -g intelephense ``` ```lua require'lspconfig'.intelephense.setup{} Commands: Default Values: cmd = { "intelephense", "--stdio" } filetypes = { "php" } root_dir = root_pattern("composer.json", ".git") ``` ## jdtls https://projects.eclipse.org/projects/eclipse.jdt.ls Language server for Java. See project page for installation instructions. Due to the nature of java, the settings for eclipse jdtls cannot be automatically inferred. Please set the following environmental variables to match your installation. You can set these locally for your project with the help of [direnv](https://github.com/direnv/direnv). Note version numbers will change depending on your project's version of java, your version of eclipse, and in the case of JDTLS_CONFIG, your OS. ```bash export JAR=/path/to/eclipse.jdt.ls/org.eclipse.jdt.ls.product/target/repository/plugins/org.eclipse.equinox.launcher_1.6.0.v20200915-1508.jar export GRADLE_HOME=$HOME/gradle export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-11.0.9.11-9.fc33.x86_64/ export JDTLS_CONFIG=/path/to/eclipse.jdt.ls/org.eclipse.jdt.ls.product/target/repository/config_linux export WORKSPACE=$HOME/workspace ``` ```lua require'lspconfig'.jdtls.setup{} Commands: Default Values: cmd = { "/usr/lib/jvm/adoptopenjdk-11-hotspot-amd64/bin/java", "-Declipse.application=org.eclipse.jdt.ls.core.id1", "-Dosgi.bundles.defaultStartLevel=4", "-Declipse.product=org.eclipse.jdt.ls.core.product", "-Dlog.protocol=true", "-Dlog.level=ALL", "-Xms1g", "-Xmx2G", "-jar", "vim.NIL", "-configuration", "vim.NIL", "-data", "vim.NIL", "--add-modules=ALL-SYSTEM", "--add-opens java.base/java.util=ALL-UNNAMED", "--add-opens java.base/java.lang=ALL-UNNAMED" } cmd_env = { GRADLE_HOME = "/usr/share/gradle", JAR = vim.NIL } filetypes = { "java" } handlers = { ["language/status"] = , ["textDocument/codeAction"] = , ["textDocument/rename"] = , ["workspace/applyEdit"] = } init_options = { jvm_args = {}, workspace = "/home/runner/workspace" } root_dir = root_pattern(".git") ``` ## jedi_language_server https://github.com/pappasam/jedi-language-server `jedi-language-server`, a language server for Python, built on top of jedi ```lua require'lspconfig'.jedi_language_server.setup{} Commands: Default Values: cmd = { "jedi-language-server" } filetypes = { "python" } root_dir = vim's starting directory ``` ## jsonls https://github.com/vscode-langservers/vscode-json-languageserver vscode-json-languageserver, a language server for JSON and JSON schema `vscode-json-languageserver` can be installed via `npm`: ```sh npm install -g vscode-json-languageserver ``` vscode-json-languageserver only provides range formatting. You can map a command that applies range formatting to the entire document: ```lua require'lspconfig'.jsonls.setup { commands = { Format = { function() vim.lsp.buf.range_formatting({},{0,0},{vim.fn.line("$"),0}) end } } } ``` This server accepts configuration via the `settings` key.
Available settings: - **`json.colorDecorators.enable`**: `boolean` Default: `true` \%json\.colorDecorators\.enable\.desc\% - **`json.format.enable`**: `boolean` Default: `true` \%json\.format\.enable\.desc\% - **`json.maxItemsComputed`**: `number` Default: `5000` \%json\.maxItemsComputed\.desc\% - **`json.schemaDownload.enable`**: `boolean` Default: `true` \%json\.enableSchemaDownload\.desc\% - **`json.schemas`**: `array` Array items: `{default = {fileMatch = { "/myfile" },url = "schemaURL"},properties = {fileMatch = {description = "%json.schemas.fileMatch.desc%",items = {default = "MyFile.json",description = "%json.schemas.fileMatch.item.desc%",type = "string"},minItems = 1,type = "array"},schema = {["$ref"] = "http://json-schema.org/draft-07/schema#",description = "%json.schemas.schema.desc%"},url = {default = "/user.schema.json",description = "%json.schemas.url.desc%",type = "string"}},type = "object"}` \%json\.schemas\.desc\% - **`json.trace.server`**: `enum { "off", "messages", "verbose" }` Default: `"off"` \%json\.tracing\.desc\%
```lua require'lspconfig'.jsonls.setup{} Commands: Default Values: cmd = { "vscode-json-languageserver", "--stdio" } filetypes = { "json" } init_options = { provideFormatter = true } root_dir = root_pattern(".git", vim.fn.getcwd()) ``` ## julials https://github.com/julia-vscode/julia-vscode `LanguageServer.jl` can be installed with `julia` and `Pkg`: ```sh julia -e 'using Pkg; Pkg.add("LanguageServer"); Pkg.add("SymbolServer")' ``` The default config lazily evaluates the location of the julia language server from the your global julia packages. This adds a small overhead on first opening of a julia file. To avoid this overhead, replace server_path in on_new_config with a hard-coded path to the server. ```lua require'lspconfig'.julials.setup{ on_new_config = function(new_config,new_root_dir) server_path = "/path/to/directory/containing/LanguageServer.jl/src" cmd = { "julia", "--project="..server_path, "--startup-file=no", "--history-file=no", "-e", [[ using Pkg; Pkg.instantiate() using LanguageServer; using SymbolServer; depot_path = get(ENV, "JULIA_DEPOT_PATH", "") project_path = dirname(something(Base.current_project(pwd()), Base.load_path_expand(LOAD_PATH[2]))) # Make sure that we only load packages from this environment specifically. @info "Running language server" env=Base.load_path()[1] pwd() project_path depot_path server = LanguageServer.LanguageServerInstance(stdin, stdout, project_path, depot_path); server.runlinter = true; run(server); \]\] }; new_config.cmd = cmd end } ``` You can find the path to the globally installed LanguageServer.jl package with the following command: ```bash julia -e 'print(Base.find_package("LanguageServer"))' ``` Note: the directory passed to `--project=...` should terminate with src, not LanguageServer.jl. This server accepts configuration via the `settings` key.
Available settings: - **`julia.NumThreads`**: `integer|null` Default: `vim.NIL` Number of threads to use for Julia processes\. - **`julia.additionalArgs`**: `array` Default: `{}` Additional Julia arguments\. - **`julia.editor`**: `string|null` Default: `vim.NIL` null - **`julia.enableCrashReporter`**: `boolean|null` Default: `vim.NIL` Enable crash reports to be sent to the julia VS Code extension developers\. - **`julia.enableTelemetry`**: `boolean|null` Default: `vim.NIL` Enable usage data and errors to be sent to the julia VS Code extension developers\. - **`julia.environmentPath`**: `string|null` Default: `vim.NIL` Path to a julia environment\. VS Code needs to be reloaded for changes to take effect\. - **`julia.executablePath`**: `string` Default: `""` Points to the julia executable\. - **`julia.execution.codeInREPL`**: `boolean` Print executed code in REPL and append it to the REPL history\. - **`julia.execution.inlineResults.colors`**: `object` Default: `vim.empty_dict()` null - **`julia.execution.resultType`**: `enum { "REPL", "inline", "both" }` Default: `"REPL"` Specifies how to show inline execution results - **`julia.format.calls`**: `boolean` Default: `true` Format function calls\. - **`julia.format.comments`**: `boolean` Default: `true` Format comments\. - **`julia.format.curly`**: `boolean` Default: `true` Format braces\. - **`julia.format.docs`**: `boolean` Default: `true` Format inline documentation\. - **`julia.format.indent`**: `integer` Default: `4` Indent size for formatting\. - **`julia.format.indents`**: `boolean` Default: `true` Format file indents\. - **`julia.format.iterOps`**: `boolean` Default: `true` Format loop iterators\. - **`julia.format.keywords`**: `bool` Default: `true` Ensure single spacing following keywords\. - **`julia.format.kwarg`**: `enum { "none", "single", "off" }` Default: `"none"` Format whitespace around function keyword arguments\. - **`julia.format.ops`**: `boolean` Default: `true` Format whitespace around operators\. - **`julia.format.tuples`**: `boolean` Default: `true` Format tuples\. - **`julia.lint.call`**: `boolean` Default: `true` This compares call signatures against all known methods for the called function\. Calls with too many or too few arguments\, or unknown keyword parameters are highlighted\. - **`julia.lint.constif`**: `boolean` Default: `true` Check for constant conditionals in if statements that result in branches never being reached\.\. - **`julia.lint.datadecl`**: `boolean` Default: `true` Check variables used in type declarations are datatypes\. - **`julia.lint.disabledDirs`**: `array` Default: `{ "docs", "test" }` null - **`julia.lint.iter`**: `boolean` Default: `true` Check iterator syntax of loops\. Will identify\, for example\, attempts to iterate over single values\. - **`julia.lint.lazy`**: `boolean` Default: `true` Check for deterministic lazy boolean operators\. - **`julia.lint.missingrefs`**: `enum { "none", "symbols", "all" }` Default: `"none"` Highlight unknown symbols\. The \`symbols\` option will not mark unknown fields\. - **`julia.lint.modname`**: `boolean` Default: `true` Check submodule names do not shadow their parent\'s name\. - **`julia.lint.nothingcomp`**: `boolean` Default: `true` Check for use of \`\=\=\` rather than \`\=\=\=\` when comparing against \`nothing\`\. - **`julia.lint.pirates`**: `boolean` Default: `true` Check for type piracy \- the overloading of external functions with methods specified for external datatypes\. \'External\' here refers to imported code\. - **`julia.lint.run`**: `boolean` Default: `true` Run the linter on active files\. - **`julia.lint.typeparam`**: `boolean` Default: `true` Check parameters declared in \`where\` statements or datatype declarations are used\. - **`julia.lint.useoffuncargs`**: `boolean` Default: `true` Check that all declared arguments are used within the function body\. - **`julia.liveTestFile`**: `string` Default: `"test/runtests.jl"` A workspace relative path to a Julia file that contains the tests that should be run for live testing\. - **`julia.packageServer`**: `string` Default: `""` Julia package server\. Set\'s the \`JULIA\_PKG\_SERVER\` environment variable \*before\* starting a Julia process\. Leave this empty to use the systemwide default\. Requires a restart of the Julia process\. - **`julia.trace.server`**: `enum { "off", "messages", "verbose" }` Default: `"off"` Traces the communication between VS Code and the language server\. - **`julia.useCustomSysimage`**: `boolean` Use an existing custom sysimage when starting the REPL - **`julia.usePlotPane`**: `boolean` Default: `true` Display plots within VS Code\. Might require a restart of the Julia process\. - **`julia.useProgressFrontend`**: `boolean` Default: `true` null - **`julia.useRevise`**: `boolean` Default: `true` Load Revise\.jl on startup of the REPL\.
```lua require'lspconfig'.julials.setup{} Commands: Default Values: cmd = { "julia", "--startup-file=no", "--history-file=no", "-e", ' using Pkg;\n Pkg.instantiate()\n using LanguageServer; using SymbolServer;\n depot_path = get(ENV, "JULIA_DEPOT_PATH", "")\n project_path = dirname(something(Base.current_project(pwd()), Base.load_path_expand(LOAD_PATH[2])))\n # Make sure that we only load packages from this environment specifically.\n @info "Running language server" env=Base.load_path()[1] pwd() project_path depot_path\n server = LanguageServer.LanguageServerInstance(stdin, stdout, project_path, depot_path);\n server.runlinter = true;\n run(server);\n ' } filetypes = { "julia" } on_new_config = function(new_config, _) local server_path = vim.fn.system("julia -e 'print(Base.find_package(\"LanguageServer\"))'") local new_cmd = vim.deepcopy(cmd) table.insert(new_cmd, 2, "--project="..server_path:sub(0,-19)) new_config.cmd = new_cmd end, root_dir = function(fname) return util.find_git_ancestor(fname) or vim.fn.getcwd() end; ``` ## kotlin_language_server A kotlin language server which was developed for internal usage and released afterwards. Maintaining is not done by the original author, but by fwcd. It is builded via gradle and developed on github. Source and additional description: https://github.com/fwcd/kotlin-language-server This server accepts configuration via the `settings` key.
Available settings: - **`kotlin.compiler.jvm.target`**: `string` Default: `"default"` Specifies the JVM target\, e\.g\. \"1\.6\" or \"1\.8\" - **`kotlin.completion.snippets.enabled`**: `boolean` Default: `true` Specifies whether code completion should provide snippets \(true\) or plain\-text items \(false\)\. - **`kotlin.debounceTime`**: `integer` Default: `250` \[DEPRECATED\] Specifies the debounce time limit\. Lower to increase responsiveness at the cost of possibile stability issues\. - **`kotlin.debugAdapter.enabled`**: `boolean` Default: `true` \[Recommended\] Specifies whether the debug adapter should be used\. When enabled a debugger for Kotlin will be available\. - **`kotlin.debugAdapter.path`**: `string` Default: `""` Optionally a custom path to the debug adapter executable\. - **`kotlin.externalSources.autoConvertToKotlin`**: `boolean` Default: `true` Specifies whether decompiled\/external classes should be auto\-converted to Kotlin\. - **`kotlin.externalSources.useKlsScheme`**: `boolean` Default: `true` \[Recommended\] Specifies whether URIs inside JARs should be represented using the \'kls\'\-scheme\. - **`kotlin.indexing.enabled`**: `boolean` Default: `true` Whether global symbols in the project should be indexed automatically in the background\. This enables e\.g\. code completion for unimported classes and functions\. - **`kotlin.languageServer.debugAttach.autoSuspend`**: `boolean` \[DEBUG\] If enabled \(together with debugAttach\.enabled\)\, the language server will not immediately launch but instead listen on the specified attach port and wait for a debugger\. This is ONLY useful if you need to debug the language server ITSELF\. - **`kotlin.languageServer.debugAttach.enabled`**: `boolean` \[DEBUG\] Whether the language server should listen for debuggers\, i\.e\. be debuggable while running in VSCode\. This is ONLY useful if you need to debug the language server ITSELF\. - **`kotlin.languageServer.debugAttach.port`**: `integer` Default: `5005` \[DEBUG\] If transport is stdio this enables you to attach to the running langugage server with a debugger\. This is ONLY useful if you need to debug the language server ITSELF\. - **`kotlin.languageServer.enabled`**: `boolean` Default: `true` \[Recommended\] Specifies whether the language server should be used\. When enabled the extension will provide code completions and linting\, otherwise just syntax highlighting\. Might require a reload to apply\. - **`kotlin.languageServer.path`**: `string` Default: `""` Optionally a custom path to the language server executable\. - **`kotlin.languageServer.port`**: `integer` Default: `0` The port to which the client will attempt to connect to\. A random port is used if zero\. Only used if the transport layer is TCP\. - **`kotlin.languageServer.transport`**: `enum { "stdio", "tcp" }` Default: `"stdio"` The transport layer beneath the language server protocol\. Note that the extension will launch the server even if a TCP socket is used\. - **`kotlin.linting.debounceTime`**: `integer` Default: `250` \[DEBUG\] Specifies the debounce time limit\. Lower to increase responsiveness at the cost of possibile stability issues\. - **`kotlin.snippetsEnabled`**: `boolean` Default: `true` \[DEPRECATED\] Specifies whether code completion should provide snippets \(true\) or plain\-text items \(false\)\. - **`kotlin.trace.server`**: `enum { "off", "messages", "verbose" }` Default: `"off"` Traces the communication between VSCode and the Kotlin language server\.
```lua require'lspconfig'.kotlin_language_server.setup{} Commands: Default Values: cmd = { "kotlin-language-server" } filetypes = { "kotlin" } root_dir = root_pattern("settings.gradle") ``` ## leanls https://github.com/leanprover/lean-client-js/tree/master/lean-language-server Lean language server. This server accepts configuration via the `settings` key.
Available settings: - **`lean.executablePath`**: `string` Default: `"lean"` null - **`lean.extraOptions`**: `array` Default: `{}` Array items: `{description = "a single command-line argument",type = "string"}` null - **`lean.infoViewAllErrorsOnLine`**: `boolean` null - **`lean.infoViewAutoOpen`**: `boolean` Default: `true` null - **`lean.infoViewAutoOpenShowGoal`**: `boolean` Default: `true` null - **`lean.infoViewFilterIndex`**: `number` Default: `-1` null - **`lean.infoViewStyle`**: `string` Default: `""` null - **`lean.infoViewTacticStateFilters`**: `array` Default: `{ {flags = "",match = false,regex = "^_"}, {flags = "",match = true,name = "goals only",regex = "^(⊢|\\d+ goals|case|$)"} }` Array items: `{description = "an object with required properties 'regex': string, 'match': boolean, and 'flags': string, and optional property 'name': string",properties = {flags = {description = "additional flags passed to the RegExp constructor, e.g. 'i' for ignore case",type = "string"},match = {description = "whether tactic state lines matching the value of 'regex' should be included (true) or excluded (false)",type = "boolean"},name = {description = "name displayed in the dropdown",type = "string"},regex = {description = "a properly-escaped regex string, e.g. '^_' matches any string beginning with an underscore",type = "string"}},required = { "regex", "match", "flags" },type = "object"}` null - **`lean.input.customTranslations`**: `object` Default: `vim.empty_dict()` Array items: `{description = "Unicode character to translate to",type = "string"}` null - **`lean.input.eagerReplacementEnabled`**: `boolean` Default: `true` null - **`lean.input.enabled`**: `boolean` Default: `true` null - **`lean.input.languages`**: `array` Default: `{ "lean" }` Array items: `{description = "the name of a language, e.g. 'lean', 'markdown'",type = "string"}` null - **`lean.input.leader`**: `string` Default: `"\\"` null - **`lean.leanpkgPath`**: `string` Default: `"leanpkg"` null - **`lean.memoryLimit`**: `number` Default: `4096` null - **`lean.progressMessages`**: `boolean` null - **`lean.roiModeDefault`**: `string` Default: `"visible"` null - **`lean.timeLimit`**: `number` Default: `100000` null - **`lean.typeInStatusBar`**: `boolean` Default: `true` null - **`lean.typesInCompletionList`**: `boolean` null
```lua require'lspconfig'.leanls.setup{} Commands: Default Values: cmd = { "lean-language-server", "--stdio" } filetypes = { "lean" } root_dir = root_pattern(".git") or os_homedir ``` ## metals https://scalameta.org/metals/ Scala language server with rich IDE features. See full instructions in the Metals documentation: https://scalameta.org/metals/docs/editors/vim.html#using-an-alternative-lsp-client Note: that if you're using [nvim-metals](https://github.com/scalameta/nvim-metals), that plugin fully handles the setup and installation of Metals, and you shouldn't set up Metals both with it and this plugin. To install Metals, make sure to have [coursier](https://get-coursier.io/docs/cli-installation) installed, and once you do you can install the latest Metals with `cs install metals`. You can also manually bootstrap Metals with the following command. ```bash cs bootstrap \ --java-opt -Xss4m \ --java-opt -Xms100m \ org.scalameta:metals_2.12: \ -r bintray:scalacenter/releases \ -r sonatype:snapshots \ -o /usr/local/bin/metals -f ``` ```lua require'lspconfig'.metals.setup{} Commands: Default Values: cmd = { "metals" } filetypes = { "scala" } init_options = { compilerOptions = { snippetAutoIndent = false }, isHttpEnabled = true, statusBarProvider = "show-message" } message_level = 4 root_dir = util.root_pattern("build.sbt", "build.sc", "build.gradle", "pom.xml") ``` ## nimls https://github.com/PMunch/nimlsp `nimlsp` can be installed via the `nimble` package manager: ```sh nimble install nimlsp ``` This server accepts configuration via the `settings` key.
Available settings: - **`nim.buildCommand`**: `string` Default: `"c"` Nim build command \(c\, cpp\, doc\, etc\) - **`nim.buildOnSave`**: `boolean` Execute build task from tasks\.json file on save\. - **`nim.enableNimsuggest`**: `boolean` Default: `true` Enable calling nimsuggest process to provide completion suggestions\, hover suggestions\, etc\. This option requires restart to take effect\. - **`nim.licenseString`**: `string` Default: `""` Optional license text that will be inserted on nim file creation\. - **`nim.lintOnSave`**: `boolean` Default: `true` Check code by using \'nim check\' on save\. - **`nim.logNimsuggest`**: `boolean` Enable verbose logging of nimsuggest to use profile directory\. - **`nim.nimprettyIndent`**: `integer` Default: `0` Nimpretty\: set the number of spaces that is used for indentation \-\-indent\:0 means autodetection \(default behaviour\)\. - **`nim.nimprettyMaxLineLen`**: `integer` Default: `80` Nimpretty\: set the desired maximum line length \(default\: 80\)\. - **`nim.nimsuggestRestartTimeout`**: `integer` Default: `60` Nimsuggest will be restarted after this timeout in minutes\, if 0 then restart disabled\. This option requires restart to take effect\. - **`nim.project`**: `array` Default: `{}` Nim project file\, if empty use current selected\. - **`nim.projectMapping`**: `object` Default: `vim.empty_dict()` For non project mode list of per file project mapping using regex\, for example \`\`\`\{\"\(\.\*\)\.inim\"\: \"\$1\.nim\"\}\`\`\` - **`nim.runOutputDirectory`**: `string` Default: `""` Output directory for run selected file command\. The directory is relative to the workspace root\. - **`nim.test-project`**: `string` Default: `""` Optional test project\.
```lua require'lspconfig'.nimls.setup{} Commands: Default Values: cmd = { "nimlsp" } filetypes = { "nim" } root_dir = root_pattern(".git") or os_homedir ``` ## ocamlls https://github.com/ocaml-lsp/ocaml-language-server `ocaml-language-server` can be installed via `npm` ```sh npm install -g ocaml-langauge-server ``` ```lua require'lspconfig'.ocamlls.setup{} Commands: Default Values: cmd = { "ocaml-language-server", "--stdio" } filetypes = { "ocaml", "reason" } root_dir = root_pattern(".merlin", "package.json") ``` ## ocamllsp https://github.com/ocaml/ocaml-lsp `ocaml-lsp` can be installed as described in [installation guide](https://github.com/ocaml/ocaml-lsp#installation). To install the lsp server in a particular opam switch: ```sh opam pin add ocaml-lsp-server https://github.com/ocaml/ocaml-lsp.git opam install ocaml-lsp-server ``` ```lua require'lspconfig'.ocamllsp.setup{} Commands: Default Values: cmd = { "ocamllsp" } filetypes = { "ocaml", "reason" } root_dir = root_pattern(".merlin", "package.json") ``` ## omnisharp https://github.com/omnisharp/omnisharp-roslyn OmniSharp server based on Roslyn workspaces `omnisharp-roslyn` can be installed by downloading and extracting a release from [here](https://github.com/OmniSharp/omnisharp-roslyn/releases). Omnisharp can also be built from source by following the instructions [here](https://github.com/omnisharp/omnisharp-roslyn#downloading-omnisharp). Omnisharp requires the [dotnet-sdk](https://dotnet.microsoft.com/download) to be installed. **By default, omnisharp-roslyn doesn't have a `cmd` set.** This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set `cmd` to the absolute path ($HOME and ~ are not expanded) of the unzipped run script or binary. ```lua local pid = vim.fn.getpid() -- On linux/darwin if using a release build, otherwise under scripts/OmniSharp(.Core)(.cmd) local omnisharp_bin = "/path/to/omnisharp-repo/run" -- on Windows -- local omnisharp_bin = "/path/to/omnisharp/OmniSharp.exe" require'lspconfig'.omnisharp.setup{ cmd = { omnisharp_bin, "--languageserver" , "--hostPID", tostring(pid) }; ... } ``` Note, if you download the executable for darwin you will need to strip the quarantine label to run: ```bash find /path/to/omnisharp-osx | xargs xattr -r -d com.apple.quarantine ``` ```lua require'lspconfig'.omnisharp.setup{} Commands: Default Values: filetypes = { "cs", "vb" } init_options = {} root_dir = root_pattern(".csproj", ".sln") ``` ## perlls https://github.com/richterger/Perl-LanguageServer/tree/master/clients/vscode/perl `Perl-LanguageServer`, a language server for Perl. To use the language server, ensure that you have Perl::LanguageServer installed and perl command is on your path. This server accepts configuration via the `settings` key.
Available settings: - **`perl.debugAdapterPort`**: `string` Default: `"13603"` port to use for connection between vscode and debug adapter inside Perl\:\:LanguageServer\. On a multi user system every user must use a different port\. - **`perl.disableCache`**: `boolean` if true\, the LanguageServer will not cache the result of parsing source files on disk\, so it can be used within readonly directories - **`perl.enable`**: `boolean` Default: `true` enable\/disable this extension - **`perl.fileFilter`**: `array` Default: `vim.NIL` array for filtering perl file\, defaults to \*\.pm|\*\.pl - **`perl.ignoreDirs`**: `array` Default: `vim.NIL` directories to ignore\, defaults to \.vscode\, \.git\, \.svn - **`perl.logFile`**: `string` Default: `vim.NIL` If set\, log output is written to the given logfile\, instead of displaying it in the vscode output pane\. Log output is always appended so you are responsible for rotating the file\. - **`perl.logLevel`**: `integer` Default: `0` Log level 0\-2 - **`perl.pathMap`**: `array` Default: `vim.NIL` mapping of local to remote paths - **`perl.perlCmd`**: `string` Default: `vim.NIL` defaults to perl - **`perl.perlInc`**: `array` Default: `vim.NIL` array with paths to add to perl library path\. This setting is used by the syntax checker and for the debugee and also for the LanguageServer itself\. - **`perl.showLocalVars`**: `boolean` if true\, show also local variables in symbol view - **`perl.sshAddr`**: `string` Default: `vim.NIL` ip address of remote system - **`perl.sshArgs`**: `string` Default: `vim.NIL` optional arguments for ssh - **`perl.sshCmd`**: `string` Default: `vim.NIL` defaults to ssh on unix and plink on windows - **`perl.sshPort`**: `string` Default: `vim.NIL` optional\, port for ssh to remote system - **`perl.sshUser`**: `string` Default: `vim.NIL` user for ssh login - **`perl.sshWorkspaceRoot`**: `string` Default: `vim.NIL` path of the workspace root on remote system
```lua require'lspconfig'.perlls.setup{} Commands: Default Values: cmd = { "perl", "-MPerl::LanguageServer", "-e", "Perl::LanguageServer::run", "--", "--port 13603", "--nostdio 0", "--version 2.1.0" } filetypes = { "perl" } root_dir = vim's starting directory settings = { perl = { fileFilter = { ".pm", ".pl" }, ignoreDirs = ".git", perlCmd = "perl", perlInc = " " } } ``` ## phpactor https://github.com/phpactor/phpactor Installation: https://phpactor.readthedocs.io/en/master/usage/standalone.html#global-installation ```lua require'lspconfig'.phpactor.setup{} Commands: Default Values: cmd = { "phpactor", "language-server" } filetypes = { "php" } root_dir = root_pattern("composer.json", ".git") ``` ## powershell_es https://github.com/PowerShell/PowerShellEditorServices Language server for PowerShell. To install, download and extract PowerShellEditorServices.zip from the [releases](https://github.com/PowerShell/PowerShellEditorServices/releases). To configure the language server, set the property `bundle_path` to the root of the extracted PowerShellEditorServices.zip. The default configuration doesn't set `cmd` unless `bundle_path` is specified. ```lua require'lspconfig'.powershell_es.setup{ bundle_path = 'c:/w/PowerShellEditorServices', } ``` If necessary, specific `cmd` can be defined instead of `bundle_path`. See [PowerShellEditorServices](https://github.com/PowerShell/PowerShellEditorServices#stdio) to learn more. ```lua require'lspconfig'.powershell_es.setup{ cmd = {'pwsh', '-NoLogo', '-NoProfile', '-Command', "c:/PSES/Start-EditorServices.ps1 ..."} } ``` ```lua require'lspconfig'.powershell_es.setup{} Commands: Default Values: filetypes = { "ps1" } on_new_config = function(new_config, _) local bundle_path = new_config.bundle_path new_config.cmd = make_cmd(bundle_path) end, root_dir = git root or current directory ``` ## purescriptls https://github.com/nwolverson/purescript-language-server `purescript-language-server` can be installed via `npm` ```sh npm install -g purescript-language-server ``` This server accepts configuration via the `settings` key.
Available settings: - **`purescript.addNpmPath`**: `boolean` Whether to add the local npm bin directory to the PATH for purs IDE server and build command\. - **`purescript.addPscPackageSources`**: `boolean` Whether to add psc\-package sources to the globs passed to the IDE server for source locations \(specifically the output of \`psc\-package sources\`\, if this is a psc\-package project\)\. Update due to adding packages\/changing package set requires psc\-ide server restart\. - **`purescript.addSpagoSources`**: `boolean` Default: `true` Whether to add spago sources to the globs passed to the IDE server for source locations \(specifically the output of \`spago sources\`\, if this is a spago project\)\. Update due to adding packages\/changing package set requires psc\-ide server restart\. - **`purescript.autoStartPscIde`**: `boolean` Default: `true` Whether to automatically start\/connect to purs IDE server when editing a PureScript file \(includes connecting to an existing running instance\)\. If this is disabled\, various features like autocomplete\, tooltips\, and other type info will not work until start command is run manually\. - **`purescript.autocompleteAddImport`**: `boolean` Default: `true` Whether to automatically add imported identifiers when accepting autocomplete result\. - **`purescript.autocompleteAllModules`**: `boolean` Default: `true` Whether to always autocomplete from all built modules\, or just those imported in the file\. Suggestions from all modules always available by explicitly triggering autocomplete\. - **`purescript.autocompleteGrouped`**: `boolean` Default: `true` Whether to group completions in autocomplete results\. Requires compiler 0\.11\.6 - **`purescript.autocompleteLimit`**: `null|integer` Default: `vim.NIL` Maximum number of results to fetch for an autocompletion request\. May improve performance on large projects\. - **`purescript.buildCommand`**: `string` Default: `"spago build --purs-args --json-errors"` Build command to use with arguments\. Not passed to shell\. eg \`spago build \-\-purs\-args \-\-json\-errors\` - **`purescript.censorWarnings`**: `array` Default: `{}` Array items: `{type = "string"}` The warning codes to censor\, both for fast rebuild and a full build\. Unrelated to any psa setup\. e\.g\.\: \[\"ShadowedName\"\,\"MissingTypeDeclaration\"\] - **`purescript.codegenTargets`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` List of codegen targets to pass to the compiler for rebuild\. e\.g\. js\, corefn\. If not specified \(rather than empty array\) this will not be passed and the compiler will default to js\. Requires 0\.12\.1+ - **`purescript.editorMode`**: `boolean` \(DEPRECATED \- ignored from purs 0\.13\.8\) Whether to set the editor\-mode flag on the IDE server - **`purescript.fastRebuild`**: `boolean` Default: `true` Enable purs IDE server fast rebuild - **`purescript.importsPreferredModules`**: `array` Default: `{ "Prelude" }` Array items: `{type = "string"}` Module to prefer to insert when adding imports which have been re\-exported\. In order of preference\, most preferred first\. - **`purescript.outputDirectory`**: `string` Default: `"output/"` Override purs ide output directory \(output\/ if not specified\)\. This should match up to your build command - **`purescript.packagePath`**: `string` Default: `""` Path to installed packages\. Will be used to control globs passed to IDE server for source locations\. Change requires IDE server restart\. - **`purescript.polling`**: `boolean` \(DEPRECATED \- ignored from purs 0\.13\.8\) Whether to set the polling flag on the IDE server - **`purescript.preludeModule`**: `string` Default: `"Prelude"` Module to consider as your default prelude\, if an auto\-complete suggestion comes from this module it will be imported unqualified\. - **`purescript.pscIdePort`**: `integer|null` Default: `vim.NIL` Port to use for purs IDE server \(whether an existing server or to start a new one\)\. By default a random port is chosen \(or an existing port in \.psc\-ide\-port if present\)\, if this is specified no attempt will be made to select an alternative port on failure\. - **`purescript.pscIdelogLevel`**: `string` Default: `""` Log level for purs IDE server - **`purescript.pursExe`**: `string` Default: `"purs"` Location of purs executable \(resolved wrt PATH\) - **`purescript.sourcePath`**: `string` Default: `"src"` Path to application source root\. Will be used to control globs passed to IDE server for source locations\. Change requires IDE server restart\. - **`purescript.trace.server`**: `enum { "off", "messages", "verbose" }` Default: `"off"` Traces the communication between VSCode and the PureScript language service\.
```lua require'lspconfig'.purescriptls.setup{} Commands: Default Values: cmd = { "purescript-language-server", "--stdio" } filetypes = { "purescript" } root_dir = root_pattern("spago.dhall, bower.json") ``` ## pyls https://github.com/palantir/python-language-server `python-language-server`, a language server for Python. This server accepts configuration via the `settings` key.
Available settings: - **`pyls.configurationSources`**: `array` Default: `{ "pycodestyle" }` Array items: `{enum = { "pycodestyle", "pyflakes" },type = "string"}` List of configuration sources to use\. - **`pyls.executable`**: `string` Default: `"pyls"` Language server executable - **`pyls.plugins.jedi.env_vars`**: `dictionary` Default: `vim.NIL` Define environment variables for jedi\.Script and Jedi\.names\. - **`pyls.plugins.jedi.environment`**: `string` Default: `vim.NIL` Define environment for jedi\.Script and Jedi\.names\. - **`pyls.plugins.jedi.extra_paths`**: `array` Default: `{}` Define extra paths for jedi\.Script\. - **`pyls.plugins.jedi_completion.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.jedi_completion.fuzzy`**: `boolean` Enable fuzzy when requesting autocomplete\. - **`pyls.plugins.jedi_completion.include_class_objects`**: `boolean` Default: `true` Adds class objects as a separate completion item\. - **`pyls.plugins.jedi_completion.include_params`**: `boolean` Default: `true` Auto\-completes methods and classes with tabstops for each parameter\. - **`pyls.plugins.jedi_definition.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.jedi_definition.follow_builtin_imports`**: `boolean` Default: `true` If follow\_imports is True will decide if it follow builtin imports\. - **`pyls.plugins.jedi_definition.follow_imports`**: `boolean` Default: `true` The goto call will follow imports\. - **`pyls.plugins.jedi_hover.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.jedi_references.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.jedi_signature_help.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.jedi_symbols.all_scopes`**: `boolean` Default: `true` If True lists the names of all scopes instead of only the module namespace\. - **`pyls.plugins.jedi_symbols.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.mccabe.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.mccabe.threshold`**: `number` Default: `15` The minimum threshold that triggers warnings about cyclomatic complexity\. - **`pyls.plugins.preload.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.preload.modules`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` List of modules to import on startup - **`pyls.plugins.pycodestyle.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.pycodestyle.exclude`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` Exclude files or directories which match these patterns\. - **`pyls.plugins.pycodestyle.filename`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` When parsing directories\, only check filenames matching these patterns\. - **`pyls.plugins.pycodestyle.hangClosing`**: `boolean` Default: `vim.NIL` Hang closing bracket instead of matching indentation of opening bracket\'s line\. - **`pyls.plugins.pycodestyle.ignore`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` Ignore errors and warnings - **`pyls.plugins.pycodestyle.maxLineLength`**: `number` Default: `vim.NIL` Set maximum allowed line length\. - **`pyls.plugins.pycodestyle.select`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` Select errors and warnings - **`pyls.plugins.pydocstyle.addIgnore`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` Ignore errors and warnings in addition to the specified convention\. - **`pyls.plugins.pydocstyle.addSelect`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` Select errors and warnings in addition to the specified convention\. - **`pyls.plugins.pydocstyle.convention`**: `enum { "pep257", "numpy" }` Default: `vim.NIL` Choose the basic list of checked errors by specifying an existing convention\. - **`pyls.plugins.pydocstyle.enabled`**: `boolean` Enable or disable the plugin\. - **`pyls.plugins.pydocstyle.ignore`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` Ignore errors and warnings - **`pyls.plugins.pydocstyle.match`**: `string` Default: `"(?!test_).*\\.py"` Check only files that exactly match the given regular expression\; default is to match files that don\'t start with \'test\_\' but end with \'\.py\'\. - **`pyls.plugins.pydocstyle.matchDir`**: `string` Default: `"[^\\.].*"` Search only dirs that exactly match the given regular expression\; default is to match dirs which do not begin with a dot\. - **`pyls.plugins.pydocstyle.select`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` Select errors and warnings - **`pyls.plugins.pyflakes.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.pylint.args`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` Arguments to pass to pylint\. - **`pyls.plugins.pylint.enabled`**: `boolean` Enable or disable the plugin\. - **`pyls.plugins.pylint.executable`**: `string` Default: `vim.NIL` Executable to run pylint with\. Enabling this will run pylint on unsaved files via stdin\. Can slow down workflow\. Only works with python3\. - **`pyls.plugins.rope_completion.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.plugins.yapf.enabled`**: `boolean` Default: `true` Enable or disable the plugin\. - **`pyls.rope.extensionModules`**: `string` Default: `vim.NIL` Builtin and c\-extension modules that are allowed to be imported and inspected by rope\. - **`pyls.rope.ropeFolder`**: `array` Default: `vim.NIL` Array items: `{type = "string"}` The name of the folder in which rope stores project configurations and data\. Pass \`null\` for not using such a folder at all\.
```lua require'lspconfig'.pyls.setup{} Commands: Default Values: cmd = { "pyls" } filetypes = { "python" } root_dir = vim's starting directory ``` ## pyls_ms https://github.com/Microsoft/python-language-server `python-language-server`, a language server for Python. Requires [.NET Core](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-install-script) to run. On Linux or macOS: ```bash curl -L https://dot.net/v1/dotnet-install.sh | sh ``` `python-language-server` can be installed via [build](https://github.com/microsoft/python-language-server/blob/master/CONTRIBUTING.md#setup). Set cmd to point to `Microsoft.Python.languageServer.dll`. ```lua cmd = { "dotnet", "exec", "path/to/Microsoft.Python.languageServer.dll" }; ``` If the `python` interpreter is not in your PATH environment variable, set the `InterpreterPath` and `Version` properties accordingly. ```lua InterpreterPath = "path/to/python", Version = "3.8" ``` This server accepts configuration via the `settings` key. ```lua require'lspconfig'.pyls_ms.setup{} Commands: Default Values: filetypes = { "python" } init_options = { analysisUpdates = true, asyncStartup = true, displayOptions = {}, interpreter = { properties = { InterpreterPath = "", Version = "" } } } root_dir = vim's starting directory settings = { python = { analysis = { disabled = {}, errors = {}, info = {} } } } ``` ## pyright https://github.com/microsoft/pyright `pyright`, a static type checker and language server for python This server accepts configuration via the `settings` key.
Available settings: - **`pyright.disableLanguageServices`**: `boolean` Disables type completion\, definitions\, and references\. - **`pyright.disableOrganizeImports`**: `boolean` Disables the “Organize Imports” command\. - **`python.analysis.autoImportCompletions`**: `boolean` Default: `true` Offer auto\-import completions\. - **`python.analysis.autoSearchPaths`**: `boolean` Default: `true` Automatically add common search paths like \'src\'\? - **`python.analysis.diagnosticMode`**: `enum { "openFilesOnly", "workspace" }` Default: `"openFilesOnly"` null - **`python.analysis.diagnosticSeverityOverrides`**: `object` Default: `vim.empty_dict()` Allows a user to override the severity levels for individual diagnostics\. - **`python.analysis.extraPaths`**: `array` Default: `{}` Array items: `{type = "string"}` Additional import search resolution paths - **`python.analysis.logLevel`**: `enum { "Error", "Warning", "Information", "Trace" }` Default: `"Information"` Specifies the level of logging for the Output panel - **`python.analysis.stubPath`**: `string` Default: `"typings"` Path to directory containing custom type stub files\. - **`python.analysis.typeCheckingMode`**: `enum { "off", "basic", "strict" }` Default: `"basic"` Defines the default rule set for type checking\. - **`python.analysis.typeshedPaths`**: `array` Default: `{}` Array items: `{type = "string"}` Paths to look for typeshed modules\. - **`python.analysis.useLibraryCodeForTypes`**: `boolean` Use library implementations to extract type information when type stub is not present\. - **`python.pythonPath`**: `string` Default: `"python"` Path to Python\, you can use a custom version of Python\. - **`python.venvPath`**: `string` Default: `""` Path to folder with a list of Virtual Environments\.
```lua require'lspconfig'.pyright.setup{} Commands: - PyrightOrganizeImports: Organize Imports Default Values: cmd = { "pyright-langserver", "--stdio" } filetypes = { "python" } root_dir = function(filename) return util.root_pattern(unpack(root_files))(filename) or util.path.dirname(filename) end; settings = { python = { analysis = { autoSearchPaths = true, useLibraryCodeForTypes = true } } } ``` ## r_language_server [languageserver](https://github.com/REditorSupport/languageserver) is an implementation of the Microsoft's Language Server Protocol for the R language. It is released on CRAN and can be easily installed by ```R install.packages("languageserver") ``` This server accepts configuration via the `settings` key.
Available settings: - **`r.lsp.args`**: `array` Default: `{}` The command line arguments to use when launching R Language Server - **`r.lsp.debug`**: `boolean` Debug R Language Server - **`r.lsp.diagnostics`**: `boolean` Default: `true` Enable Diagnostics - **`r.lsp.lang`**: `string` Default: `""` Override default LANG environment variable - **`r.lsp.path`**: `string` Default: `""` Path to R binary for launching Language Server - **`r.lsp.use_stdio`**: `boolean` Use STDIO connection instead of TCP\. \(Unix\/macOS users only\) - **`r.rpath.linux`**: `string` Default: `""` Path to an R executable for Linux\. Must be \"vanilla\" R\, not radian etc\.\! - **`r.rpath.mac`**: `string` Default: `""` Path to an R executable for macOS\. Must be \"vanilla\" R\, not radian etc\.\! - **`r.rpath.windows`**: `string` Default: `""` Path to an R executable for Windows\. Must be \"vanilla\" R\, not radian etc\.\!
```lua require'lspconfig'.r_language_server.setup{} Commands: Default Values: cmd = { "R", "--slave", "-e", "languageserver::run()" } filetypes = { "r", "rmd" } log_level = 2 root_dir = root_pattern(".git") or os_homedir ``` ## racket_langserver [https://github.com/jeapostrophe/racket-langserver](https://github.com/jeapostrophe/racket-langserver) The Racket language server. This project seeks to use [DrRacket](https://github.com/racket/drracket)'s public API to provide functionality that mimics DrRacket's code tools as closely as possible. Install via `raco`: `raco pkg install racket-langserver` ```lua require'lspconfig'.racket_langserver.setup{} Commands: Default Values: cmd = { "racket", "--lib", "racket-langserver" } filetypes = { "racket", "scheme" } root_dir = function(filename) return util.root_pattern(unpack(root_files))(filename) or util.path.dirname(filename) end ``` ## rls https://github.com/rust-lang/rls rls, a language server for Rust See https://github.com/rust-lang/rls#setup to setup rls itself. See https://github.com/rust-lang/rls#configuration for rls-specific settings. All settings listed on the rls configuration section of the readme must be set under settings.rust as follows: ```lua nvim_lsp.rls.setup { settings = { rust = { unstable_features = true, build_on_save = false, all_features = true, }, }, } ``` If you want to use rls for a particular build, eg nightly, set cmd as follows: ```lua cmd = {"rustup", "run", "nightly", "rls"} ``` ```lua require'lspconfig'.rls.setup{} Commands: Default Values: cmd = { "rls" } filetypes = { "rust" } root_dir = root_pattern("Cargo.toml") ``` ## rnix https://github.com/nix-community/rnix-lsp A language server for Nix providing basic completion and formatting via nixpkgs-fmt. To install manually, run `cargo install rnix-lsp`. If you are using nix, rnix-lsp is in nixpkgs. This server accepts configuration via the `settings` key. ```lua require'lspconfig'.rnix.setup{} Commands: Default Values: cmd = { "rnix-lsp" } filetypes = { "nix" } init_options = {} root_dir = vim's starting directory settings = {} ``` ## rome https://romefrontend.dev Language server for the Rome Frontend Toolchain. ```sh npm install [-g] rome ``` ```lua require'lspconfig'.rome.setup{} Commands: Default Values: cmd = { "rome", "lsp" } filetypes = { "javascript", "javascriptreact", "json", "typescript", "typescript.tsx", "typescriptreact" } root_dir = root_pattern('package.json', 'node_modules', '.git') or dirname ``` ## rust_analyzer https://github.com/rust-analyzer/rust-analyzer rust-analyzer (aka rls 2.0), a language server for Rust See [docs](https://github.com/rust-analyzer/rust-analyzer/tree/master/docs/user#settings) for extra settings. This server accepts configuration via the `settings` key.
Available settings: - **`rust-analyzer.assist.importGroup`**: `boolean` Default: `true` null - **`rust-analyzer.assist.importMergeBehavior`**: `enum { "none", "full", "last" }` Default: `"full"` null - **`rust-analyzer.assist.importPrefix`**: `enum { "plain", "by_self", "by_crate" }` Default: `"plain"` null - **`rust-analyzer.callInfo.full`**: `boolean` Default: `true` null - **`rust-analyzer.cargo.allFeatures`**: `boolean` null - **`rust-analyzer.cargo.autoreload`**: `boolean` Default: `true` null - **`rust-analyzer.cargo.features`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`rust-analyzer.cargo.noDefaultFeatures`**: `boolean` null - **`rust-analyzer.cargo.noSysroot`**: `boolean` null - **`rust-analyzer.cargo.runBuildScripts`**: `boolean` Default: `true` null - **`rust-analyzer.cargo.target`**: `null|string` Default: `vim.NIL` null - **`rust-analyzer.cargoRunner`**: `null|string` Default: `vim.NIL` Custom cargo runner extension ID\. - **`rust-analyzer.checkOnSave.allFeatures`**: `null|boolean` Default: `vim.NIL` null - **`rust-analyzer.checkOnSave.allTargets`**: `boolean` Default: `true` null - **`rust-analyzer.checkOnSave.command`**: `string` Default: `"check"` null - **`rust-analyzer.checkOnSave.enable`**: `boolean` Default: `true` null - **`rust-analyzer.checkOnSave.extraArgs`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`rust-analyzer.checkOnSave.features`**: `null|array` Default: `vim.NIL` Array items: `{type = "string"}` null - **`rust-analyzer.checkOnSave.noDefaultFeatures`**: `null|boolean` Default: `vim.NIL` null - **`rust-analyzer.checkOnSave.overrideCommand`**: `null|array` Default: `vim.NIL` Array items: `{type = "string"}` null - **`rust-analyzer.checkOnSave.target`**: `null|string` Default: `vim.NIL` null - **`rust-analyzer.completion.addCallArgumentSnippets`**: `boolean` Default: `true` null - **`rust-analyzer.completion.addCallParenthesis`**: `boolean` Default: `true` null - **`rust-analyzer.completion.autoimport.enable`**: `boolean` Default: `true` null - **`rust-analyzer.completion.postfix.enable`**: `boolean` Default: `true` null - **`rust-analyzer.debug.engine`**: `enum { "auto", "vadimcn.vscode-lldb", "ms-vscode.cpptools" }` Default: `"auto"` Preferred debug engine\. - **`rust-analyzer.debug.engineSettings`**: `object` Default: `vim.empty_dict()` null - **`rust-analyzer.debug.openDebugPane`**: `boolean` null - **`rust-analyzer.debug.sourceFileMap`**: `object` Default: `{["/rustc/"] = "${env:USERPROFILE}/.rustup/toolchains//lib/rustlib/src/rust"}` Optional source file mappings passed to the debug engine\. - **`rust-analyzer.diagnostics.disabled`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`rust-analyzer.diagnostics.enable`**: `boolean` Default: `true` null - **`rust-analyzer.diagnostics.enableExperimental`**: `boolean` Default: `true` null - **`rust-analyzer.diagnostics.warningsAsHint`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`rust-analyzer.diagnostics.warningsAsInfo`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`rust-analyzer.files.excludeDirs`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`rust-analyzer.files.watcher`**: `string` Default: `"client"` null - **`rust-analyzer.hoverActions.debug`**: `boolean` Default: `true` null - **`rust-analyzer.hoverActions.enable`**: `boolean` Default: `true` null - **`rust-analyzer.hoverActions.gotoTypeDef`**: `boolean` Default: `true` null - **`rust-analyzer.hoverActions.implementations`**: `boolean` Default: `true` null - **`rust-analyzer.hoverActions.linksInHover`**: `boolean` Default: `true` null - **`rust-analyzer.hoverActions.run`**: `boolean` Default: `true` null - **`rust-analyzer.inlayHints.chainingHints`**: `boolean` Default: `true` null - **`rust-analyzer.inlayHints.enable`**: `boolean` Default: `true` Whether to show inlay hints\. - **`rust-analyzer.inlayHints.maxLength`**: `null|integer` Default: `25` null - **`rust-analyzer.inlayHints.parameterHints`**: `boolean` Default: `true` null - **`rust-analyzer.inlayHints.typeHints`**: `boolean` Default: `true` null - **`rust-analyzer.lens.debug`**: `boolean` Default: `true` null - **`rust-analyzer.lens.enable`**: `boolean` Default: `true` null - **`rust-analyzer.lens.implementations`**: `boolean` Default: `true` null - **`rust-analyzer.lens.methodReferences`**: `boolean` null - **`rust-analyzer.lens.references`**: `boolean` null - **`rust-analyzer.lens.run`**: `boolean` Default: `true` null - **`rust-analyzer.linkedProjects`**: `array` Default: `{}` Array items: `{type = { "string", "object" }}` null - **`rust-analyzer.lruCapacity`**: `null|integer` Default: `vim.NIL` null - **`rust-analyzer.notifications.cargoTomlNotFound`**: `boolean` Default: `true` null - **`rust-analyzer.procMacro.enable`**: `boolean` Default: `true` null - **`rust-analyzer.procMacro.server`**: `null|string` Default: `vim.NIL` null - **`rust-analyzer.runnableEnv`** Default: `vim.NIL` null - **`rust-analyzer.runnables.cargoExtraArgs`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`rust-analyzer.runnables.overrideCargo`**: `null|string` Default: `vim.NIL` null - **`rust-analyzer.rustcSource`**: `null|string` Default: `vim.NIL` null - **`rust-analyzer.rustfmt.extraArgs`**: `array` Default: `{}` Array items: `{type = "string"}` null - **`rust-analyzer.rustfmt.overrideCommand`**: `null|array` Default: `vim.NIL` Array items: `{type = "string"}` null - **`rust-analyzer.server.extraEnv`**: `null|object` Default: `vim.NIL` null - **`rust-analyzer.server.path`**: `null|string` Default: `vim.NIL` null - **`rust-analyzer.trace.extension`**: `boolean` Enable logging of VS Code extensions itself\. - **`rust-analyzer.trace.server`**: `enum { "off", "messages", "verbose" }` Default: `"off"` Trace requests to the rust\-analyzer \(this is usually overly verbose and not recommended for regular users\)\. - **`rust-analyzer.updates.askBeforeDownload`**: `boolean` Default: `true` Whether to ask for permission before downloading any files from the Internet\. - **`rust-analyzer.updates.channel`**: `enum { "stable", "nightly" }` Default: `"stable"` null
```lua require'lspconfig'.rust_analyzer.setup{} Commands: - CargoReload: Reload current cargo workspace Default Values: cmd = { "rust-analyzer" } filetypes = { "rust" } root_dir = root_pattern("Cargo.toml", "rust-project.json") settings = { ["rust-analyzer"] = {} } ``` ## scry https://github.com/crystal-lang-tools/scry Crystal language server. ```lua require'lspconfig'.scry.setup{} Commands: Default Values: cmd = { "scry" } filetypes = { "crystal" } root_dir = root_pattern('shard.yml', '.git') or dirname ``` ## solargraph https://solargraph.org/ solargraph, a language server for Ruby You can install solargraph via gem install. ```sh gem install --user-install solargraph ``` This server accepts configuration via the `settings` key.
Available settings: - **`solargraph.autoformat`**: `enum { true, false }` Enable automatic formatting while typing \(WARNING\: experimental\) - **`solargraph.bundlerPath`**: `string` Default: `"bundle"` Path to the bundle executable\, defaults to \'bundle\'\. Needs to be an absolute path for the \'bundle\' exec\/shim - **`solargraph.checkGemVersion`**: `enum { true, false }` Default: `true` Automatically check if a new version of the Solargraph gem is available\. - **`solargraph.commandPath`**: `string` Default: `"solargraph"` Path to the solargraph command\. Set this to an absolute path to select from multiple installed Ruby versions\. - **`solargraph.completion`**: `enum { true, false }` Default: `true` Enable completion - **`solargraph.definitions`**: `enum { true, false }` Default: `true` Enable definitions \(go to\, etc\.\) - **`solargraph.diagnostics`**: `enum { true, false }` Enable diagnostics - **`solargraph.externalServer`**: `object` Default: `{host = "localhost",port = 7658}` The host and port to use for external transports\. \(Ignored for stdio and socket transports\.\) - **`solargraph.folding`**: `boolean` Default: `true` Enable folding ranges - **`solargraph.formatting`**: `enum { true, false }` Enable document formatting - **`solargraph.hover`**: `enum { true, false }` Default: `true` Enable hover - **`solargraph.logLevel`**: `enum { "warn", "info", "debug" }` Default: `"warn"` Level of debug info to log\. \`warn\` is least and \`debug\` is most\. - **`solargraph.references`**: `enum { true, false }` Default: `true` Enable finding references - **`solargraph.rename`**: `enum { true, false }` Default: `true` Enable symbol renaming - **`solargraph.symbols`**: `enum { true, false }` Default: `true` Enable symbols - **`solargraph.transport`**: `enum { "socket", "stdio", "external" }` Default: `"socket"` The type of transport to use\. - **`solargraph.useBundler`**: `boolean` Use \`bundle exec\` to run solargraph\. \(If this is true\, the solargraph\.commandPath setting is ignored\.\)
```lua require'lspconfig'.solargraph.setup{} Commands: Default Values: cmd = { "solargraph", "stdio" } filetypes = { "ruby" } root_dir = root_pattern("Gemfile", ".git") settings = { solargraph = { diagnostics = true } } ``` ## sorbet https://sorbet.org Sorbet is a fast, powerful type checker designed for Ruby. You can install Sorbet via gem install. You might also be interested in how to set Sorbet up for new projects: https://sorbet.org/docs/adopting. ```sh gem install sorbet ``` ```lua require'lspconfig'.sorbet.setup{} Commands: Default Values: cmd = { "srb", "tc", "--lsp" } filetypes = { "ruby" } root_dir = root_pattern("Gemfile", ".git") ``` ## sourcekit https://github.com/apple/sourcekit-lsp Language server for Swift and C/C++/Objective-C. This server accepts configuration via the `settings` key.
Available settings: - **`sourcekit-lsp.serverArguments`**: `array` Default: `{}` Array items: `{type = "string"}` Arguments to pass to sourcekit\-lsp\. Argument keys and values should be provided as separate entries in the array e\.g\. \[\'\-\-log\-level\'\, \'debug\'\] - **`sourcekit-lsp.serverPath`**: `string` Default: `"sourcekit-lsp"` The path of the sourcekit\-lsp executable - **`sourcekit-lsp.toolchainPath`**: `string` Default: `""` \(optional\) The path of the swift toolchain\. By default\, sourcekit\-lsp uses the toolchain it is installed in\. - **`sourcekit-lsp.trace.server`**: `enum { "off", "messages", "verbose" }` Default: `"off"` Traces the communication between VS Code and the SourceKit\-LSP language server\.
```lua require'lspconfig'.sourcekit.setup{} Commands: Default Values: cmd = { "xcrun", "sourcekit-lsp" } filetypes = { "swift", "c", "cpp", "objective-c", "objective-cpp" } root_dir = root_pattern("Package.swift", ".git") ``` ## sqlls https://github.com/joe-re/sql-language-server `cmd` value is **not set** by default. The `cmd` value can be overriden in the `setup` table; ```lua require'lspconfig'.sqlls.setup{ cmd = {"path/to/command", "up", "--method", "stdio"}; ... } ``` This LSP can be installed via `npm`. Find further instructions on manual installation of the sql-language-server at [joe-re/sql-language-server](https://github.com/joe-re/sql-language-server).
```lua require'lspconfig'.sqlls.setup{} Commands: Default Values: filetypes = { "sql", "mysql" } root_dir = function(fname) return root_pattern(fname) or vim.loop.os_homedir() end; settings = {} ``` ## sqls https://github.com/lighttiger2505/sqls ```lua require'lspconfig'.sqls.setup{ cmd = {"path/to/command", "-config" "path/to/config.yml"}; ... } ``` Sqls can be installed via `go get github.com/lighttiger2505/sqls`. Instructions for compiling Sqls from the source can be found at [lighttiger2505/sqls](https://github.com/lighttiger2505/sqls). ```lua require'lspconfig'.sqls.setup{} Commands: Default Values: cmd = { "sqls" } filetypes = { "sql", "mysql" } root_dir = function(fname) return util.root_pattern("config.yml")(fname) or util.path.dirname(fname) end; settings = {} ``` ## sumneko_lua https://github.com/sumneko/lua-language-server Lua language server. `lua-language-server` can be installed by following the instructions [here](https://github.com/sumneko/lua-language-server/wiki/Build-and-Run-(Standalone)). **By default, lua-language-server doesn't have a `cmd` set.** This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set `cmd` to the absolute path ($HOME and ~ are not expanded) of your unzipped and compiled lua-language-server. ```lua local system_name if vim.fn.has("mac") == 1 then system_name = "macOS" elseif vim.fn.has("unix") == 1 then system_name = "Linux" elseif vim.fn.has('win32') == 1 then system_name = "Windows" else print("Unsupported system for sumneko") end -- set the path to the sumneko installation; if you previously installed via the now deprecated :LspInstall, use local sumneko_root_path = vim.fn.stdpath('cache')..'/lspconfig/sumneko_lua/lua-language-server' local sumneko_binary = sumneko_root_path.."/bin/"..system_name.."/lua-language-server" require'lspconfig'.sumneko_lua.setup { cmd = {sumneko_binary, "-E", sumneko_root_path .. "/main.lua"}; settings = { Lua = { runtime = { -- Tell the language server which version of Lua you're using (most likely LuaJIT in the case of Neovim) version = 'LuaJIT', -- Setup your lua path path = vim.split(package.path, ';'), }, diagnostics = { -- Get the language server to recognize the `vim` global globals = {'vim'}, }, workspace = { -- Make the server aware of Neovim runtime files library = { [vim.fn.expand('$VIMRUNTIME/lua')] = true, [vim.fn.expand('$VIMRUNTIME/lua/vim/lsp')] = true, }, }, -- Do not send telemetry data containing a randomized but unique identifier telemetry = { enable = false, }, }, }, } ``` This server accepts configuration via the `settings` key.
Available settings: - **`Lua.color.mode`**: `enum { "Grammar", "Semantic" }` Default: `"Semantic"` null - **`Lua.completion.callSnippet`**: `enum { "Disable", "Both", "Replace" }` Default: `"Disable"` null - **`Lua.completion.displayContext`**: `integer` Default: `6` null - **`Lua.completion.enable`**: `boolean` Default: `true` null - **`Lua.completion.keywordSnippet`**: `enum { "Disable", "Both", "Replace" }` Default: `"Replace"` null - **`Lua.completion.workspaceWord`**: `boolean` Default: `true` null - **`Lua.develop.debuggerPort`**: `integer` Default: `11412` null - **`Lua.develop.debuggerWait`**: `boolean` null - **`Lua.develop.enable`**: `boolean` null - **`Lua.diagnostics.disable`**: `array` Array items: `{type = "string"}` null - **`Lua.diagnostics.enable`**: `boolean` Default: `true` null - **`Lua.diagnostics.globals`**: `array` Array items: `{type = "string"}` null - **`Lua.diagnostics.neededFileStatus`**: `object` null - **`Lua.diagnostics.severity`**: `object` null - **`Lua.diagnostics.workspaceDelay`**: `integer` Default: `0` null - **`Lua.diagnostics.workspaceRate`**: `integer` Default: `100` null - **`Lua.hint.enable`**: `boolean` null - **`Lua.hint.paramName`**: `boolean` Default: `true` null - **`Lua.hint.paramType`**: `boolean` Default: `true` null - **`Lua.hint.setType`**: `boolean` null - **`Lua.hover.enable`**: `boolean` Default: `true` null - **`Lua.hover.fieldInfer`**: `integer` Default: `3000` null - **`Lua.hover.previewFields`**: `integer` Default: `100` null - **`Lua.hover.viewNumber`**: `boolean` Default: `true` null - **`Lua.hover.viewString`**: `boolean` Default: `true` null - **`Lua.hover.viewStringMax`**: `integer` Default: `1000` null - **`Lua.intelliSense.searchDepth`**: `integer` Default: `0` null - **`Lua.misc.parameters`**: `string` Default: `""` null - **`Lua.runtime.builtin`**: `object` null - **`Lua.runtime.fileEncoding`**: `enum { "utf8", "ansi" }` Default: `"utf8"` null - **`Lua.runtime.nonstandardSymbol`**: `array` Array items: `{enum = { "//", "/**/", "`", "+=", "-=", "*=", "/=", "||", "&&", "!", "!=", "continue" },type = "string"}` null - **`Lua.runtime.path`**: `array` Default: `{ "?.lua", "?/init.lua", "?/?.lua" }` Array items: `{type = "string"}` null - **`Lua.runtime.plugin`**: `string` Default: `".vscode/lua/plugin.lua"` null - **`Lua.runtime.special`**: `object` null - **`Lua.runtime.unicodeName`**: `boolean` null - **`Lua.runtime.version`**: `enum { "Lua 5.1", "Lua 5.2", "Lua 5.3", "Lua 5.4", "LuaJIT" }` Default: `"Lua 5.4"` null - **`Lua.signatureHelp.enable`**: `boolean` Default: `true` null - **`Lua.telemetry.enable`**: `boolean|null` Default: `vim.NIL` null - **`Lua.window.progressBar`**: `boolean` Default: `true` null - **`Lua.window.statusBar`**: `boolean` Default: `true` null - **`Lua.workspace.ignoreDir`**: `array` Default: `{ ".vscode" }` Array items: `{type = "string"}` null - **`Lua.workspace.ignoreSubmodules`**: `boolean` Default: `true` null - **`Lua.workspace.library`**: `array` Array items: `{type = "string"}` null - **`Lua.workspace.maxPreload`**: `integer` Default: `1000` null - **`Lua.workspace.preloadFileSize`**: `integer` Default: `100` null - **`Lua.workspace.useGitIgnore`**: `boolean` Default: `true` null
```lua require'lspconfig'.sumneko_lua.setup{} Commands: Default Values: filetypes = { "lua" } log_level = 2 root_dir = root_pattern(".git") or bufdir settings = { Lua = { telemetry = { enable = false } } } ``` ## svelte https://github.com/sveltejs/language-tools/tree/master/packages/language-server `svelte-language-server` can be installed via `npm`: ```sh npm install -g svelte-language-server ``` ```lua require'lspconfig'.svelte.setup{} Commands: Default Values: cmd = { "svelteserver", "--stdio" } filetypes = { "svelte" } root_dir = root_pattern("package.json", ".git") ``` ## terraformls https://github.com/hashicorp/terraform-ls Terraform language server Download a released binary from https://github.com/hashicorp/terraform-ls/releases. This server accepts configuration via the `settings` key.
Available settings: - **`terraform-ls.excludeRootModules`**: `array` Default: `{}` Array items: `{type = "string"}` Per\-workspace list of module directories for the language server to exclude - **`terraform-ls.experimentalFeatures`**: `object` Experimental \(opt\-in\) terraform\-ls features - **`terraform-ls.rootModules`**: `array` Default: `{}` Array items: `{type = "string"}` Per\-workspace list of module directories for the language server to read - **`terraform.languageServer`**: `object` Default: `{args = { "serve" },external = true,maxNumberOfProblems = 100,pathToBinary = "",["trace.server"] = "off"}` Language Server settings
```lua require'lspconfig'.terraformls.setup{} Commands: Default Values: cmd = { "terraform-ls", "serve" } filetypes = { "terraform", "hcl" } root_dir = root_pattern(".terraform", ".git") ``` ## texlab https://texlab.netlify.com/ A completion engine built from scratch for (La)TeX. See https://texlab.netlify.com/docs/reference/configuration for configuration options. ```lua require'lspconfig'.texlab.setup{} Commands: - TexlabBuild: Build the current buffer - TexlabForward: Forward search from current position Default Values: cmd = { "texlab" } filetypes = { "tex", "bib" } root_dir = vim's starting directory settings = { bibtex = { formatting = { lineLength = 120 } }, latex = { build = { args = { "-pdf", "-interaction=nonstopmode", "-synctex=1", "%f" }, executable = "latexmk", onSave = false }, forwardSearch = { args = {}, onSave = false }, lint = { onChange = false } } } ``` ## tflint https://github.com/terraform-linters/tflint A pluggable Terraform linter that can act as lsp server. Installation instructions can be found in https://github.com/terraform-linters/tflint#installation. ```lua require'lspconfig'.tflint.setup{} Commands: Default Values: cmd = { "tflint", "--langserver" } filetypes = { "terraform" } root_dir = root_pattern(".terraform", ".git", ".tflint.hcl") ``` ## tsserver https://github.com/theia-ide/typescript-language-server `typescript-language-server` depends on `typescript`. Both packages can be installed via `npm`: ```sh npm install -g typescript typescript-language-server ``` ```lua require'lspconfig'.tsserver.setup{} Commands: Default Values: cmd = { "typescript-language-server", "--stdio" } filetypes = { "javascript", "javascriptreact", "javascript.jsx", "typescript", "typescriptreact", "typescript.tsx" } root_dir = root_pattern("package.json", "tsconfig.json", "jsconfig.json", ".git") ``` ## vala_ls https://github.com/benwaffle/vala-language-server ```lua require'lspconfig'.vala_ls.setup{} Commands: Default Values: cmd = { "vala-language-server" } filetypes = { "vala", "genie" } root_dir = root_pattern("meson.build", ".git") ``` ## vimls https://github.com/iamcco/vim-language-server You can install vim-language-server via npm: ```sh npm install -g vim-language-server ``` ```lua require'lspconfig'.vimls.setup{} Commands: Default Values: cmd = { "vim-language-server", "--stdio" } filetypes = { "vim" } init_options = { diagnostic = { enable = true }, indexes = { count = 3, gap = 100, projectRootPatterns = { "runtime", "nvim", ".git", "autoload", "plugin" }, runtimepath = true }, iskeyword = "@,48-57,_,192-255,-#", runtimepath = "", suggest = { fromRuntimepath = true, fromVimruntime = true }, vimruntime = "" } root_dir = function(fname) return util.find_git_ancestor(fname) or vim.fn.getcwd() end, ``` ## vls https://github.com/vlang/vls V language server. `v-language-server` can be installed by following the instructions [here](https://github.com/vlang/vls#installation). **By default, v-language-server doesn't have a `cmd` set.** This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set `cmd` to the absolute path ($HOME and ~ are not expanded) of your unzipped and compiled v-language-server. ```lua -- set the path to the vls installation; local vls_root_path = vim.fn.stdpath('cache')..'/lspconfig/vls' local vls_binary = vls_root_path.."/cmd/vls/vls" require'lspconfig'.vls.setup { cmd = {vls_binary}, } ``` ```lua require'lspconfig'.vls.setup{} Commands: Default Values: filetypes = { "vlang" } root_dir = root_pattern("v.mod", ".git") ``` ## vuels https://github.com/vuejs/vetur/tree/master/server Vue language server(vls) `vue-language-server` can be installed via `npm`: ```sh npm install -g vls ``` This server accepts configuration via the `settings` key.
Available settings: - **`vetur.completion.autoImport`**: `boolean` Default: `true` Include completion for module export and auto import them - **`vetur.completion.scaffoldSnippetSources`**: `object` Default: `{user = "🗒️",vetur = "✌",workspace = "💼"}` Where Vetur source Scaffold Snippets from and how to indicate them\. Set a source to \"\" to disable it\. \- workspace\: \`\\/\.vscode\/vetur\/snippets\`\. \- user\: \`\\/User\/snippets\/vetur\`\. \- vetur\: Bundled in Vetur\. The default is\: \`\`\` \"vetur\.completion\.scaffoldSnippetSources\"\: \{ \"workspace\"\: \"💼\"\, \"user\"\: \"🗒️\"\, \"vetur\"\: \"✌\" \} \`\`\` Alternatively\, you can do\: \`\`\` \"vetur\.completion\.scaffoldSnippetSources\"\: \{ \"workspace\"\: \"\(W\)\"\, \"user\"\: \"\(U\)\"\, \"vetur\"\: \"\(V\)\" \} \`\`\` Read more\: https\:\/\/vuejs\.github\.io\/vetur\/snippet\.html\. - **`vetur.completion.tagCasing`**: `enum { "initial", "kebab" }` Default: `"kebab"` Casing conversion for tag completion - **`vetur.dev.logLevel`**: `enum { "INFO", "DEBUG" }` Default: `"INFO"` Log level for VLS - **`vetur.dev.vlsPath`**: `string` Path to vls for Vetur developers\. There are two ways of using it\. 1\. Clone vuejs\/vetur from GitHub\, build it and point it to the ABSOLUTE path of \`\/server\`\. 2\. \`yarn global add vls\` and point Vetur to the installed location \(\`yarn global dir\` + node\_modules\/vls\) - **`vetur.dev.vlsPort`**: `number` Default: `-1` The port that VLS listens to\. Can be used for attaching to the VLS Node process for debugging \/ profiling\. - **`vetur.experimental.templateInterpolationService`**: `boolean` Enable template interpolation service that offers hover \/ definition \/ references in Vue interpolations\. - **`vetur.format.defaultFormatter.css`**: `enum { "none", "prettier" }` Default: `"prettier"` Default formatter for \ region - **`vetur.format.defaultFormatter.html`**: `enum { "none", "prettyhtml", "js-beautify-html", "prettier" }` Default: `"prettier"` Default formatter for \ region - **`vetur.format.defaultFormatter.js`**: `enum { "none", "prettier", "prettier-eslint", "vscode-typescript" }` Default: `"prettier"` Default formatter for \ region - **`vetur.format.defaultFormatter.less`**: `enum { "none", "prettier" }` Default: `"prettier"` Default formatter for \