VSIX CLI publishing

Visual Studio extension publishing

vs-publish.json

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your vs-publish.json and it validates in your browser — nothing is uploaded.

Validate a vs-publish.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`identity`required	`object`	—
`identity.description`	`string`	A description for the extension. Required if the extension is not a VSIX.
`identity.displayName`	`string`	A display name for the extension. Required if the extension is not a VSIX.
`identity.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.
`identity.installTargets`	`array<object>`	A list of install targets for the extension. At least one is required if the extension is not a VSIX.
`identity.internalName`required	`string`	The internal name of the extension. A marketplace extension is identified as 'publisherName'.'internalName'. Cannot contain spaces.
`identity.language`	`anyOf`	The default language the extension applies to. Must be a CLR locale code or an lcid code.
`identity.tags`	`array<string>`	A list of tags for the extension.
`identity.version`	`string`	The version of the extension. Required if the extension is not a VSIX.
`identity.vsixId`	`string`	The vsix identifier of the extension.
`assetFiles`	`array<object>`	A list of assets to include in the package sent to the marketplace.
`categories`required	`array`	A list of categories that the extension applies to.
`overview`required	`string`	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.
`priceCategory`	`string`	The pricing model for the extension. default: `"free"` one of: `"free", "trial", "paid"`
`publisher`required	`string`	The publisher of the extension. Must not be a display name of the publisher.
`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.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
22 properties, 95% carrying a description, max nesting depth 8.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`anyOf`	JSON Schema Core, draft 2020-12	§10.2.1.2 — "anyOf"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`format`	JSON Schema Validation, draft 2020-12	§7 — Vocabularies for Semantic Content With "format"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`maxItems`	JSON Schema Validation, draft 2020-12	§6.4.1 — "maxItems"
`maxLength`	JSON Schema Validation, draft 2020-12	§6.3.1 — "maxLength"
`minItems`	JSON Schema Validation, draft 2020-12	§6.4.2 — "minItems"
`minLength`	JSON Schema Validation, draft 2020-12	§6.3.2 — "minLength"
`pattern`	JSON Schema Validation, draft 2020-12	§6.3.3 — "pattern"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"
`uniqueItems`	JSON Schema Validation, draft 2020-12	§6.4.3 — "uniqueItems"
`format: "uri"`	RFC 3986 (STD 66)	§3 — Syntax Components

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas