Skip to main content

types

MS Code Extension API


MS Code Extension API / features/extensions/types

features/extensions/types

Interfaces

ChangelogEntry

Defined in: features/extensions/types.ts:233

Single historical development data block log entry describing version milestones tracking release notes.

Properties

changes

changes: string[]

Defined in: features/extensions/types.ts:239

Detailed line items summarizing structural updates, bug fixes, or framework enhancements

date

date: string

Defined in: features/extensions/types.ts:237

Natural language date indicator matching execution metrics (e.g., '2026-05-25')

version

version: string

Defined in: features/extensions/types.ts:235

Targeted descriptive tracking release token tag matching current changes (e.g., 'v2.1.0')


Extension

Defined in: features/extensions/types.ts:104

Enhanced runtime blueprint reflecting telemetry properties, verification records, and system platform mapping coordinates resolved from cloud distribution catalogs.

Extends

Properties

activates

activates: string[]

Defined in: features/extensions/types.ts:91

Dynamic conditional context initialization string identifiers tracking workspace actions.

Example
['onLanguage:javascript', 'onCommand:myExtension.runLint']
Inherited from

ExtensionManifest.activates

category

category: ExtensionCategory

Defined in: features/extensions/types.ts:77

Primary category anchor positioning item placement inside search filters

Inherited from

ExtensionManifest.category

changelog?

optional changelog?: string

Defined in: features/extensions/types.ts:95

Collection block documenting updates and feature addition records

Inherited from

ExtensionManifest.changelog

contributes?

optional contributes?: any

Defined in: features/extensions/types.ts:120

Raw dynamic fallback contribution hook tracking configurations before static JSON parsing loops

description

description: string

Defined in: features/extensions/types.ts:73

Abstract summarizing the functional capabilities of the package bundle

Inherited from

ExtensionManifest.description

downloads

downloads: number

Defined in: features/extensions/types.ts:112

Total statistical counter aggregation indicating installation usage across the lifetime repository

fileUrl?

optional fileUrl?: string

Defined in: features/extensions/types.ts:118

Cloud payload binary source URL pointer used during extraction operations

icon?

optional icon?: string

Defined in: features/extensions/types.ts:81

Relative icon filename token path pointing to asset layouts inside folder structures

Inherited from

ExtensionManifest.icon

iconColor?

optional iconColor?: string

Defined in: features/extensions/types.ts:83

Optional aesthetic background configuration hex parameter token applied during visual rendering

Inherited from

ExtensionManifest.iconColor

iconLetter?

optional iconLetter?: string

Defined in: features/extensions/types.ts:85

Single alphanumeric glyph character fallback used if an extension is missing an avatar asset

Inherited from

ExtensionManifest.iconLetter

id

id: string

Defined in: features/extensions/types.ts:67

Unique structural identification namespace (e.g., 'publisher.extension-id')

Inherited from

ExtensionManifest.id

isBuiltIn

isBuiltIn: boolean

Defined in: features/extensions/types.ts:108

Flags whether the module belongs to core baseline IDE internal packages (bundled by default)

isVerified

isVerified: boolean

Defined in: features/extensions/types.ts:110

True if the developer cryptographic signature passes standard framework origin validation rules

license?

optional license?: string

Defined in: features/extensions/types.ts:97

Legal copyright governance agreement document text

Inherited from

ExtensionManifest.license

main?

optional main?: string

Defined in: features/extensions/types.ts:87

Sandbox bootstrap bundle execution target script filename entrypoint path (e.g., 'out/main.js')

Inherited from

ExtensionManifest.main

name

name: string

Defined in: features/extensions/types.ts:69

Natural text naming token displayed across storefront catalogs and lists

Inherited from

ExtensionManifest.name

publisher

publisher: string

Defined in: features/extensions/types.ts:71

Developer or enterprise handle managing publishing workflows

Inherited from

ExtensionManifest.publisher

rating

rating: number

Defined in: features/extensions/types.ts:114

Star rating score (0.0 to 5.0) compiled mathematically out of community evaluations

readme?

optional readme?: string

Defined in: features/extensions/types.ts:93

Extracted inline plain-text string formatting sheet or absolute reference target path

