schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
template.json
additionalProperties
Converts the source value to a string suitable for a C# namespace.
{"properties": {"identifier": {"enum": ["safe_namespace"]}}}
template.json
additionalProperties
Converts the source value to a lowercase string suitable for a C# namespace.
{"properties": {"identifier": {"enum": ["lower_safe_namespace"]}}}
template.json
additionalProperties
Performs a series of transforms.
{"required": ["steps"], "properties": {"identifier": {"enum": ["chain"]}, "steps": {"type": "array", "items": {"type": "string"}}}}
template.json
items
The name of the form to apply to the previous step (or source value if this is the first step).
{"type": "string"}
template.json
additionalProperties
Changes the case of source value to lower-case.
{"properties": {"identifier": {"enum": ["lowerCase"]}}}
template.json
additionalProperties
Returns the source value.
{"properties": {"identifier": {"enum": ["identity"]}}}
template.json
additionalProperties
Converts the source value to upper-case using the casing rules of the current culture.
{"properties": {"identifier": {"enum": ["upperCase"]}}}
template.json
additionalProperties
Converts the source value to upper-case using the casing rules of the invariant culture.
{"properties": {"identifier": {"enum": ["upperCaseInvariant"]}}}
template.json
additionalProperties
JSON encodes the source value.
{"properties": {"identifier": {"enum": ["jsonEncode"]}}}
template.json
additionalProperties
Converts the first letter of the value to lowercase using the casing rules of the current culture.
{"properties": {"identifier": {"enum": ["firstLowerCase"]}}}
template.json
additionalProperties
Converts the first letter of the value to lowercase using the casing rules of the invariant culture.
{"properties": {"identifier": {"enum": ["firstLowerCaseInvariant"]}}}
template.json
additionalProperties
Converts the first letter of the value to uppercase using the casing rules of the current culture.
{"properties": {"identifier": {"enum": ["firstUpperCase"]}}}
template.json
additionalProperties
Converts the first letter of the value to uppercase using the casing rules of the invariant culture.
{"properties": {"identifier": {"enum": ["firstUpperCaseInvariant"]}}}
template.json
additionalProperties
Converts the value to title case using the casing rules of the current culture.
{"properties": {"identifier": {"enum": ["titleCase"]}}}
template.json
additionalProperties
Converts the value to kebab case using the casing rules of the invariant culture.
{"properties": {"identifier": {"enum": ["kebabCase"]}}}
template.json
symbols
The symbols section defines variables and their values, the values may be the defined in terms of other symbols. When a defined symbol name is encountered anywhere in the template definition, it is replaced by the value defined in this configuration. The symbols configuration is a collection of key-value pairs. The keys are the symbol names, and the value contains key-value-pair configuration information on how to assign the symbol a value.
{"type": "object", "additionalProperties": {"type": "object", "required": ["type"], "properties": {"datatype": {}, "type": {"type": "string", "enum": ["bind", "derived", "generated", "parameter", "computed"]}}, "oneOf": [{"required": ["binding"], "properties": {"type": {"enum": ["bind"]}, "binding": {"type": "string"}, "defaultValue": {"type": "string"}, "replaces": {"type": "string"}, "fileRename": {"type": "string"}, "onlyIf": {"type": "array", "items": {"type": "object", "properties": {"after": {"type": "string"}, "before": {"type": "string"}}}}}}, {"required": ["valueSource", "valueTransform"], "properties": {"type": {"enum": ["derived"]}, "valueSource": {"type": "string"}, "valueTransform": {"type": "string"}, "defaultValue": {"type": "string"}, "replaces": {"type": "string"}, "fileRename": {"type": "string"}, "onlyIf": {"type": "array", "items": {"type": "object", "properties": {"after": {"type": "string"}, "before": {"type": "string"}}}}}}, {"required": ["generator"], "properties": {"type": {"enum": ["generated"]}, "replaces": {"type": "string"}, "fileRename": {"type": "string"}, "onlyIf": {"type": "array", "items": {"type": "object", "properties": {"after": {"type": "string"}, "before": {"type": "string"}}}}}, "oneOf": [{}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}]}, {"properties": {"type": {"enum": ["parameter"]}, "isRequired": {"oneOf": [{"type": "boolean"}, {"type": "string"}]}, "isEnabled": {"oneOf": [{"type": "boolean"}, {"type": "string"}]}, "choices": {"type": "array", "items": {"required": ["choice"], "properties": {"choice": {"type": "string"}, "displayName": {"type": "string"}}}}, "defaultValue": {"type": "string"}, "replaces": {"type": "string"}, "fileRename": {"type": "string"}, "onlyIf": {"type": "array", "items": {"type": "object", "properties": {"after": {"type": "string"}, "before": {"type": "string"}}}}, "allowMultipleValues": {"type": "boolean", "default": false}, "enableQuotelessLiterals": {"type": "boolean", "default": false}, "displayName": {"type": "string"}, "forms": {"type": "object", "properties": {"global": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}}}}, {"properties": {"type": {"enum": ["computed"]}, "value": {"type": "string"}}}]}}
template.json
type
The symbol binds value from external sources.
{"enum": ["bind"]}
template.json
binding
The source and the name of parameter to take the value from. The syntax is: <external source>:<parameter name>. Well known external sources are: host - a value that is defined by the template engine host; env - environment variable.
{"type": "string"}
template.json
defaultValue
The value assigned to the symbol if no value was provided from external source(s).
{"type": "string"}
template.json
replaces
The text to replace with the value of this symbol.
{"type": "string"}
template.json
fileRename
Defines the portion of file names which will be replaced by symbol value.
{"type": "string"}
template.json
after
The replacement string occurs after this value.
{"type": "string"}
template.json
before
The replacement string occurs before this value.
{"type": "string"}
template.json
type
The value of this symbol is derived from the value of another symbol by the application of value forms.
{"enum": ["derived"]}
template.json
valueSource
The name of the symbol that the value should be derived from.
{"type": "string"}
template.json
valueTransform
The name of the value form that should be applied to the source value to use as the value of this symbol.
{"type": "string"}
template.json
defaultValue
The value assigned to the symbol if no value was provided.
{"type": "string"}
template.json
replaces
The text to replace with the value of this symbol.
{"type": "string"}
template.json
fileRename
Defines the portion of file names which will be replaced by symbol value.
{"type": "string"}
template.json
after
The replacement string occurs after this value.
{"type": "string"}
template.json
before
The replacement string occurs before this value.
{"type": "string"}
template.json
type
Defines the high level configuration of symbol.
{"enum": ["generated"]}
template.json
replaces
The text to replace with the value of this symbol.
{"type": "string"}
template.json
fileRename
Defines the portion of file names which will be replaced by symbol value.
{"type": "string"}
template.json
after
The replacement string occurs after this value.
{"type": "string"}
template.json
before
The replacement string occurs before this value.
{"type": "string"}
template.json
type
Defines the high level configuration of symbol.
{"enum": ["parameter"]}
template.json
isRequired
Flag indicating whether the parameter has to be specified on the input.
{"type": "boolean"}
template.json
isRequired
Condition indicating whether the parameter has to be specified on the input.
{"type": "string"}
template.json
isEnabled
Flag indicating parameter visibility.
{"type": "boolean"}
template.json
isEnabled
Condition indicating parameter visibility.
{"type": "string"}
template.json
choices
An array listing the valid choices for a symbol whose datatype = choice. If not provided, there are no valid choices for the symbol, so it can never be assigned a value.
{"type": "array", "items": {"required": ["choice"], "properties": {"choice": {"type": "string"}, "displayName": {"type": "string"}}}}
template.json
choice
A valid value for the symbol.
{"type": "string"}
template.json
description
Help text describing the meaning of the corresponding value.
{"type": "string"}
template.json
displayName
The friendly name of the choice to be displayed to the user. This property can be localized.
{"type": "string"}
template.json
defaultValue
The value assigned to the symbol if no value for it is provided by the user or host.
{"type": "string"}
template.json
description
The description of the parameter.
{"type": "string"}
template.json
replaces
The text to replace with the value of this symbol.
{"type": "string"}
template.json
fileRename
The element defines the portion of file names which will be replaced by symbol value.
{"type": "string"}
template.json
after
The replacement string occurs after this value.
{"type": "string"}
template.json
before
The replacement string occurs before this value.
{"type": "string"}
template.json
allowMultipleValues
Indication whether multiple values can be specified for a parameter. Valid only for datatype = choice.
{"type": "boolean", "default": false}
template.json
enableQuotelessLiterals
Indication whether implicit symbols for each choice value should be added to parameter collection. This allows condition syntax without using quotes for choice literals. Valid only for datatype = choice.
{"type": "boolean", "default": false}
template.json
displayName
The friendly name of the symbol to be displayed to the user. This property can be localized.
{"type": "string"}
template.json
global
An array of the forms applied to the parameter symbol. Note that the forms should produce the different result on the value of 'replaces' and 'fileRename' properties. Use the form in the template content to apply corresponding transformation to the value given by the user as the parameter.
{"type": "array", "items": {"type": "string", "uniqueItems": true}}
template.json
global
The form applied to the parameter symbol. Note that the forms should produce the different result on the value of 'replaces' and 'fileRename' properties. Use the form in the template content to apply corresponding transformation to the value given by the user as the parameter.
{"type": "string"}
template.json
type
Defines the high level configuration of symbol.
{"enum": ["computed"]}
template.json
value
An evaluate-able condition whose result defines the value of the symbol.
{"type": "string"}
template.json
baselines
Alternate sets of defaults for symbols.
{"type": "object", "additionalProperties": {"type": "object", "properties": {"defaultOverrides": {"type": "object", "additionalProperties": {"type": "string"}}}}}
template.json
additionalProperties
A named set of alternate defaults.
{"type": "object", "properties": {"defaultOverrides": {"type": "object", "additionalProperties": {"type": "string"}}}}
template.json
description
A string to use to indicate the intent of the baseline.
{"type": "string"}
template.json
defaultOverrides
A lookup of symbol names to new defaults.
{"type": "object", "additionalProperties": {"type": "string"}}
template.json
additionalProperties
An updated default value for the specified symbol.
{"type": "string"}
template.json
tags
Common information about templates, these are effectively interchangeable with choice type parameter symbols.
{"type": "object", "required": ["type"], "properties": {"language": {"type": "string"}, "type": {"enum": ["project", "item", "solution"]}}}
template.json
language
The programming language the template primarily contains or is intended for use with.
{"type": "string"}
template.json
type
The type of template: project or item.
{"enum": ["project", "item", "solution"]}
template.json
thirdPartyNotices
An URL for a document indicating any libraries used by the template that are not owned/provided by the template author.
{"type": "string"}
template.json
description
A description of the template's purpose or contents for use in help.
{"type": "string"}
template.json
constraints
The constraints section defines the restrictions when the template can be run. Available since .NET SDK 7.0.100.
{"type": "object", "additionalProperties": {"type": "object", "required": ["type"], "properties": {"type": {"type": "string"}, "args": {}}, "oneOf": [{"not": {"required": ["type"], "properties": {"type": {"enum": ["os", "host", "workload", "sdk-version", "project-capability"]}}}, "properties": {"args": {"type": ["array", "object", "string"]}}}, {"properties": {"type": {"enum": ["os"]}, "args": {"oneOf": [{"type": "string", "enum": ["Windows", "Linux", "OSX"]}, {"type": "array", "items": {"type": "string", "enum": ["Windows", "Linux", "OSX"]}}]}}}, {"properties": {"type": {"enum": ["host"]}, "args": {"type": "array", "items": {"type": "object", "required": ["hostname"], "properties": {"hostname": {"type": "string", "oneOf": [{"not": {"enum": ["dotnetcli", "vs", "vs-mac", "ide"]}}, {"enum": ["dotnetcli", "vs", "vs-mac", "ide"]}]}, "version": {"type": "string"}}}}}}, {"properties": {"type": {"enum": ["workload"]}, "args": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}}, {"properties": {"type": {"enum": ["sdk-version"]}, "args": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}}, {"properties": {"type": {"enum": ["project-capability"]}, "args": {"type": "string"}}}]}}
template.json
type
Constraint type.
{"type": "string"}
template.json
args
Constraints arguments.
{}
template.json
additionalProperties
Operating system constraint. Allows to restrict the template to be run only on specific operating systems.
{"properties": {"type": {"enum": ["os"]}, "args": {"oneOf": [{"type": "string", "enum": ["Windows", "Linux", "OSX"]}, {"type": "array", "items": {"type": "string", "enum": ["Windows", "Linux", "OSX"]}}]}}}
template.json
additionalProperties
Host constraint. Allows to restrict the template to be run only on specific applications using template engine.
{"properties": {"type": {"enum": ["host"]}, "args": {"type": "array", "items": {"type": "object", "required": ["hostname"], "properties": {"hostname": {"type": "string", "oneOf": [{"not": {"enum": ["dotnetcli", "vs", "vs-mac", "ide"]}}, {"enum": ["dotnetcli", "vs", "vs-mac", "ide"]}]}, "version": {"type": "string"}}}}}}
template.json
hostname
The identifier of supported host. Commonly used identifiers are: 'dotnetcli'' - .NET SDK, 'vs' - Visual Studio, 'vs-mac' - Visual Studio for Mac, 'ide' - Visual Studio (any platform).
{"type": "string", "oneOf": [{"not": {"enum": ["dotnetcli", "vs", "vs-mac", "ide"]}}, {"enum": ["dotnetcli", "vs", "vs-mac", "ide"]}]}
template.json
version
The supported version of the host. May be an exact version, float version or version range. Refer to https://docs.microsoft.com/en-us/nuget/concepts/package-versioning for more info.
{"type": "string"}
template.json
additionalProperties
Installed workload constraint. Allows to restrict the template to be run only on host with specific workloads installed.
{"properties": {"type": {"enum": ["workload"]}, "args": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}}
template.json
args
supported workload (running host need to have at least one of the requested workloads installed).
{"type": "string"}
template.json
items
supported workload (running host need to have at least one of the requested workloads installed).
{"type": "string"}
template.json
additionalProperties
SDK version constraint. Allows to restrict the template to be run only on specific .NET SDK version(s).
{"properties": {"type": {"enum": ["sdk-version"]}, "args": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}}
template.json
args
The supported version of the SDK. May be an exact version, float version or version range. Refer to https://docs.microsoft.com/en-us/nuget/concepts/package-versioning for more info.
{"type": "string"}
template.json
items
The supported version of the SDK. May be an exact version, float version or version range. Refer to https://docs.microsoft.com/en-us/nuget/concepts/package-versioning for more info.
{"type": "string"}
template.json
additionalProperties
The project context constraint. Allows to restrict the item template to be run only on inside .NET project with certain capabilities.
{"properties": {"type": {"enum": ["project-capability"]}, "args": {"type": "string"}}}
template.json
args
Project capability expression that should be satisfied by the project. Refer to https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualstudio.shell.interop.vsprojectcapabilityexpressionmatcher for more info.
{"type": "string"}
webextension.json
browser_style
Use this to include a stylesheet in your popup that will make it look consistent with the browser's UI and with other add-ons that use the browser_style property. Although this key defaults to false, it's recommended that you include it and set it to true.
{"type": "boolean", "default": false}
webextension.json
default_popup
The popup appears when the user clicks the icon.
{"type": "string"}
webextension.json
default_title
Tooltip for the main toolbar icon.
{"type": "string"}
webextension.json
content_security_policy
This introduces some fairly strict policies that will make extensions more secure by default, and provides you with the ability to create and enforce rules governing the types of content that can be loaded and executed by your extensions and applications.
{"type": "string", "default": "script-src 'self'; object-src 'self'"}
webextension.json
applications
The applications key contains keys that are specific to a particular host application.
{"type": "object", "properties": {"gecko": {"type": "object", "properties": {"id": {"type": "string", "pattern": "^\\{[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}\\}$|^[A-Za-z0-9-._]*@[A-Za-z0-9-._]+$"}, "strict_min_version": {"type": "string", "default": "42a1"}, "strict_max_version": {"type": "string", "default": "*"}, "update_url": {"type": "string", "format": "uri"}}}}}
webextension.json
id
id is the extension ID
{"type": "string", "pattern": "^\\{[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}\\}$|^[A-Za-z0-9-._]*@[A-Za-z0-9-._]+$"}
webextension.json
strict_min_version
Minimum version of Gecko to support. Defaults to '42a1'. (Requires Gecko 45)
{"type": "string", "default": "42a1"}
webextension.json
strict_max_version
Maximum version of Gecko to support. Defaults to '*'. (Requires Gecko 45)
{"type": "string", "default": "*"}
webextension.json
update_url
Link to an add-on update manifest. (Requires Gecko 45)
{"type": "string", "format": "uri"}
webextension.json
author
"The extension's author, intended for display in the browser's user interface. If the developer key is supplied and it contains the "name" property, it will override the author key. There's no way to specify multiple authors."
{"type": "string"}
webextension.json
background
The background page is an HTML page that runs in the extension process. It exists for the lifetime of your extension, and only one instance of it at a time is active.
{"type": "object", "properties": {"persistent": {"type": "boolean", "default": true}, "page": {"type": "string"}, "scripts": {"type": "array", "items": {"type": "string"}}}}
webextension.json
persistent
When false, makes the background page an event page (loaded only when needed).
{"type": "boolean", "default": true}
webextension.json
page
Specify the HTML of the background page.
{"type": "string"}
webextension.json
scripts
A background page will be generated by the extension system that includes each of the files listed in the scripts property.
{"type": "array", "items": {"type": "string"}}
webextension.json
browser_action
browser action is a button that your extension adds to the browser's toolbar. The button has an icon, and may optionally have a popup whose content is specified using HTML, CSS, and JavaScript.
{"allOf": [{}], "properties": {"default_area": {"enum": ["navbar", "menupanel", "tabstrip", "personaltoolbar"], "default": "navbar"}}}
webextension.json
default_area
Defines the part of the browser in which the button is initially placed.
{"enum": ["navbar", "menupanel", "tabstrip", "personaltoolbar"], "default": "navbar"}
webextension.json
chrome_settings_overrides
Use the chrome_settings_overrides key to override certain browser settings
{"type": "object", "properties": {"homepage": {"type": "string"}}}