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
template.json
steps
An ordered list of key-value pairs indicating the regex replacement actions. Each element of the list must contain exactly the keys 'regex' and 'replacement' - along with their values. These replacements will be applied to the result of the previous replacement (except the first, which acts on the original value from the source).
{"type": "array", "items": {"required": ["regex", "replacement"], "properties": {"regex": {"type": "string"}, "replacement": {"type": "string"}}}}
template.json
regex
The regular expression to use to locate the sequence to replace.
{"type": "string"}
template.json
replacement
The replacement for any sequences matched by the supplied regular expression.
{"type": "string"}
template.json
source
The symbol to search for a match. Its value will be used by this generator's regex to evaluate if there is a match. The value of the source parameter is not modified.
{"type": "string"}
template.json
pattern
The regular expression to use to match.
{"type": "string"}
template.json
sourceVariableName
The name of the symbol whose value will be inspected - if the value is effectively equal to the default value, the value of the symbol referred to by fallbackVariableName is used, otherwise the value of this symbol.
{"type": "string"}
template.json
defaultValue
The value to consider as being the default - if the value of the symbol referred to by sourceVariableName is equal to this, the value of the symbol referred to in fallbackVariableName is used instead.
{"type": "string", "default": ""}
template.json
fallbackVariableName
The name of the symbol to return the value of if the symbol referred to by sourceVariableName has a value equal to the value of defaultValue.
{"type": "string"}
template.json
source
The name of the symbol whose value should have its case changed.
{"type": "string"}
template.json
toLower
Whether the case changed to should be lower case, if false, the value is made to be uppercase instead.
{"type": "boolean", "default": true}
template.json
low
The lower bound of acceptable port numbers.
{"type": "integer", "default": 1024}
template.json
high
The upper bound of acceptable port numbers.
{"type": "integer", "default": 65535}
template.json
fallback
The port number to use if no free ports could be found.
{"type": "integer", "default": 0}
template.json
evaluator
The style of evaluator to use.
{"enum": ["C++", "C++2", "MSBUILD", "VB"], "default": "C++"}
template.json
cases
The set of cases to test for. The first one, in document order, to return true's value is used, if none return true, empty string is returned.
{"type": "array", "items": {"type": "object", "required": ["condition", "value"], "properties": {"condition": {"type": "string"}, "value": {"type": "string"}}}}
template.json
condition
An expression to be interpreted by the specified evaluator type.
{"type": "string"}
template.json
value
The value to return if the condition evaluates to true.
{"type": "string"}
template.json
separator
The value used as the separator between the values to be concatenated, notice that you can use "/" as folder separator also on Windows since File API will convert it into "\".
{"default": "", "type": "string"}
template.json
removeEmptyValues
Indication whether null and empty strings should be removed from joining to prevent repetitive separators.
{"default": "false", "type": "boolean"}
template.json
symbols
All values to concatenate.
{"type": "array", "items": {"type": "object", "required": ["value"], "properties": {"type": {"enum": ["ref", "const"]}, "value": {"type": "string"}}}}
template.json
type
"ref" to reference value from another symbol or "const" for string constant, defaults to "const".
{"enum": ["ref", "const"]}
template.json
value
Either name of another symbol or string constant.
{"type": "string"}
template.json
guid
A guid string to be replaced in source files. Format and casing is not significant in the config as format and casing is preserved based on the particular guid in processed file(s).
{"pattern": "^\\{?[0-9A-Fa-f]{8}[-]?([0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}\\}?$", "type": "string"}
template.json
condition
Boolean condition to indicate if the sources configuration should be included or ignored. If the condition evaluates to true or is not provided, the sources config will be used for creating the template. If it evaluates to false, the sources config will be ignored.
{"type": "string"}
template.json
exclude
The set of globbing patterns indicating the content that was included by sources.include that should not be processed.
{"allOf": [{}], "default": ["**/[Bb]in/**", "**/[Oo]bj/**", ".template.config/**/*", "**/*.filelist", "**/*.user", "**/*.lock.json"]}
template.json
include
The set of globbing patterns indicating the content to process in the path referred to by the source.
{"allOf": [{}], "default": ["**/*"]}
template.json
copyOnly
The set of globbing patterns indicating the content that was included by sources.include, that hasn't been excluded by sources.exclude that should be placed in the user's directory without modification.
{"allOf": [{}], "default": ["**/node_modules/**/*"]}
template.json
rename
The set of explicit renames to perform. Each key is a path to a file in the source, each value is a path to the target location.
{"type": "object", "additionalProperties": {"type": "string"}}
template.json
modifiers
A list of additional source information which gets added to the top-level source information, based on evaluation the corresponding source.modifiers.condition.
{"type": "array", "items": {}}
template.json
source
The path in the template content (relative to the directory containing the .template.config folder) that should be processed.
{"type": "string", "default": "./"}
template.json
target
The path (relative to the directory the user has specified) that content should be written to.
{"type": "string", "default": "./"}
template.json
author
The author of the template.
{"type": "string"}
template.json
classifications
Zero or more characteristics of the template that a user might search for it by.
{"type": "array", "items": {"type": "string", "minLength": 1}}
template.json
defaultName
The name to use during creation if no name has been specified by the user or provided from the host.
{"type": "string", "minLength": 1}
template.json
generatorVersions
The semantic version range of the Microsoft.TemplateEngine.Orchestrator.RunnableProjects package that this template is usable with. In older versions of the engine, the four octet version string is used but is matched against a constant which was never changed from 1.0.0.0 - either syntax is now accepted, however the four octet string will not be changed from 1.0.0.0.
{"type": "string", "default": "[1.0.0.0-*)"}
template.json
groupIdentity
The ID of the group this template belongs to. When combined with the "tags" section, this allows multiple templates to be displayed as one, with the the decision for which one to use being presented as a choice in each one of the pivot categories (keys).
{"type": "string", "minLength": 1}
template.json
guids
A list of guids which appear in the template source and should be replaced in the template output. For each guid listed, a replacement guid is generated, and replaces all occurrences of the source guid in the output.
{"type": "array", "uniqueItems": true, "items": {}}
template.json
identity
A unique name for this template.
{"type": "string", "minLength": 1}
template.json
name
The name for the template that users should see.
{"type": "string", "minLength": 1}
template.json
placeholderFilename
A filename that will be completely ignored except to indicate that its containing directory should be copied. This allows creation of an empty directory in the created template, by having a corresponding source directory containing just the placeholder file. Completely empty directories are ignored.
{"type": "string", "default": "-.-"}
template.json
postActions
Defines an ordered list of actions to perform after template generation. The post action information is provided to the creation broker, to act on as appropriate.
{"type": "array", "items": {"type": "object", "allOf": [{"required": ["actionId", "manualInstructions"], "properties": {"actionId": {"allOf": [{}]}, "args": {"type": "object"}, "condition": {"type": "string"}, "continueOnError": {"type": "boolean", "default": false}, "id": {"type": "string"}, "applyFileRenamesToArgs": {"type": "array", "items": {"type": "string"}}, "applyFileRenamesToManualInstructions": {"type": "boolean", "default": false}, "manualInstructions": {"type": "array", "items": {"type": "object", "required": ["text"], "properties": {"condition": {"type": "string"}, "text": {"type": "string"}, "id": {"type": "string"}}}}}}, {"oneOf": [{"not": {"required": ["actionId"], "properties": {"actionId": {"enum": ["AC1156F7-BB77-4DB8-B28F-24EEBCCA1E5C", "3A7C4B45-1F5D-4A30-959A-51B88E82B5D2", "B17581D1-C5C9-4489-8F0A-004BE667B814", "cb9a6cf3-4f5c-4860-b9d2-03a574959774", "210D431B-A78B-4D2F-B762-4ED3E3EA9025", "D396686C-DE0E-4DE6-906D-291CD29FC5DE", "84C0DA21-51C8-4541-9940-6CA19AF04EE6"]}}}}, {"properties": {"actionId": {"enum": ["AC1156F7-BB77-4DB8-B28F-24EEBCCA1E5C"]}, "args": {"properties": {"executable": {"type": "string"}, "args": {"type": "string"}}}}}, {"properties": {"actionId": {"enum": ["3A7C4B45-1F5D-4A30-959A-51B88E82B5D2"]}, "args": {"required": ["executable"], "properties": {"redirectStandardOutput": {"type": "boolean", "default": true}, "redirectStandardError": {"type": "boolean", "default": true}, "executable": {"type": "string"}, "args": {"type": "string"}}}}}, {"properties": {"actionId": {"enum": ["B17581D1-C5C9-4489-8F0A-004BE667B814"]}, "args": {"required": ["referenceType", "reference"], "properties": {"referenceType": {"type": "string", "enum": ["project", "package", "framework"], "default": "false"}, "projectFileExtensions": {"type": "string"}, "reference": {"type": "string"}, "version": {"type": "string"}, "targetFiles": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}}}}, {"properties": {"actionId": {"enum": ["cb9a6cf3-4f5c-4860-b9d2-03a574959774"]}, "args": {"type": "object", "additionalProperties": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}}}, {"properties": {"actionId": {"enum": ["210D431B-A78B-4D2F-B762-4ED3E3EA9025"]}, "args": {"properties": {"files": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}}}}, {"properties": {"actionId": {"enum": ["D396686C-DE0E-4DE6-906D-291CD29FC5DE"]}, "args": {"properties": {"primaryOutputIndexes": {"type": "string"}, "solutionFolder": {"type": "string"}, "inRoot": {"type": "boolean"}, "projectFiles": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}}}}, {"properties": {"actionId": {"enum": ["84C0DA21-51C8-4541-9940-6CA19AF04EE6"]}, "args": {"properties": {"files": {"type": "string"}}}}}]}]}}
template.json
actionId
A guid uniquely defining the action. The value must correspond to a post-action known by the broker.
{"allOf": [{}]}
template.json
args
A list of key-value pairs to use when performing the action. The specific parameters required / allowed are defined by the action itself.
{"type": "object"}
template.json
condition
A C++ style expression that, if it evaluates to 'false' causes the post-action to be skipped. This expression may refer to any symbols that have been defined.
{"type": "string"}
template.json
continueOnError
If this action fails, the value of continueOnError indicates whether to attempt the next action, or stop processing the post actions. Should be set to true when subsequent actions rely on the success of the current action.
{"type": "boolean", "default": false}
template.json
description
A human-readable description of the action.
{"type": "string"}
template.json
id
Defines identifier to be used when localizing the post action artifacts.
{"type": "string"}
template.json
applyFileRenamesToArgs
A list of arguments names from 'args' to which the file renames configured in symbols should be applied.
{"type": "array", "items": {"type": "string"}}
template.json
applyFileRenamesToManualInstructions
If set to true, the file renames configured in symbols should be applied to manual instructions.
{"type": "boolean", "default": false}
template.json
manualInstructions
An ordered list of possible instructions to display if the action cannot be performed. Each element in the list must contain a key named "text", whose value contains the instructions. Each element may also optionally provide a key named "condition" - a Boolean evaluate-able string. The first instruction whose condition is false or blank will be considered valid, all others are ignored.
{"type": "array", "items": {"type": "object", "required": ["text"], "properties": {"condition": {"type": "string"}, "text": {"type": "string"}, "id": {"type": "string"}}}}
template.json
id
Defines identifier to be used when localizing the manual instructions.
{"type": "string"}
template.json
items
Instruction display - shows a message given by description and manualInstructions as well as an optional command line to ask the user to execute.
{"properties": {"actionId": {"enum": ["AC1156F7-BB77-4DB8-B28F-24EEBCCA1E5C"]}, "args": {"properties": {"executable": {"type": "string"}, "args": {"type": "string"}}}}}
template.json
executable
The executable to instruct the user to run.
{"type": "string"}
template.json
args
The arguments to instruct the user to run the executable with - if executable is not specified, this value is unused.
{"type": "string"}
template.json
items
Process start - starts a process.
{"properties": {"actionId": {"enum": ["3A7C4B45-1F5D-4A30-959A-51B88E82B5D2"]}, "args": {"required": ["executable"], "properties": {"redirectStandardOutput": {"type": "boolean", "default": true}, "redirectStandardError": {"type": "boolean", "default": true}, "executable": {"type": "string"}, "args": {"type": "string"}}}}}
template.json
redirectStandardOutput
Whether or not to redirect stdout for the process (prevents output from being displayed if true).
{"type": "boolean", "default": true}
template.json
redirectStandardError
Defines whether or not the stderr should be redirected. If the output is redirected, it prevents it from being displayed.
{"type": "boolean", "default": true}
template.json
executable
The executable to run.
{"type": "string"}
template.json
args
The arguments to supply to the executable.
{"type": "string"}
template.json
items
Add reference - adds a reference to a project, package or framework assembly.
{"properties": {"actionId": {"enum": ["B17581D1-C5C9-4489-8F0A-004BE667B814"]}, "args": {"required": ["referenceType", "reference"], "properties": {"referenceType": {"type": "string", "enum": ["project", "package", "framework"], "default": "false"}, "projectFileExtensions": {"type": "string"}, "reference": {"type": "string"}, "version": {"type": "string"}, "targetFiles": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}}}}
template.json
referenceType
The type of reference to add. project = A project to project reference. package = A NuGet package reference. framework - A framework assembly reference.
{"type": "string", "enum": ["project", "package", "framework"], "default": "false"}
template.json
projectFileExtensions
Must be a literal extension for the project file(s) of interest, may be a semicolon delimited list. If unspecified, any project file (*.*proj) is allowed.
{"type": "string"}
template.json
reference
The reference to be added (if referenceType=package, this is the package ID; if referenceType=framework, this is the path or assembly name; if referenceType=project, this is the path to the project reference to add).
{"type": "string"}
template.json
version
The version of the package reference to add, applicable only if referenceType=package.
{"type": "string"}
template.json
targetFiles
An array of files that should be processed. If not specified, the project file in output directory or its closest parent directory will be used.
{"type": "array", "items": {"type": "string", "uniqueItems": true}}
template.json
targetFiles
A semicolon delimited list of files that should be processed. If not specified, the project file in output directory or its closest parent directory will be used.
{"type": "string"}
template.json
items
chmod - runs chmod on a particular file.
{"properties": {"actionId": {"enum": ["cb9a6cf3-4f5c-4860-b9d2-03a574959774"]}, "args": {"type": "object", "additionalProperties": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}}}
template.json
args
The permissions to set: the key-value pairs, where the key is a permission, and the value is a file or array of files to apply the permission to.
{"type": "object", "additionalProperties": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}
template.json
additionalProperties
The set of files (or patterns) to apply the permission specified in the property name to.
{"type": "array", "items": {"type": "string", "uniqueItems": true}}
template.json
additionalProperties
The file (or pattern) to apply the permission specified in the property name to.
{"type": "string"}
template.json
items
NuGet package restore - restores NuGet packages for all primary outputs with file extensions *.proj or *.sln.
{"properties": {"actionId": {"enum": ["210D431B-A78B-4D2F-B762-4ED3E3EA9025"]}, "args": {"properties": {"files": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}}}}
template.json
files
An array of files that should be restored. If not specified, all primary outputs are restored.
{"type": "array", "items": {"type": "string", "uniqueItems": true}}
template.json
files
A semicolon delimited list of files that should be restored. If not specified, all primary outputs are restored.
{"type": "string"}
template.json
items
Add to solution - Adds one or more of the primary outputs to the first sln file found (searches up the directory tree from the output folder).
{"properties": {"actionId": {"enum": ["D396686C-DE0E-4DE6-906D-291CD29FC5DE"]}, "args": {"properties": {"primaryOutputIndexes": {"type": "string"}, "solutionFolder": {"type": "string"}, "inRoot": {"type": "boolean"}, "projectFiles": {"oneOf": [{"type": "array", "items": {"type": "string", "uniqueItems": true}}, {"type": "string"}]}}}}}
template.json
primaryOutputIndexes
A semicolon delimited list of indexes of the primary outputs that should be added to the solution, if not specified, all primary outputs are used.
{"type": "string"}
template.json
solutionFolder
The destination solution folder path to add the projects to. Can't be used with 'inRoot'. Optional.
{"type": "string"}
template.json
inRoot
Places the projects in the root of the solution, rather than creating a solution folder. Cannot be used with 'solutionFolder'. Optional. Available since .NET SDK 7.0.200.
{"type": "boolean"}
template.json
projectFiles
An array of project files that should be added to solution. If not specified, primary outputs will be used instead.
{"type": "array", "items": {"type": "string", "uniqueItems": true}}
template.json
projectFiles
A semicolon delimited list of files that should be added to solution. If not specified, primary outputs will be used instead.
{"type": "string"}
template.json
items
Open in editor - Adds one or more of the primary outputs to the first sln file found (searches up the directory tree from the output folder).
{"properties": {"actionId": {"enum": ["84C0DA21-51C8-4541-9940-6CA19AF04EE6"]}, "args": {"properties": {"files": {"type": "string"}}}}}
template.json
files
A semicolon delimited list of indexes of the primary outputs that should be opened in the editor.
{"type": "string"}
template.json
precedence
A value used to determine how preferred this template is among the other templates with the same groupIdentity (higher values are more preferred).
{"type": ["integer", "string"], "pattern": "^([0-9]+)$", "default": 0}
template.json
preferDefaultName
Indicated which behaviour to use when no `--name` is specified during template creation. If `true` it will use the template's `defaultName`. If no `defaultName` is found, or `preferDefaultName` is `false` it uses the fallback (output folder).
{"type": ["boolean"]}
template.json
preferNameDirectory
Indicates whether to create a directory for the template if name is specified but an output directory is not set (instead of creating the content directly in the current directory).
{"type": "boolean"}
template.json
primaryOutputs
A list of important output paths created during template generation. These paths need to be added to the newly created project at the end of template creation.
{"type": "array", "items": {"type": "object", "required": ["path"], "properties": {"path": {"type": "string"}, "condition": {"type": "string", "default": "true"}}}}
template.json
path
The path to the file in the template content whose corresponding output file should be included as a primary output.
{"type": "string"}
template.json
condition
The condition for including the specified path in the primary outputs set.
{"type": "string", "default": "true"}
template.json
shortName
A shorthand name for selecting the template in CLI environment. The template short name should be unique across all the installed templates.
{"type": "string"}
template.json
shortName
A shorthand name for selecting the template in CLI environment. The first element is a primary choice, and will be used in scenarios which allow only single value for the short name. The template short name should be unique across all the installed templates.
{"type": "array", "items": {"type": "string"}}
template.json
sourceName
The text in the source content to replace with the name the user specifies. The value of the 'sourceName' is available in built-in 'name' symbol that can be used as the source for creating other symbols and condition expressions. See important information about how to select correct 'sourceName' in https://github.com/dotnet/templating/wiki/Naming-and-default-value-forms.
{"type": "string"}
template.json
sources
The set of mappings in the template content to user directories.
{"type": "array", "items": {}, "default": {"source": "./", "target": "./"}}
template.json
forms
Custom value forms used by the template.
{"type": "object", "additionalProperties": {"type": "object", "properties": {"identifier": {"type": "string"}}, "oneOf": [{"not": {"required": ["identifier"], "properties": {"identifier": {"enum": ["lowerCaseInvariant", "xmlEncode", "safe_name", "lower_safe_name", "upperCaseInvariant", "replace", "safe_namespace", "lower_safe_namespace", "chain", "lowerCase", "identity", "upperCase", "jsonEncode", "firstLowerCase", "firstLowerCaseInvariant", "firstUpperCase", "firstUpperCaseInvariant", "titleCase", "kebabCase"]}}}}, {"properties": {"identifier": {"enum": ["lowerCaseInvariant"]}}}, {"properties": {"identifier": {"enum": ["xmlEncode"]}}}, {"properties": {"identifier": {"enum": ["safe_name"]}}}, {"properties": {"identifier": {"enum": ["lower_safe_name"]}}}, {"required": ["pattern", "replacement"], "properties": {"identifier": {"enum": ["replace"]}, "pattern": {"type": "string"}, "replacement": {"type": "string"}}}, {"properties": {"identifier": {"enum": ["safe_namespace"]}}}, {"properties": {"identifier": {"enum": ["lower_safe_namespace"]}}}, {"required": ["steps"], "properties": {"identifier": {"enum": ["chain"]}, "steps": {"type": "array", "items": {"type": "string"}}}}, {"properties": {"identifier": {"enum": ["lowerCase"]}}}, {"properties": {"identifier": {"enum": ["identity"]}}}, {"properties": {"identifier": {"enum": ["upperCase"]}}}, {"properties": {"identifier": {"enum": ["upperCaseInvariant"]}}}, {"properties": {"identifier": {"enum": ["jsonEncode"]}}}, {"properties": {"identifier": {"enum": ["firstLowerCase"]}}}, {"properties": {"identifier": {"enum": ["firstLowerCaseInvariant"]}}}, {"properties": {"identifier": {"enum": ["firstUpperCase"]}}}, {"properties": {"identifier": {"enum": ["firstUpperCaseInvariant"]}}}, {"properties": {"identifier": {"enum": ["titleCase"]}}}, {"properties": {"identifier": {"enum": ["kebabCase"]}}}]}}
template.json
identifier
The identifier for the value form component that will be used to transform the value.
{"type": "string"}
template.json
additionalProperties
Lowercases the source value in a culture invariant way.
{"properties": {"identifier": {"enum": ["lowerCaseInvariant"]}}}
template.json
additionalProperties
XML encodes the source value.
{"properties": {"identifier": {"enum": ["xmlEncode"]}}}
template.json
additionalProperties
Converts the source value to a string suitable for a C# identifier.
{"properties": {"identifier": {"enum": ["safe_name"]}}}
template.json
additionalProperties
Converts the source value to a lowercase string suitable for a C# identifier.
{"properties": {"identifier": {"enum": ["lower_safe_name"]}}}
template.json
additionalProperties
Performs a regular expression replacement on the source value.
{"required": ["pattern", "replacement"], "properties": {"identifier": {"enum": ["replace"]}, "pattern": {"type": "string"}, "replacement": {"type": "string"}}}
template.json
pattern
A regular expression whose matches will be replaced with the literal value specified in replacement.
{"type": "string"}
template.json
replacement
The value to replace the matches of the specified pattern in the source value with.
{"type": "string"}