omnisharp.json

Omnisharp Configuration file

Type object
File match omnisharp.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/omnisharp-json/latest.json
Source https://www.schemastore.org/omnisharp.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

FormattingOptions object

Used to control C# formatting

52 nested properties
EnableEditorConfigSupport boolean
Default: false
NewLine string
Default: " "
UseTabs boolean
Default: false
TabSize integer
Default: 4
IndentationSize integer
Default: 4
SpacingAfterMethodDeclarationName boolean
Default: false
SpaceWithinMethodDeclarationParenthesis boolean
Default: false
SpaceBetweenEmptyMethodDeclarationParentheses boolean
Default: false
SpaceAfterMethodCallName boolean
Default: false
SpaceWithinMethodCallParentheses boolean
Default: false
SpaceBetweenEmptyMethodCallParentheses boolean
Default: false
SpaceAfterControlFlowStatementKeyword boolean
Default: true
SpaceWithinExpressionParentheses boolean
Default: false
SpaceWithinCastParentheses boolean
Default: false
SpaceWithinOtherParentheses boolean
Default: false
SpaceAfterCast boolean
Default: false
SpacesIgnoreAroundVariableDeclaration boolean
Default: false
SpaceBeforeOpenSquareBracket boolean
Default: false
SpaceBetweenEmptySquareBrackets boolean
Default: false
SpaceWithinSquareBrackets boolean
Default: false
SpaceAfterColonInBaseTypeDeclaration boolean
Default: true
SpaceAfterComma boolean
Default: true
SpaceAfterDot boolean
Default: false
SpaceAfterSemicolonsInForStatement boolean
Default: true
SpaceBeforeColonInBaseTypeDeclaration boolean
Default: true
SpaceBeforeComma boolean
Default: false
SpaceBeforeDot boolean
Default: false
SpaceBeforeSemicolonsInForStatement boolean
Default: false
SpacingAroundBinaryOperator string
Default: "single"
IndentBraces boolean
Default: false
IndentBlock boolean
Default: true
IndentSwitchSection boolean
Default: true
IndentSwitchCaseSection boolean
Default: true
IndentSwitchCaseSectionWhenBlock boolean
Default: true
LabelPositioning string
Default: "oneLess"
WrappingPreserveSingleLine boolean
Default: true
WrappingKeepStatementsOnSingleLine boolean
Default: true
NewLinesForBracesInTypes boolean
Default: true
NewLinesForBracesInMethods boolean
Default: true
NewLinesForBracesInProperties boolean
Default: true
NewLinesForBracesInAccessors boolean
Default: true
NewLinesForBracesInAnonymousMethods boolean
Default: true
NewLinesForBracesInControlBlocks boolean
Default: true
NewLinesForBracesInAnonymousTypes boolean
Default: true
NewLinesForBracesInObjectCollectionArrayInitializers boolean
Default: true
NewLinesForBracesInLambdaExpressionBody boolean
Default: true
NewLineForElse boolean
Default: true
NewLineForCatch boolean
Default: true
NewLineForFinally boolean
Default: true
NewLineForMembersInObjectInit boolean
Default: true
NewLineForMembersInAnonymousTypes boolean
Default: true
NewLineForClausesInQuery boolean
Default: true
RoslynExtensionsOptions object

Used to define refactorings, code actions and analyzer locations that OmniSharp should use (i.e. Roslynator)

4 nested properties
EnableDecompilationSupport boolean
Default: false
EnableAnalyzersSupport boolean

If set to false, only refactorings are available

Default: false
DocumentAnalysisTimeoutMs integer
Default: 10000
LocationPaths string[]
Default: null
FileOptions object

Used to define which directories and files should be included in OmniSharp's project file / solution file discovery process. Not individual .cs files.

2 nested properties
SystemExcludeSearchPatterns string[]

Recommended for manual editing

Default:
[
  "**/node_modules/**/*",
  "**/bin/**/*",
  "**/obj/**/*",
  "**/.git/**/*"
]
ExcludeSearchPatterns string[]

Can be used by tools such as VS Code to automatically share its exclusion settings with OmniSharp

Default:
[]
RenameOptions object
3 nested properties
RenameOverloads boolean
Default: false
RenameInStrings boolean
Default: false
RenameInComments boolean
Default: false
ImplementTypeOptions object
2 nested properties
InsertionBehavior string
Default: "WithOtherMembersOfTheSameKind"
Values: "WithOtherMembersOfTheSameKind" "AtTheEnd"
PropertyGenerationBehavior string
Default: "PreferThrowingProperties"
Values: "PreferThrowingProperties" "PreferAutoProperties"
Plugins object
1 nested properties
LocationPaths string[]
Default:
[]
msbuild object

Used to configure MSBuild solutions and projects

13 nested properties
enabled boolean
Default: true
ToolsVersion string

Value of ToolsVersion to use when building projects passed to this task

Default: null
Any of: enum enum, string string
VisualStudioVersion string
Default: null
Configuration enum | string

Build configuration used for project evaluation

Default: null
Platform enum | string

Specifies which version of the Common Language Runtime (CLR) use for project evaluation

Default: "AnyCPU"
EnablePackageAutoRestore boolean
Default: false
MSBuildExtensionsPath string

MSBuild extensions path. On Standalone this defaults to the MSBuild folder. In VisualStudio mode this folder will be %VSINSTALLDIR%\MSBuild

Default: null
TargetFrameworkRootPath string

Root directory where the target framework will be looked for. Uses default path if this is null

Default: null
MSBuildSDKsPath string

Path to the Sdks folder for this MSBuild instance

Default: null
RoslynTargetsPath string
Default: null
CscToolPath string

Local Roslyn path (e.g. /Current/Bin/Roslyn)

Default: null
CscToolExe string

FileName of C# compiler

Default: "csc.exe"
loadProjectsOnDemand boolean

If true, MSBuild project system will only be loading projects for files that were opened in the editor as well as referenced projects, recursively

Default: false
script object

Used to configure C# scripting (CSX files)

4 nested properties
enabled boolean
Default: true
defaultTargetFramework string
Default: "net461"
Any of: enum enum, string string
enableScriptNuGetReferences boolean
Default: false
rspFilePath string

A response file (.rsp) is used to provide the command line arguments that are used to run the roslyn script compiler process. You can use this to override the default namespace includes among other things.

Default: ""
cake object

Used to configure Cake (cake files)

2 nested properties
enabled boolean
Default: true
bakeryPath string
Default: null