Inherited from

ExtensionManifest.readme

storeDir

storeDir: string

Defined in: features/extensions/types.ts:106

Physical targeted sandboxed location directory pointer tracked within system storage tables (e.g., 'extensions/id-v1')

tags

tags: string[]

Defined in: features/extensions/types.ts:79

Descriptive keywords indexing utility features for system discovery algorithms

Inherited from

ExtensionManifest.tags

version

version: string

Defined in: features/extensions/types.ts:75

Strict Semantic Versioning string token (e.g., '1.4.2')

Inherited from

ExtensionManifest.version

zipSize?

optional zipSize?: string

Defined in: features/extensions/types.ts:116

String metric evaluating package download constraints (e.g., '2.4 MB')


ExtensionContributions

Defined in: features/extensions/types.ts:154

Registered configuration extensions blueprint detailing language mappings, custom workbench menu interactions, environment settings schemas, and visual themes. Supports string configurations pointing to external sub-JSON definition paths.

Properties

activityBar?

optional activityBar?: object[]

Defined in: features/extensions/types.ts:197

Sidebar navigation panel visual launchers injected onto the primary horizontal activity toolbar.

icon

icon: string

id

id: string

position?

optional position?: "top" | "bottom"

priority?

optional priority?: number

title

title: string

commands?

optional commands?: object[]

Defined in: features/extensions/types.ts:168

Visual actions injected directly into the Global Command Palette window index schemas.

icon?

optional icon?: string

id

id: string

title

title: string

configuration?

optional configuration?: string | Record<string, { default: unknown; description: string; enum?: string[]; type: "string" | "number" | "boolean" | "array"; }>

Defined in: features/extensions/types.ts:178

Custom application runtime schema configurations exposed inside the settings workbench engine views. Supports an external configuration filepath token string or raw key-value schema definitions block.

iconThemes?

optional iconThemes?: object[]

Defined in: features/extensions/types.ts:192

File icon visualization mapping templates targeting file matching layouts inside the Explorer trees

id

id: string

label

label: string

path

path: string

keybindings?

optional keybindings?: object[]

Defined in: features/extensions/types.ts:208

Keyboard shortcuts matching complex environmental focus conditions ('when' context validation expressions).

args?

optional args?: any

command

command: string

key

key: string

mac?

optional mac?: string

when?

optional when?: string

languages?

optional languages?: string | object[]

Defined in: features/extensions/types.ts:159

Grammar registries injecting syntactical definitions to handle custom file extensions inside Monaco. Supports an external relative filepath pointer string or direct array mappings.

optional menus?: Record<string, object[]>

Defined in: features/extensions/types.ts:219

Declarative Menu Contributions

snippets?

optional snippets?: object[]

Defined in: features/extensions/types.ts:186

Autocomplete text templates mapping syntax blocks based on structural language file identifiers

language

language: string

path

path: string

themes?

optional themes?: object[]

Defined in: features/extensions/types.ts:189

Workbench color themes templates mapping background values and tokens highlighting configurations

label

label: string

path

path: string

uiTheme

uiTheme: "vs" | "vs-dark" | "hc-black"


ExtensionDetail

Defined in: features/extensions/types.ts:246

Resolved aggregate package profile housing active extension metadata blueprints alongside sanitized markup sheets ready for UI view presentations. Used by the Extension Manager View.

Properties

changelog

changelog: string

Defined in: features/extensions/types.ts:254

Prepared application modification records mapping release note streams

contributions

contributions: ExtensionContributions

Defined in: features/extensions/types.ts:250

Parsed declarative system features and active API integration hooks

license

license: string

Defined in: features/extensions/types.ts:256

Prepared governance text detailing legal restrictions, usage criteria, and ownership parameters

manifest

manifest: Extension

Defined in: features/extensions/types.ts:248

Hydrated core catalog identity profile metrics data block

readme

readme: string

Defined in: features/extensions/types.ts:252

Fully prepared Markdown layout content mapping documentation sheets


ExtensionFilter

Defined in: features/extensions/types.ts:142

Bounded state parameters mapping real-time text mutations and category dropdown targets in search views.

Properties

