aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGithub Actions <actions@github>2020-05-03 01:34:38 +0000
committerGithub Actions <actions@github>2020-05-03 01:34:38 +0000
commited77ea79028b847425693b8be7c2cb27b777661b (patch)
treed03b4c49264b2af0e6c1f206011898f8c46dfc5f
parentAdded support for the kotlin-language-server (#205) (diff)
downloadnvim-lspconfig-ed77ea79028b847425693b8be7c2cb27b777661b.tar
nvim-lspconfig-ed77ea79028b847425693b8be7c2cb27b777661b.tar.gz
nvim-lspconfig-ed77ea79028b847425693b8be7c2cb27b777661b.tar.bz2
nvim-lspconfig-ed77ea79028b847425693b8be7c2cb27b777661b.tar.lz
nvim-lspconfig-ed77ea79028b847425693b8be7c2cb27b777661b.tar.xz
nvim-lspconfig-ed77ea79028b847425693b8be7c2cb27b777661b.tar.zst
nvim-lspconfig-ed77ea79028b847425693b8be7c2cb27b777661b.zip
[docgen] Update README.md
skip-checks: true
-rw-r--r--README.md302
1 files changed, 201 insertions, 101 deletions
diff --git a/README.md b/README.md
index c6795571..e8167bcd 100644
--- a/README.md
+++ b/README.md
@@ -896,7 +896,7 @@ This server accepts configuration via the `settings` key.
Default: `true`
- Whether to enable analysis for AngularDart templates (requires the angular_analyzer_plugin).
+ Whether to enable analysis for AngularDart templates (requires the Angular analyzer plugin to be enabled in analysis_options.yaml).
- **`dart.analyzerAdditionalArgs`**: `array`
@@ -1031,6 +1031,12 @@ This server accepts configuration via the `settings` key.
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 15 or fewer values for performance reasons.
+
- **`dart.extensionLogFile`**: `null|string`
Default: `vim.NIL`
@@ -1075,6 +1081,14 @@ This server accepts configuration via the `settings` key.
The organization responsible for your new Flutter project, in reverse domain name notation. This string is used in Java package names and as prefix in the iOS bundle identifier when creating new projects using the 'Flutter: New Project' command.
+- **`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`
@@ -1199,6 +1213,10 @@ This server accepts configuration via the `settings` key.
When to automatically switch focus to the test list (array to support multiple values).
+- **`dart.previewBazelWorkspaceCustomScripts`**: `boolean`
+
+ EXPERIMENTAL: Whether to look for custom script definitions at dart/config/intellij-plugins/flutter.json in Bazel workspaces. Currently supported for macOS and Linux only.
+
- **`dart.previewBuildRunnerTasks`**: `boolean`
Whether to register Pub Build Runner tasks with VS Code.
@@ -1217,7 +1235,7 @@ This server accepts configuration via the `settings` key.
- **`dart.previewLsp`**: `boolean`
- Whether to run the analyzer in LSP mode (experimental, requires restart).
+ EXPERIMENTAL: Whether to run the analyzer in LSP mode (requires restart).
- **`dart.previewNewCompletionPlaceholders`**: `boolean`
@@ -1225,10 +1243,6 @@ This server accepts configuration via the `settings` key.
Whether to enable new behaviour for code completion to include @required arguments as placeholders (when using dart.insertArgumentPlaceholders).
-- **`dart.previewToStringInDebugViews`**: `boolean`
-
- 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 15 or fewer values for performance reasons.
-
- **`dart.promptToGetPackages`**: `boolean`
Default: `true`
@@ -1291,6 +1305,12 @@ This server accepts configuration via the `settings` key.
Whether to show quick fixes for ignoring hints and lints.
+- **`dart.showMainCodeLens`**: `boolean`
+
+ Default: `true`
+
+ Whether to show CodeLens actions in the editor for quick running/debugging scripts with main methods.
+
- **`dart.showTestCodeLens`**: `boolean`
Default: `true`
@@ -1897,6 +1917,12 @@ require'nvim_lsp'.html.setup{}
contextSupport = false,
dynamicRegistration = false
},
+ declaration = {
+ linkSupport = true
+ },
+ definition = {
+ linkSupport = true
+ },
documentHighlight = {
dynamicRegistration = false
},
@@ -1911,6 +1937,9 @@ require'nvim_lsp'.html.setup{}
contentFormat = { "markdown", "plaintext" },
dynamicRegistration = false
},
+ implementation = {
+ linkSupport = true
+ },
references = {
dynamicRegistration = false
},
@@ -1925,6 +1954,16 @@ require'nvim_lsp'.html.setup{}
dynamicRegistration = false,
willSave = false,
willSaveWaitUntil = false
+ },
+ typeDefinition = {
+ linkSupport = true
+ },
+ workspaceSymbol = {
+ dynamicRegistration = false,
+ hierarchicalWorkspaceSymbolSupport = true,
+ symbolKind = {
+ valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 }
+ }
}
}
}
@@ -2032,6 +2071,12 @@ require'nvim_lsp'.jsonls.setup{}
contextSupport = false,
dynamicRegistration = false
},
+ declaration = {
+ linkSupport = true
+ },
+ definition = {
+ linkSupport = true
+ },
documentHighlight = {
dynamicRegistration = false
},
@@ -2046,6 +2091,9 @@ require'nvim_lsp'.jsonls.setup{}
contentFormat = { "markdown", "plaintext" },
dynamicRegistration = false
},
+ implementation = {
+ linkSupport = true
+ },
references = {
dynamicRegistration = false
},
@@ -2060,6 +2108,16 @@ require'nvim_lsp'.jsonls.setup{}
dynamicRegistration = false,
willSave = false,
willSaveWaitUntil = false
+ },
+ typeDefinition = {
+ linkSupport = true
+ },
+ workspaceSymbol = {
+ dynamicRegistration = false,
+ hierarchicalWorkspaceSymbolSupport = true,
+ symbolKind = {
+ valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 }
+ }
}
}
}
@@ -2266,132 +2324,109 @@ require'nvim_lsp'.julials.setup{}
## kotlin_language_server
-https://github.com/fwcd/kotlin-language-server
-
-Kotlin Language Server.
-Requirements:
- * java 8+ on path
- * (optional) kotlinc on path for gradle-less projects
- * `kotlin`-filetype support for vim.
-
-Simply follow the build instructions from the source, summarized:
-
-```bash
-git clone && cd
-./gradlew :server:installDist
-```
-
-Gradle will download itself and all dependencies.
-Output to start the server is a script (unix or \*.bat), located at:
-`/path/to/git/of/kotlin-language-server/server/build/install/server/bin/`
-
-This will result in one executable script (unix) and one \*.bat which are used in the configuration below.
+ 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.
<details><summary>Available settings:</summary>
-- **`kotlin.languageServer.enabled`**: `boolean`
-
- default: `true`
-
- description: `[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: `""`
-
- description: `Optionally a custom path to the language server executable.`
-
-- **`kotlin.languageServer.transport`**: `string`
-
- default: `stdio`
-
- enum: [`stdio`, `tcp`],
- description: `The transport layer beneath the language server protocol. Note that the extension will launch the server even if a TCP socket is used.`,
-
-- **`kotlin.languageServer.port`**: `integer`
-
- default: ``
-
- description: `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.trace.server`**: `string`
-
- default: `"off"`
-
- enum: [
- `off`,
- `messages`,
- `verbose`
- ],
- description: `Traces the communication between VSCode and the Kotlin language server.`,
- scope: `window`
-
- **`kotlin.compiler.jvm.target`**: `string`
-
- default: `"default"`
- description: `Specifies the JVM target, e.g. \`1.6\` or \`1.8\``
+ Default: `"default"`
+
+ Specifies the JVM target, e.g. "1.6" or "1.8"
-- **`kotlin.linting.debounceTime`**: `integer`
+- **`kotlin.completion.snippets.enabled`**: `boolean`
- default: `250`
+ Default: `true`
+
+ Specifies whether code completion should provide snippets (true) or plain-text items (false).
- description: `[DEBUG] Specifies the debounce time limit. Lower to increase responsiveness at the cost of possibile stability issues.`
+- **`kotlin.debounceTime`**: `integer`
-- **`kotlin.completion.snippets.enabled`**: `boolean`
+ Default: `250`
+
+ [DEPRECATED] Specifies the debounce time limit. Lower to increase responsiveness at the cost of possibile stability issues.
- default: `true`
+- **`kotlin.debugAdapter.enabled`**: `boolean`
- description: `Specifies whether code completion should provide snippets (true) or plain-text items (false).`
+ Default: `true`
+
+ [Recommended] Specifies whether the debug adapter should be used. When enabled a debugger for Kotlin will be available.
-- **`kotlin.debugAdapter.enabled`**: `boolean`
+- **`kotlin.debugAdapter.path`**: `string`
- default: `true`
+ Default: `""`
+
+ Optionally a custom path to the debug adapter executable.
- description: `[Recommended] Specifies whether the debug adapter should be used. When enabled a debugger for Kotlin will be available.`
+- **`kotlin.externalSources.autoConvertToKotlin`**: `boolean`
-- **`kotlin.debugAdapter.path`**: `string`
+ Default: `true`
+
+ Specifies whether decompiled/external classes should be auto-converted to Kotlin.
- default: `""`
+- **`kotlin.externalSources.useKlsScheme`**: `boolean`
- description: `Optionally a custom path to the debug adapter executable.`
+ Default: `true`
+
+ [Recommended] Specifies whether URIs inside JARs should be represented using the 'kls'-scheme.
-- **`kotlin.debounceTime`**: `integer`
+- **`kotlin.languageServer.enabled`**: `boolean`
- default: `250`
+ 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.
- description: `[DEPRECATED] Specifies the debounce time limit. Lower to increase responsiveness at the cost of possibile stability issues.`,
- deprecationMessage: `Use 'kotlin.linting.debounceTime' instead`
+- **`kotlin.languageServer.path`**: `string`
-- **`kotlin.externalSources.useKlsScheme`**: `boolean`
+ Default: `""`
+
+ Optionally a custom path to the language server executable.
- default: `true`
+- **`kotlin.languageServer.port`**: `integer`
- description: `[Recommended] Specifies whether URIs inside JARs should be represented using the 'kls'-scheme.`
+ 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.externalSources.autoConvertToKotlin`**: `boolean`
+- **`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.
- default: `true`
+- **`kotlin.linting.debounceTime`**: `integer`
- description: `Specifies whether decompiled/external classes should be auto-converted to Kotlin.`
+ Default: `250`
+
+ [DEBUG] Specifies the debounce time limit. Lower to increase responsiveness at the cost of possibile stability issues.
- **`kotlin.snippetsEnabled`**: `boolean`
- default: `true`
+ Default: `true`
+
+ [DEPRECATED] Specifies whether code completion should provide snippets (true) or plain-text items (false).
- description: `[DEPRECATED] Specifies whether code completion should provide snippets (true) or plain-text items (false).`,
- deprecationMessage: `Use 'kotlin.completion.snippets.enabled'`
+- **`kotlin.trace.server`**: `enum { "off", "messages", "verbose" }`
-</details>
+ Default: `"off"`
+
+ Traces the communication between VSCode and the Kotlin language server.
-configuration:
+</details>
```lua
-require 'nvim_lsp'.kotlin_language_server.setup {
- -- Default Values:
- cmd = { "/path/to/git/of/kotlin-language-server/" .. "server/build/install/server/bin/kotlin-language-server" }; -- startup script
-};
+require'nvim_lsp'.kotlin_language_server.setup{}
+ Default Values:
+ filetypes = { "kotlin" }
+ root_dir = root_pattern("settings.gradle")
```
## leanls
@@ -2957,6 +2992,12 @@ require'nvim_lsp'.purescriptls.setup{}
contextSupport = false,
dynamicRegistration = false
},
+ declaration = {
+ linkSupport = true
+ },
+ definition = {
+ linkSupport = true
+ },
documentHighlight = {
dynamicRegistration = false
},
@@ -2971,6 +3012,9 @@ require'nvim_lsp'.purescriptls.setup{}
contentFormat = { "markdown", "plaintext" },
dynamicRegistration = false
},
+ implementation = {
+ linkSupport = true
+ },
references = {
dynamicRegistration = false
},
@@ -2985,6 +3029,16 @@ require'nvim_lsp'.purescriptls.setup{}
dynamicRegistration = false,
willSave = false,
willSaveWaitUntil = false
+ },
+ typeDefinition = {
+ linkSupport = true
+ },
+ workspaceSymbol = {
+ dynamicRegistration = false,
+ hierarchicalWorkspaceSymbolSupport = true,
+ symbolKind = {
+ valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 }
+ }
}
}
}
@@ -3627,6 +3681,18 @@ This server accepts configuration via the `settings` key.
Default: `true`
+- **`rust-analyzer.debug.engine`**: `enum { "auto", "vadimcn.vscode-lldb", "ms-vscode.cpptools" }`
+
+ Default: `"auto"`
+
+ Preffered debug engine.
+
+- **`rust-analyzer.debug.sourceFileMap`**: `object`
+
+ Default: `{["/rustc/<id>"] = "${env:USERPROFILE}/.rustup/toolchains/<toolchain-id>/lib/rustlib/src/rust"}`
+
+ Optional source file mappings passed to the debug engine.
+
- **`rust-analyzer.diagnostics.enable`**: `boolean`
Default: `true`
@@ -3679,10 +3745,6 @@ This server accepts configuration via the `settings` key.
Default: `true`
-- **`rust-analyzer.notifications.workspaceLoaded`**: `boolean`
-
- Default: `true`
-
- **`rust-analyzer.procMacro.enable`**: `boolean`
Enable Proc macro support, cargo.loadOutDirsFromCheck must be enabled.
@@ -3750,6 +3812,12 @@ require'nvim_lsp'.rust_analyzer.setup{}
contextSupport = false,
dynamicRegistration = false
},
+ declaration = {
+ linkSupport = true
+ },
+ definition = {
+ linkSupport = true
+ },
documentHighlight = {
dynamicRegistration = false
},
@@ -3764,6 +3832,9 @@ require'nvim_lsp'.rust_analyzer.setup{}
contentFormat = { "markdown", "plaintext" },
dynamicRegistration = false
},
+ implementation = {
+ linkSupport = true
+ },
references = {
dynamicRegistration = false
},
@@ -3778,6 +3849,16 @@ require'nvim_lsp'.rust_analyzer.setup{}
dynamicRegistration = false,
willSave = false,
willSaveWaitUntil = false
+ },
+ typeDefinition = {
+ linkSupport = true
+ },
+ workspaceSymbol = {
+ dynamicRegistration = false,
+ hierarchicalWorkspaceSymbolSupport = true,
+ symbolKind = {
+ valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 }
+ }
}
}
}
@@ -4595,6 +4676,12 @@ require'nvim_lsp'.yamlls.setup{}
contextSupport = false,
dynamicRegistration = false
},
+ declaration = {
+ linkSupport = true
+ },
+ definition = {
+ linkSupport = true
+ },
documentHighlight = {
dynamicRegistration = false
},
@@ -4609,6 +4696,9 @@ require'nvim_lsp'.yamlls.setup{}
contentFormat = { "markdown", "plaintext" },
dynamicRegistration = false
},
+ implementation = {
+ linkSupport = true
+ },
references = {
dynamicRegistration = false
},
@@ -4623,6 +4713,16 @@ require'nvim_lsp'.yamlls.setup{}
dynamicRegistration = false,
willSave = false,
willSaveWaitUntil = false
+ },
+ typeDefinition = {
+ linkSupport = true
+ },
+ workspaceSymbol = {
+ dynamicRegistration = false,
+ hierarchicalWorkspaceSymbolSupport = true,
+ symbolKind = {
+ valueSet = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 }
+ }
}
}
}