aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgithub-actions[bot] <github-actions[bot]@users.noreply.github.com>2024-04-09 10:54:57 +0000
committergithub-actions[bot] <github-actions[bot]@users.noreply.github.com>2024-04-09 10:54:57 +0000
commite25c4cdecd3d58c0deccce0f372426c8c480bcce (patch)
tree5c924a587b3ed17771ac579957f0dfc7dc5f51cb
parentfeat(omnisharp)!: use standard `settings` table for configuration (#3099) (diff)
downloadnvim-lspconfig-e25c4cdecd3d58c0deccce0f372426c8c480bcce.tar
nvim-lspconfig-e25c4cdecd3d58c0deccce0f372426c8c480bcce.tar.gz
nvim-lspconfig-e25c4cdecd3d58c0deccce0f372426c8c480bcce.tar.bz2
nvim-lspconfig-e25c4cdecd3d58c0deccce0f372426c8c480bcce.tar.lz
nvim-lspconfig-e25c4cdecd3d58c0deccce0f372426c8c480bcce.tar.xz
nvim-lspconfig-e25c4cdecd3d58c0deccce0f372426c8c480bcce.tar.zst
nvim-lspconfig-e25c4cdecd3d58c0deccce0f372426c8c480bcce.zip
docs: update server_configurations.md
skip-checks: true
-rw-r--r--doc/server_configurations.md109
-rw-r--r--doc/server_configurations.txt109
2 files changed, 98 insertions, 120 deletions
diff --git a/doc/server_configurations.md b/doc/server_configurations.md
index 1a3b2106..1a2071f7 100644
--- a/doc/server_configurations.md
+++ b/doc/server_configurations.md
@@ -7647,40 +7647,44 @@ For `go_to_definition` to work fully, extended `textDocument/definition` handler
require'lspconfig'.omnisharp.setup {
cmd = { "dotnet", "/path/to/omnisharp/OmniSharp.dll" },
- -- Enables support for reading code style, naming convention and analyzer
- -- settings from .editorconfig.
- enable_editorconfig_support = true,
-
- -- If true, MSBuild project system will only load projects for files that
- -- were opened in the editor. This setting is useful for big C# codebases
- -- and allows for faster initialization of code navigation features only
- -- for projects that are relevant to code that is being edited. With this
- -- setting enabled OmniSharp may load fewer projects and may thus display
- -- incomplete reference lists for symbols.
- enable_ms_build_load_projects_on_demand = false,
-
- -- Enables support for roslyn analyzers, code fixes and rulesets.
- enable_roslyn_analyzers = false,
-
- -- Specifies whether 'using' directives should be grouped and sorted during
- -- document formatting.
- organize_imports_on_format = false,
-
- -- Enables support for showing unimported types and unimported extension
- -- methods in completion lists. When committed, the appropriate using
- -- directive will be added at the top of the current file. This option can
- -- have a negative impact on initial completion responsiveness,
- -- particularly for the first few completion sessions after opening a
- -- solution.
- enable_import_completion = false,
-
- -- Specifies whether to include preview versions of the .NET SDK when
- -- determining which version to use for project loading.
- sdk_include_prereleases = true,
-
- -- Only run analyzers against open files when 'enableRoslynAnalyzers' is
- -- true
- analyze_open_documents_only = false,
+ settings = {
+ FormattingOptions = {
+ -- Enables support for reading code style, naming convention and analyzer
+ -- settings from .editorconfig.
+ EnableEditorConfigSupport = true,
+ -- Specifies whether 'using' directives should be grouped and sorted during
+ -- document formatting.
+ OrganizeImports = nil,
+ },
+ MsBuild = {
+ -- If true, MSBuild project system will only load projects for files that
+ -- were opened in the editor. This setting is useful for big C# codebases
+ -- and allows for faster initialization of code navigation features only
+ -- for projects that are relevant to code that is being edited. With this
+ -- setting enabled OmniSharp may load fewer projects and may thus display
+ -- incomplete reference lists for symbols.
+ LoadProjectsOnDemand = nil,
+ },
+ RoslynExtensionsOptions = {
+ -- Enables support for roslyn analyzers, code fixes and rulesets.
+ EnableAnalyzersSupport = nil,
+ -- Enables support for showing unimported types and unimported extension
+ -- methods in completion lists. When committed, the appropriate using
+ -- directive will be added at the top of the current file. This option can
+ -- have a negative impact on initial completion responsiveness,
+ -- particularly for the first few completion sessions after opening a
+ -- solution.
+ EnableImportCompletion = nil,
+ -- Only run analyzers against open files when 'enableRoslynAnalyzers' is
+ -- true
+ AnalyzeOpenDocumentsOnly = nil,
+ },
+ Sdk = {
+ -- Specifies whether to include preview versions of the .NET SDK when
+ -- determining which version to use for project loading.
+ IncludePrereleases = true,
+ },
+ },
}
```
@@ -7693,26 +7697,6 @@ require'lspconfig'.omnisharp.setup{}
**Default values:**
- - `analyze_open_documents_only` :
- ```lua
- false
- ```
- - `enable_editorconfig_support` :
- ```lua
- true
- ```
- - `enable_import_completion` :
- ```lua
- false
- ```
- - `enable_ms_build_load_projects_on_demand` :
- ```lua
- false
- ```
- - `enable_roslyn_analyzers` :
- ```lua
- false
- ```
- `filetypes` :
```lua
{ "cs", "vb" }
@@ -7725,17 +7709,22 @@ require'lspconfig'.omnisharp.setup{}
```lua
see source file
```
- - `organize_imports_on_format` :
- ```lua
- false
- ```
- `root_dir` :
```lua
root_pattern("*.sln", "*.csproj", "omnisharp.json", "function.json")
```
- - `sdk_include_prereleases` :
+ - `settings` :
```lua
- true
+ {
+ FormattingOptions = {
+ EnableEditorConfigSupport = true
+ },
+ MsBuild = {},
+ RoslynExtensionsOptions = {},
+ Sdk = {
+ IncludePrereleases = true
+ }
+ }
```
diff --git a/doc/server_configurations.txt b/doc/server_configurations.txt
index 1a3b2106..1a2071f7 100644
--- a/doc/server_configurations.txt
+++ b/doc/server_configurations.txt
@@ -7647,40 +7647,44 @@ For `go_to_definition` to work fully, extended `textDocument/definition` handler
require'lspconfig'.omnisharp.setup {
cmd = { "dotnet", "/path/to/omnisharp/OmniSharp.dll" },
- -- Enables support for reading code style, naming convention and analyzer
- -- settings from .editorconfig.
- enable_editorconfig_support = true,
-
- -- If true, MSBuild project system will only load projects for files that
- -- were opened in the editor. This setting is useful for big C# codebases
- -- and allows for faster initialization of code navigation features only
- -- for projects that are relevant to code that is being edited. With this
- -- setting enabled OmniSharp may load fewer projects and may thus display
- -- incomplete reference lists for symbols.
- enable_ms_build_load_projects_on_demand = false,
-
- -- Enables support for roslyn analyzers, code fixes and rulesets.
- enable_roslyn_analyzers = false,
-
- -- Specifies whether 'using' directives should be grouped and sorted during
- -- document formatting.
- organize_imports_on_format = false,
-
- -- Enables support for showing unimported types and unimported extension
- -- methods in completion lists. When committed, the appropriate using
- -- directive will be added at the top of the current file. This option can
- -- have a negative impact on initial completion responsiveness,
- -- particularly for the first few completion sessions after opening a
- -- solution.
- enable_import_completion = false,
-
- -- Specifies whether to include preview versions of the .NET SDK when
- -- determining which version to use for project loading.
- sdk_include_prereleases = true,
-
- -- Only run analyzers against open files when 'enableRoslynAnalyzers' is
- -- true
- analyze_open_documents_only = false,
+ settings = {
+ FormattingOptions = {
+ -- Enables support for reading code style, naming convention and analyzer
+ -- settings from .editorconfig.
+ EnableEditorConfigSupport = true,
+ -- Specifies whether 'using' directives should be grouped and sorted during
+ -- document formatting.
+ OrganizeImports = nil,
+ },
+ MsBuild = {
+ -- If true, MSBuild project system will only load projects for files that
+ -- were opened in the editor. This setting is useful for big C# codebases
+ -- and allows for faster initialization of code navigation features only
+ -- for projects that are relevant to code that is being edited. With this
+ -- setting enabled OmniSharp may load fewer projects and may thus display
+ -- incomplete reference lists for symbols.
+ LoadProjectsOnDemand = nil,
+ },
+ RoslynExtensionsOptions = {
+ -- Enables support for roslyn analyzers, code fixes and rulesets.
+ EnableAnalyzersSupport = nil,
+ -- Enables support for showing unimported types and unimported extension
+ -- methods in completion lists. When committed, the appropriate using
+ -- directive will be added at the top of the current file. This option can
+ -- have a negative impact on initial completion responsiveness,
+ -- particularly for the first few completion sessions after opening a
+ -- solution.
+ EnableImportCompletion = nil,
+ -- Only run analyzers against open files when 'enableRoslynAnalyzers' is
+ -- true
+ AnalyzeOpenDocumentsOnly = nil,
+ },
+ Sdk = {
+ -- Specifies whether to include preview versions of the .NET SDK when
+ -- determining which version to use for project loading.
+ IncludePrereleases = true,
+ },
+ },
}
```
@@ -7693,26 +7697,6 @@ require'lspconfig'.omnisharp.setup{}
**Default values:**
- - `analyze_open_documents_only` :
- ```lua
- false
- ```
- - `enable_editorconfig_support` :
- ```lua
- true
- ```
- - `enable_import_completion` :
- ```lua
- false
- ```
- - `enable_ms_build_load_projects_on_demand` :
- ```lua
- false
- ```
- - `enable_roslyn_analyzers` :
- ```lua
- false
- ```
- `filetypes` :
```lua
{ "cs", "vb" }
@@ -7725,17 +7709,22 @@ require'lspconfig'.omnisharp.setup{}
```lua
see source file
```
- - `organize_imports_on_format` :
- ```lua
- false
- ```
- `root_dir` :
```lua
root_pattern("*.sln", "*.csproj", "omnisharp.json", "function.json")
```
- - `sdk_include_prereleases` :
+ - `settings` :
```lua
- true
+ {
+ FormattingOptions = {
+ EnableEditorConfigSupport = true
+ },
+ MsBuild = {},
+ RoslynExtensionsOptions = {},
+ Sdk = {
+ IncludePrereleases = true
+ }
+ }
```