ide.host.json

IDE template host file

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

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

name

Name of the template

All of: text object
description

Description of the template

All of: text object
order integer

The order of the template as shown in the New Project dialog

Default: 0
icon string

The relative file name of the icon to show in the New Project dialog

supportsDocker boolean

Determines if the checkbox for adding Docker support in the New Project dialog should be visible

disableHttpsSymbol string

The symbol in the template.json which when set, would cause the template to generate non-https ports and settings

defaultSymbolVisibility boolean

Sets the default isVisible for a symbolInfo if not explicitly specified. Controls if the parameter is displayed in the IDE. Defaults to false if not specified

defaultPersistenceScope

The default value for a symbolInfo if not explicitly specified. Determines if the user entered value should be persisted and used the next time a template is selected. Used starting in Visual Studio 2022 17.3

All of: persistenceScope string
defaultPersistenceScopeName string

The default value for a symbolInfo if not explicitly specified. Specifies the scope name of the persisted template option. To avoid conflicts with other templates, treat this like a namespace. Used starting in Visual Studio 2022 17.3

symbolInfo array

Controls display characteristics of symbols declared in template.json

tags array

Modifigy the project and platform tags displayed in the IDE

unsupportedHosts array

Unsupported Hosts. This can be used to suppress the template from being displayed in the new project dialog in Visual Studio.

requiredComponents array

Required components in order to display this template.

Definitions

text object
text string required
package string
pattern=^\{?[0-9A-Fa-f]{8}[-]?([0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}\}?$
id string
persistenceScope string

Determines if the user entered values should be persisted for the next template invocation.

overrideInfo object
id string required

The id of the symbol from the template.json.

name

Overrides the name specified in the template.json

All of: text object
description

Overrides the name specified in the template.json

All of: text object
symbolInfo object
isVisible boolean

Should be shown in the IDE. If not specified, defaults value is the value specified by defaultSymbolVisibility.

invertBoolean boolean

If the referenced symbol should be shown in the IDE.

defaultValue string

Overrides the default value specified for the

persistenceScope

Determines if the user entered value should be persisted and used the next time a template is selected. Default value is the value specified by defaultSymbolVisibility Used starting in Visual Studio 2022 17.3

All of: persistenceScope string
persistenceScopeName string

Specifies the scope name of the persisted template option. To avoid conflicts with other templates, treat this like a namespace. Used starting in Visual Studio 2022 17.3

choices array

Specifies the name and description overrides for individual choice parameters

tags object
type string required

The tag to modify

Values: "platform" "projectType"
add string[]

Tags to add

remove string[]

Tags to remove. * can be specified to remove all tags specified in template.json

unsupportedHost object
id string required

The host identifier.

Values: "vs"
version

A version range specifying the unsupported host versions. This uses the nuget package format.

requiredComponent object

To require a particular host version specify the hostId and optionally version only. To require a particular SetupComponent or Extension, specify the ID and set the componentType appropriately. Version range is optional.

hostId string required

The host id that the component applies to

Values: "vs"
id string

The id of the component

componentType string
Values: "setupComponent" "extension"
version

A version range specifying the required version range. This uses the nuget package format.