Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files
xet
 Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
unist.json
value
The value field can contain any value.
{}
tmlanguage.json
scopeName
this should be a unique name for the grammar, following the convention of being a dot-separated name where each new (left-most) part specializes the name. Normally it would be a two-part name where the first is either text or source and the second is the name of the language or document type. But if you are specializing an existing type, you probably want to derive the name from the type you are specializing. For example Markdown is text.html.markdown and Ruby on Rails (rhtml files) is text.html.rails. The advantage of deriving it from (in this case) text.html is that everything which works in the text.html scope will also work in the text.html.«something» scope (but with a lower precedence than something specifically targeting text.html.«something»).
{"type": "string", "pattern": "^(text|source)(\\.[\\w0-9-]+)+$"}
tmlanguage.json
foldingStartMarker
regular expressions that lines (in the document) are matched against. If a line matches one of the patterns (but not both), it becomes a folding marker (see the foldings section for more info).
{"type": "string"}
tmlanguage.json
foldingStopMarker
regular expressions that lines (in the document) are matched against. If a line matches one of the patterns (but not both), it becomes a folding marker (see the foldings section for more info).
{"type": "string"}
tmlanguage.json
fileTypes
this is an array of file type extensions that the grammar should (by default) be used with. This is referenced when TextMate does not know what grammar to use for a file the user opens. If however the user selects a grammar from the language pop-up in the status bar, TextMate will remember that choice.
{"type": "array", "items": {"type": "string"}}
tmlanguage.json
repository
a dictionary (i.e. key/value pairs) of rules which can be included from other places in the grammar. The key is the name of the rule and the value is the actual rule. Further explanation (and example) follow with the description of the include rule key.
{"type": "object", "additionalProperties": {}}
tmlanguage.json
disabled
set this property to 1 to disable the current pattern
{"type": "integer", "minimum": 0, "maximum": 1}
tmlanguage.json
include
this allows you to reference a different language, recursively reference the grammar itself or a rule declared in this file's repository.
{"type": "string"}
tmlanguage.json
match
a regular expression which is used to identify the portion of text to which the name should be assigned. Example: '\b(true|false)\b'.
{"type": "string"}
tmlanguage.json
name
the name which gets assigned to the portion matched. This is used for styling and scope-specific settings and actions, which means it should generally be derived from one of the standard names.
{}
tmlanguage.json
contentName
this key is similar to the name key but only assigns the name to the text between what is matched by the begin/end patterns.
{}
tmlanguage.json
begin
these keys allow matches which span several lines and must both be mutually exclusive with the match key. Each is a regular expression pattern. begin is the pattern that starts the block and end is the pattern which ends the block. Captures from the begin pattern can be referenced in the end pattern by using normal regular expression back-references. This is often used with here-docs. A begin/end rule can have nested patterns using the patterns key.
{"type": "string"}
tmlanguage.json
end
these keys allow matches which span several lines and must both be mutually exclusive with the match key. Each is a regular expression pattern. begin is the pattern that starts the block and end is the pattern which ends the block. Captures from the begin pattern can be referenced in the end pattern by using normal regular expression back-references. This is often used with here-docs. A begin/end rule can have nested patterns using the patterns key.
{"type": "string"}
tmlanguage.json
while
these keys allow matches which span several lines and must both be mutually exclusive with the match key. Each is a regular expression pattern. begin is the pattern that starts the block and while continues it.
{"type": "string"}
tmlanguage.json
captures
allows you to assign attributes to the captures of the match pattern. Using the captures key for a begin/end rule is short-hand for giving both beginCaptures and endCaptures with same values.
{}
tmlanguage.json
beginCaptures
allows you to assign attributes to the captures of the begin pattern. Using the captures key for a begin/end rule is short-hand for giving both beginCaptures and endCaptures with same values.
{}
tmlanguage.json
endCaptures
allows you to assign attributes to the captures of the end pattern. Using the captures key for a begin/end rule is short-hand for giving both beginCaptures and endCaptures with same values.
{}
tmlanguage.json
whileCaptures
allows you to assign attributes to the captures of the while pattern. Using the captures key for a begin/while rule is short-hand for giving both beginCaptures and whileCaptures with same values.
{}
tmlanguage.json
patterns
applies to the region between the begin and end matches
{"type": "array", "items": {}, "default": []}
arc-schema.json
app
Application namespace
{"type": ["string", "array"], "maxItems": 1, "items": {}}
arc-schema.json
aws
AWS specific configuration
{"type": ["array", "object"], "maxItems": 12, "uniqueItems": true, "items": {"type": ["array", "object"], "maxItems": 2, "items": [{"type": "string", "enum": ["apigateway", "bucket", "concurrency", "layer", "layers", "memory", "policy", "policies", "profile", "region", "runtime", "timeout"]}, {"type": ["string", "number"]}]}, "properties": {"apigateway": {"type": "string"}, "bucket": {"type": "string"}, "concurrency": {"type": "number"}, "layer": {"type": ["string", "object", "array"]}, "layers": {"type": ["string", "object", "array"]}, "memory": {"type": "number"}, "policy": {"type": ["string", "object", "array"]}, "policies": {"type": ["string", "object", "array"]}, "profile": {"type": "string"}, "region": {"type": "string"}, "runtime": {"type": "string"}, "timeout": {"type": "number"}}}
arc-schema.json
static
Static asset & S3 configuration
{"uniqueItems": true, "type": "array", "maxItems": 6, "items": {"type": ["array", "object"], "items": [{"type": "string", "enum": ["fingerprint", "folder", "ignore", "prefix", "production", "prune", "spa", "staging"]}, {"type": ["string", "boolean", "array", "object"]}], "properties": {"fingerprint": {"type": ["boolean", "string"]}, "folder": {"type": "string"}, "ignore": {"type": ["string", "object", "array"]}, "prefix": {"type": "string"}, "production": {"type": "string"}, "prune": {"type": "boolean"}, "spa": {"type": "boolean"}, "staging": {"type": "string"}}}}
arc-schema.json
ws
API Gateway WebSocket configuration
{"type": "array", "uniqueItems": true, "items": {}}
arc-schema.json
http
API Gateway configuration
{"type": "array", "uniqueItems": true, "items": {"type": ["array", "object"], "maxItems": 2, "maxProperties": 1, "properties": {"any": {"type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}, "get": {"type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}, "post": {"type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}, "put": {"type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}, "patch": {"type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}, "delete": {"type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}, "head": {"type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}, "options": {"type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}}, "items": [{"type": "string", "enum": ["any", "get", "post", "put", "patch", "delete", "head", "options"]}, {"type": "string", "pattern": "^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}]}}
arc-schema.json
proxy
Proxy
{"type": "array", "uniqueItems": true, "items": {"type": ["array", "object"], "maxItems": 3, "maxProperties": 1, "properties": {"testing": {"type": "string", "pattern": "^https?:\\/\\/.+$"}, "staging": {"type": "string", "pattern": "^https?:\\/\\/.+$"}, "production": {"type": "string", "pattern": "^https?:\\/\\/.+$"}}, "items": [{"type": "string", "enum": ["testing", "staging", "production"]}, {"type": "string", "pattern": "^https?:\\/\\/.+$"}]}}
arc-schema.json
events
Events configuration
{"type": "array", "uniqueItems": true, "items": {}}
arc-schema.json
queues
Queues configuration
{"type": "array", "uniqueItems": true, "items": {}}
arc-schema.json
macros
Deployment macros configuration
{"type": "array", "uniqueItems": true, "items": {}}
arc-schema.json
scheduled
Scheduled event configuration
{"type": ["array", "object"], "uniqueItems": true, "items": {"type": ["array", "object"], "items": [{"type": "string", "pattern": "^[a-z][a-z|\\-|0-9]+$"}, {"type": "string", "pattern": "^(rate|cron)"}]}}
arc-schema.json
tables
DynamoDB database tables configuration
{"type": "array", "uniqueItems": true, "items": {}}
arc-schema.json
indexes
DynamoDB global secondary indexes configuration
{"type": "array", "uniqueItems": true, "items": {}}
pyrightconfig.schema.json
Pyright Configuration Schema
{"$schema": "http://json-schema.org/draft-07/schema#", "allowComments": true, "allowTrailingCommas": true, "type": "object", "definitions": {"diagnostic": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["none", "information", "warning", "error"]}]}}, "properties": {"include": {"type": "array", "items": {"type": "string", "pattern": "^(.*)$"}}, "exclude": {"type": "array", "items": {"type": "string", "pattern": "^(.*)$"}}, "ignore": {"type": "array", "items": {"type": "string", "pattern": "^(.*)$"}}, "strict": {"type": "array", "items": {"type": "string", "pattern": "^(.*)$"}}, "defineConstant": {"type": "object", "properties": {}, "additionalProperties": {"type": ["string", "boolean"]}}, "typeCheckingMode": {"type": "string", "enum": ["off", "basic", "strict"], "default": "basic"}, "useLibraryCodeForTypes": {"type": "boolean", "default": true}, "typeshedPath": {"type": "string", "default": "", "pattern": "^(.*)$"}, "stubPath": {"type": "string", "default": "", "examples": ["src/typestubs"], "pattern": "^(.*)$"}, "strictListInference": {"type": "boolean", "default": false}, "strictSetInference": {"type": "boolean", "default": false}, "strictDictionaryInference": {"type": "boolean", "default": false}, "analyzeUnannotatedFunctions": {"type": "boolean", "default": true}, "strictParameterNoneValue": {"type": "boolean", "default": true}, "enableExperimentalFeatures": {"type": "boolean", "default": true}, "enableTypeIgnoreComments": {"type": "boolean", "default": true}, "reportGeneralTypeIssues": {"default": "error"}, "reportPropertyTypeMismatch": {"default": "none"}, "reportFunctionMemberAccess": {"default": "none"}, "reportMissingImports": {"default": "error"}, "reportMissingModuleSource": {"default": "warning"}, "reportMissingTypeStubs": {"default": "none"}, "reportImportCycles": {"default": "none"}, "reportUnusedImport": {"default": "none"}, "reportUnusedClass": {"default": "none"}, "reportUnusedFunction": {"default": "none"}, "reportUnusedVariable": {"default": "none"}, "reportDuplicateImport": {"default": "none"}, "reportWildcardImportFromLibrary": {"default": "none"}, "reportOptionalSubscript": {"default": "error"}, "reportOptionalMemberAccess": {"default": "error"}, "reportOptionalCall": {"default": "error"}, "reportOptionalIterable": {"default": "error"}, "reportOptionalContextManager": {"default": "error"}, "reportOptionalOperand": {"default": "error"}, "reportTypedDictNotRequiredAccess": {"default": "error"}, "reportUntypedFunctionDecorator": {"default": "none"}, "reportUntypedClassDecorator": {"default": "none"}, "reportUntypedBaseClass": {"default": "none"}, "reportUntypedNamedTuple": {"default": "none"}, "reportPrivateUsage": {"default": "none"}, "reportTypeCommentUsage": {"default": "none"}, "reportPrivateImportUsage": {"default": "error"}, "reportConstantRedefinition": {"default": "none"}, "reportDeprecated": {"default": "none"}, "reportIncompatibleMethodOverride": {"default": "none"}, "reportIncompatibleVariableOverride": {"default": "none"}, "reportInconsistentConstructor": {"default": "none"}, "reportOverlappingOverload": {"default": "none"}, "reportMissingSuperCall": {"default": "none"}, "reportUninitializedInstanceVariable": {"default": "none"}, "reportInvalidStringEscapeSequence": {"default": "warning"}, "reportUnknownParameterType": {"default": "none"}, "reportUnknownArgumentType": {"default": "none"}, "reportUnknownLambdaType": {"default": "none"}, "reportUnknownVariableType": {"default": "none"}, "reportUnknownMemberType": {"default": "none"}, "reportMissingParameterType": {"default": "none"}, "reportMissingTypeArgument": {"default": "none"}, "reportInvalidTypeVarUse": {"default": "warning"}, "reportCallInDefaultInitializer": {"default": "none"}, "reportUnnecessaryIsInstance": {"default": "none"}, "reportUnnecessaryCast": {"default": "none"}, "reportUnnecessaryComparison": {"default": "none"}, "reportUnnecessaryContains": {"default": "none"}, "reportAssertAlwaysTrue": {"default": "warning"}, "reportSelfClsParameterName": {"default": "warning"}, "reportImplicitStringConcatenation": {"default": "warning"}, "reportUnboundVariable": {"default": "error"}, "reportUndefinedVariable": {"default": "error"}, "reportInvalidStubStatement": {"default": "none"}, "reportIncompleteStub": {"default": "none"}, "reportUnsupportedDunderAll": {"default": "warning"}, "reportUnusedCallResult": {"default": "none"}, "reportUnusedCoroutine": {"default": "error"}, "reportUnusedExpression": {"default": "warning"}, "reportUnnecessaryTypeIgnoreComment": {"default": "none"}, "reportMatchNotExhaustive": {"default": "none"}, "reportShadowedImports": {"default": "none"}, "reportImplicitOverride": {"default": "none"}, "extraPaths": {"type": "array", "items": {"type": "string", "default": "", "pattern": "^(.*)$"}}, "pythonVersion": {"type": "string", "default": "", "examples": ["3.7"], "pattern": "^3\\.[0-9]+$"}, "pythonPlatform": {"type": "string", "default": "", "examples": ["Linux"], "pattern": "^(Linux|Windows|Darwin|All)$"}, "venvPath": {"type": "string", "default": "", "pattern": "^(.*)$"}, "venv": {"type": "string", "default": "", "examples": ["python37"], "pattern": "^(.*)$"}, "verboseOutput": {"type": "boolean", "default": false}, "executionEnvironments": {"type": "array", "items": {"type": "object", "required": ["root"], "properties": {"root": {"type": "string", "default": "", "pattern": "^(.*)$"}, "extraPaths": {"type": "array", "items": {"type": "string", "default": "", "pattern": "^(.*)$"}}, "pythonVersion": {"type": "string", "default": "", "examples": ["3.7"], "pattern": "^3\\.[0-9]+$"}, "pythonPlatform": {"type": "string", "default": "", "examples": ["Linux"], "pattern": "^(Linux|Windows|Darwin|All)$"}}}}}}
lintstagedrc.schema.json
lintersMap
keys (String) are glob patterns, values (Array<String> | String) are commands to execute.
{"type": "object", "additionalProperties": {}}
lintstagedrc.schema.json
globOptions
micromatch options to customize how glob patterns match files.
{"type": "object", "properties": {"matchBase": {"type": "boolean", "default": true}, "dot": {"type": "boolean", "default": true}}, "additionalProperties": false}
lintstagedrc.schema.json
concurrent
Controls if linters are run simultaneously for each glob pattern.
{"type": "boolean", "default": true}
lintstagedrc.schema.json
chunkSize
Max allowed chunk size based on number of files for glob pattern. This option is only applicable on Windows based systems to avoid command length limitations
{"type": "number", "minimum": 1}
lintstagedrc.schema.json
globOptions
micromatch options to customize how glob patterns match files.
{}
lintstagedrc.schema.json
linters
keys (String) are glob patterns, values (Array<String> | String) are commands to execute.
{}
lintstagedrc.schema.json
ignore
array of glob patterns to entirely ignore from any task.
{"type": "array", "items": {"type": "string"}, "default": "['**/docs/**/*.js']"}
lintstagedrc.schema.json
subTaskConcurrency
Controls concurrency for processing chunks generated for each linter. This option is only applicable on Windows. Execution is not concurrent by default.
{"type": "integer", "minimum": 1, "default": 1}
lintstagedrc.schema.json
relative
If true it will give the relative path from your package.json directory to your linter arguments.
{"type": "boolean", "default": false}
omnisharp.json
FormattingOptions
Used to control C# formatting
{"type": "object", "properties": {"EnableEditorConfigSupport": {"type": "boolean", "default": false}, "NewLine": {"type": "string", "default": "\n"}, "UseTabs": {"type": "boolean", "default": false}, "TabSize": {"type": "integer", "default": 4}, "IndentationSize": {"type": "integer", "default": 4}, "SpacingAfterMethodDeclarationName": {"type": "boolean", "default": false}, "SpaceWithinMethodDeclarationParenthesis": {"type": "boolean", "default": false}, "SpaceBetweenEmptyMethodDeclarationParentheses": {"type": "boolean", "default": false}, "SpaceAfterMethodCallName": {"type": "boolean", "default": false}, "SpaceWithinMethodCallParentheses": {"type": "boolean", "default": false}, "SpaceBetweenEmptyMethodCallParentheses": {"type": "boolean", "default": false}, "SpaceAfterControlFlowStatementKeyword": {"type": "boolean", "default": true}, "SpaceWithinExpressionParentheses": {"type": "boolean", "default": false}, "SpaceWithinCastParentheses": {"type": "boolean", "default": false}, "SpaceWithinOtherParentheses": {"type": "boolean", "default": false}, "SpaceAfterCast": {"type": "boolean", "default": false}, "SpacesIgnoreAroundVariableDeclaration": {"type": "boolean", "default": false}, "SpaceBeforeOpenSquareBracket": {"type": "boolean", "default": false}, "SpaceBetweenEmptySquareBrackets": {"type": "boolean", "default": false}, "SpaceWithinSquareBrackets": {"type": "boolean", "default": false}, "SpaceAfterColonInBaseTypeDeclaration": {"type": "boolean", "default": true}, "SpaceAfterComma": {"type": "boolean", "default": true}, "SpaceAfterDot": {"type": "boolean", "default": false}, "SpaceAfterSemicolonsInForStatement": {"type": "boolean", "default": true}, "SpaceBeforeColonInBaseTypeDeclaration": {"type": "boolean", "default": true}, "SpaceBeforeComma": {"type": "boolean", "default": false}, "SpaceBeforeDot": {"type": "boolean", "default": false}, "SpaceBeforeSemicolonsInForStatement": {"type": "boolean", "default": false}, "SpacingAroundBinaryOperator": {"type": "string", "default": "single"}, "IndentBraces": {"type": "boolean", "default": false}, "IndentBlock": {"type": "boolean", "default": true}, "IndentSwitchSection": {"type": "boolean", "default": true}, "IndentSwitchCaseSection": {"type": "boolean", "default": true}, "IndentSwitchCaseSectionWhenBlock": {"type": "boolean", "default": true}, "LabelPositioning": {"type": "string", "default": "oneLess"}, "WrappingPreserveSingleLine": {"type": "boolean", "default": true}, "WrappingKeepStatementsOnSingleLine": {"type": "boolean", "default": true}, "NewLinesForBracesInTypes": {"type": "boolean", "default": true}, "NewLinesForBracesInMethods": {"type": "boolean", "default": true}, "NewLinesForBracesInProperties": {"type": "boolean", "default": true}, "NewLinesForBracesInAccessors": {"type": "boolean", "default": true}, "NewLinesForBracesInAnonymousMethods": {"type": "boolean", "default": true}, "NewLinesForBracesInControlBlocks": {"type": "boolean", "default": true}, "NewLinesForBracesInAnonymousTypes": {"type": "boolean", "default": true}, "NewLinesForBracesInObjectCollectionArrayInitializers": {"type": "boolean", "default": true}, "NewLinesForBracesInLambdaExpressionBody": {"type": "boolean", "default": true}, "NewLineForElse": {"type": "boolean", "default": true}, "NewLineForCatch": {"type": "boolean", "default": true}, "NewLineForFinally": {"type": "boolean", "default": true}, "NewLineForMembersInObjectInit": {"type": "boolean", "default": true}, "NewLineForMembersInAnonymousTypes": {"type": "boolean", "default": true}, "NewLineForClausesInQuery": {"type": "boolean", "default": true}}}
omnisharp.json
RoslynExtensionsOptions
Used to define refactorings, code actions and analyzer locations that OmniSharp should use (i.e. Roslynator)
{"type": "object", "properties": {"EnableDecompilationSupport": {"type": "boolean", "default": false}, "EnableAnalyzersSupport": {"type": "boolean", "default": false}, "DocumentAnalysisTimeoutMs": {"type": "integer", "default": 10000}, "LocationPaths": {"type": "array", "items": {"type": "string"}, "default": null}}}
omnisharp.json
EnableAnalyzersSupport
If set to false, only refactorings are available
{"type": "boolean", "default": false}
omnisharp.json
FileOptions
Used to define which directories and files should be included in OmniSharp's project file / solution file discovery process. Not individual .cs files.
{"type": "object", "properties": {"SystemExcludeSearchPatterns": {"type": "array", "items": {"type": "string"}, "default": ["**/node_modules/**/*", "**/bin/**/*", "**/obj/**/*", "**/.git/**/*"]}, "ExcludeSearchPatterns": {"type": "array", "items": {"type": "string"}, "default": []}}}
omnisharp.json
SystemExcludeSearchPatterns
Recommended for manual editing
{"type": "array", "items": {"type": "string"}, "default": ["**/node_modules/**/*", "**/bin/**/*", "**/obj/**/*", "**/.git/**/*"]}
omnisharp.json
ExcludeSearchPatterns
Can be used by tools such as VS Code to automatically share its exclusion settings with OmniSharp
{"type": "array", "items": {"type": "string"}, "default": []}
omnisharp.json
msbuild
Used to configure MSBuild solutions and projects
{"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}, "ToolsVersion": {"type": "string", "default": null, "anyOf": [{"enum": ["Current", "2.0", "3.5", "4.0", "15.0"]}, {"type": "string"}]}, "VisualStudioVersion": {"type": "string", "default": null}, "Configuration": {"default": null, "anyOf": [{"enum": ["Debug", "Release"]}, {"type": "string"}]}, "Platform": {"default": "AnyCPU", "anyOf": [{"enum": ["AnyCPU", "x86", "x64", "ARM", "ARM64", "Itanium"]}, {"type": "string"}]}, "EnablePackageAutoRestore": {"type": "boolean", "default": false}, "MSBuildExtensionsPath": {"type": "string", "default": null}, "TargetFrameworkRootPath": {"type": "string", "default": null}, "MSBuildSDKsPath": {"type": "string", "default": null}, "RoslynTargetsPath": {"type": "string", "default": null}, "CscToolPath": {"type": "string", "default": null}, "CscToolExe": {"type": "string", "default": "csc.exe"}, "loadProjectsOnDemand": {"type": "boolean", "default": false}}}
omnisharp.json
ToolsVersion
Value of ToolsVersion to use when building projects passed to this task
{"type": "string", "default": null, "anyOf": [{"enum": ["Current", "2.0", "3.5", "4.0", "15.0"]}, {"type": "string"}]}
omnisharp.json
Configuration
Build configuration used for project evaluation
{"default": null, "anyOf": [{"enum": ["Debug", "Release"]}, {"type": "string"}]}
omnisharp.json
Platform
Specifies which version of the Common Language Runtime (CLR) use for project evaluation
{"default": "AnyCPU", "anyOf": [{"enum": ["AnyCPU", "x86", "x64", "ARM", "ARM64", "Itanium"]}, {"type": "string"}]}
omnisharp.json
MSBuildExtensionsPath
MSBuild extensions path. On Standalone this defaults to the MSBuild folder. In VisualStudio mode this folder will be %VSINSTALLDIR%\MSBuild
{"type": "string", "default": null}
omnisharp.json
TargetFrameworkRootPath
Root directory where the target framework will be looked for. Uses default path if this is null
{"type": "string", "default": null}
omnisharp.json
MSBuildSDKsPath
Path to the Sdks folder for this MSBuild instance
{"type": "string", "default": null}
omnisharp.json
CscToolPath
Local Roslyn path (e.g. <MSBuildPath>/Current/Bin/Roslyn)
{"type": "string", "default": null}
omnisharp.json
CscToolExe
FileName of C# compiler
{"type": "string", "default": "csc.exe"}
omnisharp.json
loadProjectsOnDemand
If true, MSBuild project system will only be loading projects for files that were opened in the editor as well as referenced projects, recursively
{"type": "boolean", "default": false}
omnisharp.json
script
Used to configure C# scripting (CSX files)
{"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}, "defaultTargetFramework": {"type": "string", "default": "net461", "anyOf": [{"enum": ["netstandard1.0", "netstandard1.1", "netstandard1.2", "netstandard1.3", "netstandard1.4", "netstandard1.5", "netstandard1.6", "netstandard2.0", "netstandard2.1", "netcoreapp1.0", "netcoreapp1.1", "netcoreapp2.0", "netcoreapp2.1", "netcoreapp2.2", "netcoreapp3.0", "netcoreapp3.1", "net11", "net20", "net35", "net40", "net403", "net45", "net451", "net452", "net46", "net461", "net462", "net47", "net471", "net472", "net48"]}, {"type": "string"}]}, "enableScriptNuGetReferences": {"type": "boolean", "default": false}, "rspFilePath": {"type": "string", "default": ""}}}
omnisharp.json
rspFilePath
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.
{"type": "string", "default": ""}
omnisharp.json
cake
Used to configure Cake (cake files)
{"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}, "bakeryPath": {"type": "string", "default": null}}}
cosmos-config.json
rootDir
The root directory that all others paths in this config are relative to. Usually the root of your repo. If omitted, rootDir is equal to the directory containing your Cosmos config. When you don't use a Cosmos config, rootDir defaults to the current working directory.
{"type": "string", "minLength": 1}
cosmos-config.json
exportPath
Where to generate static exports on disk. [default: "cosmos-export"]
{"type": "string", "minLength": 1}
cosmos-config.json
detectLocalPlugins
Automatically detect and load local plugins
{"type": "boolean"}
cosmos-config.json
disablePlugins
Disable plugins
{"type": "boolean"}
cosmos-config.json
staticPath
Dir path to serve static assets from.
{"type": "string", "minLength": 1}
cosmos-config.json
plugins
Module IDs of Cosmos plugins (eg. "react-cosmos-plugin-open-fixture" or "../path/to/my-plugin").
{"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true}
cosmos-config.json
publicUrl
Base URL for static assets. [default: "/"]
{"type": "string"}
cosmos-config.json
fixturesDir
Name for directories that contain fixtures (eg. __fixtures__/example.jsx). [default: "__fixtures__"]
{"type": "string", "minLength": 1}
cosmos-config.json
fixtureFileSuffix
Suffix for fixture files (eg. example.fixture.jsx). [default: "fixture"]
{"type": "string", "minLength": 1}
cosmos-config.json
ignore
Patterns for ignoring fixture and decorator files (eg. ["**/dist/**"]]).
{"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true}
cosmos-config.json
watchDirs
Directories where the Cosmos server watches for fixture files changes while running. [default: ["."]]
{"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true}
cosmos-config.json
lazy
Dynamically import fixture and decorator modules as they are loaded. When false all fixture and decorator modules are imported statically and bundled together. [default: false]
{"type": "boolean"}
cosmos-config.json
exposeImports
Expose user imports and config required for the Cosmos renderer. Used with React Native and in custom integrations. When a path is specified it requires a file extension (eg. "src/cosmos.imports.ts"). [default: false]
{"anyOf": [{"type": "string", "minLength": 1}, {"type": "boolean"}]}
cosmos-config.json
hostname
Dev server hostname. Set to null to accept connections with any hostname. [default: null]
{"anyOf": [{"type": "string", "minLength": 1}, {"type": "null"}]}
cosmos-config.json
port
Dev server port. [default: 5000]
{"type": "number"}
cosmos-config.json
portRetries
Max number of port retries. [default: 10]
{"type": "number"}
cosmos-config.json
https
Server will be served over HTTPS.
{"type": "boolean"}
cosmos-config.json
httpsOptions
Additional options for HTTPS server.
{"type": "object", "additionalProperties": false, "properties": {"certPath": {"type": "string"}, "keyPath": {"type": "string"}}}
cosmos-config.json
certPath
Path of a certificate file
{"type": "string"}
cosmos-config.json
keyPath
Path of a certificate's key file
{"type": "string"}
cosmos-config.json
httpProxy
Proxy some URLs to a different HTTP server (eg. an API backend dev server). Similar to devServer.proxy in webpack config.
{"type": "object", "additionalProperties": true, "patternProperties": {".*": {"anyOf": [{"type": "string"}, {"type": "object", "additionalProperties": true, "required": ["target"], "properties": {"target": {"type": "string"}, "secure": {"type": "boolean"}, "pathRewrite": {"type": "object", "patternProperties": {".*": {"type": "string"}}}, "logLevel": {"type": "string", "enum": ["error", "debug", "info", "warn", "silent"]}}}]}}}
cosmos-config.json
.*
Advanced HTTP proxy config.
{"type": "object", "additionalProperties": true, "required": ["target"], "properties": {"target": {"type": "string"}, "secure": {"type": "boolean"}, "pathRewrite": {"type": "object", "patternProperties": {".*": {"type": "string"}}}, "logLevel": {"type": "string", "enum": ["error", "debug", "info", "warn", "silent"]}}}
cosmos-config.json
globalImports
Modules to be imported before loading components. Stuff like reset.css, polyfills, etc.
{"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true}
cosmos-config.json
rendererUrl
Required when renderer doesn't run on the same port (or host) as the Playground. Useful for integrations with build tools. [default: null]
{"anyOf": [{"type": "string", "minLength": 1}, {"type": "null"}]}
cosmos-config.json
dom
DOM-related options
{"type": "object", "properties": {"containerQuerySelector": {"type": ["string", "null"], "minLength": 1}}}
cosmos-config.json
containerQuerySelector
Document selector for existing element to use as component parent (eg. #root). A blank container element is created from scratch if no selector is provided. [default: null]
{"type": ["string", "null"], "minLength": 1}
cosmos-config.json
vite
Vite-related options
{"type": "object", "additionalProperties": false, "properties": {"configPath": {"anyOf": [{"type": "string", "minLength": 1}, {"enum": [false]}]}, "indexPath": {"anyOf": [{"type": "string", "minLength": 1}, {"type": "null"}]}, "port": {"type": "number"}}}
cosmos-config.json
configPath
Path to Vite config. Set to false to disable reading it from the default path. [default: "vite.config.js"]
{"anyOf": [{"type": "string", "minLength": 1}, {"enum": [false]}]}
cosmos-config.json
indexPath
Path to index module (eg. "src/my-index.tsx"). [default: matches common index/main module paths]
{"anyOf": [{"type": "string", "minLength": 1}, {"type": "null"}]}
cosmos-config.json
port
Vite renderer port. [default: 5050]
{"type": "number"}
cosmos-config.json
webpack
Webpack-related options
{"type": "object", "additionalProperties": false, "properties": {"configPath": {"anyOf": [{"type": "string", "minLength": 1}, {"type": "null"}]}, "overridePath": {"anyOf": [{"type": "string", "minLength": 1}, {"type": "null"}]}, "includeHashInOutputFilename": {"type": "boolean"}, "hotReload": {"type": "boolean"}, "reloadOnFail": {"type": "boolean"}}}
cosmos-config.json
configPath
Path to an existing webpack config, which Cosmos will reuse to build your code. Set to null to disable this behavior. [default: "webpack.config.js"]
{"anyOf": [{"type": "string", "minLength": 1}, {"type": "null"}]}
cosmos-config.json
overridePath
Path to a user module that customizes the webpack config used by Cosmos. Set to null to disable this behavior. [default: "webpack.override.js"]
{"anyOf": [{"type": "string", "minLength": 1}, {"type": "null"}]}
cosmos-config.json
includeHashInOutputFilename
Changes output filename from "[name].js" to "[name].[contenthash].js". [default: false]
{"type": "boolean"}
cosmos-config.json
hotReload
Enable webpack's Hot Module Replacement. [default: true]
{"type": "boolean"}
cosmos-config.json
reloadOnFail
When using webpack's Hot Module Replacement, enable automatic location reload after webpack fails to update modules. [default: false]
{"type": "boolean"}
cosmos-config.json
ui
UI plugin options
{"type": "object", "additionalProperties": true, "properties": {"responsivePreview": {"type": "object", "additionalProperties": false, "properties": {"devices": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["label", "width", "height"], "properties": {"label": {"type": "string", "minLength": 1}, "width": {"type": "number", "minimum": 1}, "height": {"type": "number", "minimum": 1}}}}}}}}
cosmos-config.json
devices
List of device viewports
{"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["label", "width", "height"], "properties": {"label": {"type": "string", "minLength": 1}, "width": {"type": "number", "minimum": 1}, "height": {"type": "number", "minimum": 1}}}}
venvironment-schema.json
full
Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.
{"$schema": "http://json-schema.org/draft-07/schema#", "const": "2.1.0", "type": "string", "examples": ["2.1.0"]}
venvironment-schema.json
full
Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.
{"$schema": "http://json-schema.org/draft-07/schema#", "oneOf": [{}, {"type": "array", "items": {}}], "examples": ["my_include.yaml", ["my_include.yml", "my_other_include.json"]]}