category

category: ExtensionCategory

Defined in: features/extensions/types.ts:146

Filter selection targeting specific group arrays exclusively

query

query: string

Defined in: features/extensions/types.ts:144

Raw text query containing matching search expressions or specialized lookup tokens like '@id:git'


ExtensionManifest

Defined in: features/extensions/types.ts:65

Base configuration blueprint representing an extension's internal package rules, activation criteria hooks, and structured information layouts. Matches the core properties declared inside a plug-in's 'manifest.json'.

Extended by

Properties

activates

activates: string[]

Defined in: features/extensions/types.ts:91

Dynamic conditional context initialization string identifiers tracking workspace actions.

Example
['onLanguage:javascript', 'onCommand:myExtension.runLint']
category

category: ExtensionCategory

Defined in: features/extensions/types.ts:77

Primary category anchor positioning item placement inside search filters

changelog?

optional changelog?: string

Defined in: features/extensions/types.ts:95

Collection block documenting updates and feature addition records

description

description: string

Defined in: features/extensions/types.ts:73

Abstract summarizing the functional capabilities of the package bundle

icon?

optional icon?: string

Defined in: features/extensions/types.ts:81

Relative icon filename token path pointing to asset layouts inside folder structures

iconColor?

optional iconColor?: string

Defined in: features/extensions/types.ts:83

Optional aesthetic background configuration hex parameter token applied during visual rendering

iconLetter?

optional iconLetter?: string

Defined in: features/extensions/types.ts:85

Single alphanumeric glyph character fallback used if an extension is missing an avatar asset

id

id: string

Defined in: features/extensions/types.ts:67

Unique structural identification namespace (e.g., 'publisher.extension-id')

license?

optional license?: string

Defined in: features/extensions/types.ts:97

Legal copyright governance agreement document text

main?

optional main?: string

Defined in: features/extensions/types.ts:87

Sandbox bootstrap bundle execution target script filename entrypoint path (e.g., 'out/main.js')

name

name: string

Defined in: features/extensions/types.ts:69

Natural text naming token displayed across storefront catalogs and lists

publisher

publisher: string

Defined in: features/extensions/types.ts:71

Developer or enterprise handle managing publishing workflows

readme?

optional readme?: string

Defined in: features/extensions/types.ts:93

Extracted inline plain-text string formatting sheet or absolute reference target path

tags

tags: string[]

Defined in: features/extensions/types.ts:79

Descriptive keywords indexing utility features for system discovery algorithms

version

version: string

Defined in: features/extensions/types.ts:75

Strict Semantic Versioning string token (e.g., '1.4.2')


ExtensionRecord

Defined in: features/extensions/types.ts:128

Local non-volatile manifest log record mapping current execution states, configuration update sequences, and origin installation targets. Persisted in the IDE system storage database layout.

Properties

installedAt

installedAt: number

Defined in: features/extensions/types.ts:132

Unix Epoch millisecond timestamp index tracking exactly when the installation completed

installedFrom

installedFrom: string

Defined in: features/extensions/types.ts:136

Virtual workspace source indicator recording local absolute filepaths or server cloud signatures

state

state: ExtensionRuntimeState

Defined in: features/extensions/types.ts:130

Current functional state mapping (enabled, disabled, or uninstalled tracker flags)

version

version: string

Defined in: features/extensions/types.ts:134

Current active local tracking deployment release variant tag

Type Aliases

DetailTab

DetailTab = "details" | "contributions" | "changelog" | "runtime"

Defined in: features/extensions/types.ts:262

Enumerated navigation anchor identifiers controlling active view states inside the Extension Details View panel.


ExtensionCategory

ExtensionCategory = "All" | "Language Support" | "Themes" | "Linters" | "Formatters" | "Snippets" | "Other"

Defined in: features/extensions/types.ts:51

Categorization tags mapping how the extension appears and groups inside the Marketplace storefront view.


ExtensionRuntimeState

ExtensionRuntimeState = "not-installed" | "installed-enabled" | "installed-disabled" | "uninstalled" | "installed-dev"

Defined in: features/extensions/types.ts:36

Represents the immediate execution state of a plugin within the workspace context.