VSIX CLI publishing

Visual Studio extension publishing

Type object
File match vs-publish.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/vsix-cli-publishing/latest.json
Source https://www.schemastore.org/vsix-publish.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

identity object required
9 nested properties
internalName string required

The internal name of the extension. A marketplace extension is identified as 'publisherName'.'internalName'. Cannot contain spaces.

minLength=1maxLength=63pattern=^[^\s-]+$
description string

A description for the extension. Required if the extension is not a VSIX.

minLength=1maxLength=280
displayName string

A display name for the extension. Required if the extension is not a VSIX.

minLength=1maxLength=80
icon string

An icon for the extension. Required if the extension is not a VSIX. Can be relative to the current json file's directory.

minLength=1
installTargets object[]

A list of install targets for the extension. At least one is required if the extension is not a VSIX.

minItems=1uniqueItems=true
language string | number

The default language the extension applies to. Must be a CLR locale code or an lcid code.

pattern=^(\d{4})$|^([a-zA-Z]{2}(-[A-Za-z]{2})?)$|^neutral$
tags string[]

A list of tags for the extension.

version string

The version of the extension. Required if the extension is not a VSIX.

pattern=^([0-9]+\.){1,3}([0-9]+)$
vsixId string

The vsix identifier of the extension.

minLength=1
categories string | enum[] required

A list of categories that the extension applies to.

minItems=1maxItems=3uniqueItems=true
overview string required

A path to a markdown file that will be displayed on the extension's page in the marketplace. The path can be relative to the current json file's path.

minLength=1
publisher string required

The publisher of the extension. Must not be a display name of the publisher.

minLength=1
assetFiles object[]

A list of assets to include in the package sent to the marketplace.

priceCategory string

The pricing model for the extension.

Default: "free"
Values: "free" "trial" "paid"
private boolean

If true, the extension will be uploaded as a private extension.

Default: false
qna boolean

If true, the extension will have a Q&A page on the marketplace.

Default: true
repo string

A URL that points to the GitHub repo for the extension.

format=uri