Documentation
¶
Overview ¶
The product package provides data structures to configure a VSCode product.
Index ¶
- type AIGeneratedWorkspaceTrust
- type AppCenterConfiguration
- type BuiltInExtension
- type ConfigBasedExtensionTip
- type Configuration
- type ConfigurationSyncStore
- type ExeBasedExtensionTip
- type ExtensionRecommendationCondition
- type ExtensionRecommendations
- type ExtensionUntrustedWorkspaceSupport
- type ExtensionVirtualWorkspaceSupport
- type FeaturedExtension
- type FileContentCondition
- type FileLanguageCondition
- type FileOpenCondition
- type FilePathCondition
- type GitHubEntitlement
- type ProductWalkthrough
- type ProductWalkthroughStep
- type RemoteExtensionTip
- type SettingsEditorOpenCondition
- type SurveyData
- type TunnelApplicationConfig
- type VirtualWorkspaceExtensionTip
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppCenterConfiguration ¶
type BuiltInExtension ¶
type ConfigBasedExtensionTip ¶
type ConfigBasedExtensionTip struct {
ConfigPath string `json:"configPath"`
ConfigName string `json:"configName"`
ConfigScheme *string `json:"configScheme,omitempty"`
Recommendations map[string]struct {
Name string `json:"name"`
ContentPattern *string `json:"contentPattern,omitempty"`
Important *bool `json:"important,omitempty"`
IsExtensionPack *bool `json:"isExtensionPack,omitempty"`
WhenNotInstalled []string `json:"whenNotInstalled,omitempty"`
} `json:"recommendations"`
}
type Configuration ¶
type Configuration struct {
Version string `json:"version,omitempty"`
Date *string `json:"date,omitempty"`
Quality *string `json:"quality,omitempty"`
Commit *string `json:"commit,omitempty"`
NameShort string `json:"nameShort,omitempty"`
NameLong string `json:"nameLong,omitempty"`
Win32AppUserModelID *string `json:"win32AppUserModelId,omitempty"`
Win32MutexName *string `json:"win32MutexName,omitempty"`
Win32RegValueName *string `json:"win32RegValueName,omitempty"`
ApplicationName string `json:"applicationName,omitempty"`
EmbedderIdentifier *string `json:"embedderIdentifier,omitempty"`
URLProtocol string `json:"urlProtocol,omitempty"`
DataFolderName string `json:"dataFolderName,omitempty"`
BuiltInExtensions []BuiltInExtension `json:"builtInExtensions,omitempty"`
WalkthroughMetadata []ProductWalkthrough `json:"walkthroughMetadata,omitempty"`
FeaturedExtensions []FeaturedExtension `json:"featuredExtensions,omitempty"`
DownloadURL *string `json:"downloadUrl,omitempty"`
UpdateURL *string `json:"updateUrl,omitempty"`
WebURL *string `json:"webUrl,omitempty"`
WebEndpointURLTemplate *string `json:"webEndpointUrlTemplate,omitempty"`
WebviewContentExternalBaseURLTemplate *string `json:"webviewContentExternalBaseUrlTemplate,omitempty"`
Target *string `json:"target,omitempty"`
NlsCoreBaseURL *string `json:"nlsCoreBaseUrl,omitempty"`
SettingsSearchBuildID *int `json:"settingsSearchBuildId,omitempty"`
SettingsSearchURL *string `json:"settingsSearchUrl,omitempty"`
TasConfig *struct {
Endpoint string `json:"endpoint"`
TelemetryEventName string `json:"telemetryEventName"`
AssignmentContextTelemetryPropertyName string `json:"assignmentContextTelemetryPropertyName"`
} `json:"tasConfig,omitempty"`
ExtensionsGallery *struct {
ServiceURL string `json:"serviceUrl"`
ServicePPEURL *string `json:"servicePPEUrl,omitempty"`
SearchURL *string `json:"searchUrl,omitempty"`
ItemURL string `json:"itemUrl"`
PublisherURL string `json:"publisherUrl"`
ResourceURLTemplate string `json:"resourceUrlTemplate"`
ControlURL string `json:"controlUrl"`
NlsBaseURL string `json:"nlsBaseUrl"`
} `json:"extensionsGallery,omitempty"`
ExtensionRecommendations map[string]ExtensionRecommendations `json:"extensionRecommendations,omitempty"`
ConfigBasedExtensionTips map[string]ConfigBasedExtensionTip `json:"configBasedExtensionTips,omitempty"`
ExeBasedExtensionTips map[string]ExeBasedExtensionTip `json:"exeBasedExtensionTips,omitempty"`
RemoteExtensionTips map[string]RemoteExtensionTip `json:"remoteExtensionTips,omitempty"`
VirtualWorkspaceExtensionTips map[string]VirtualWorkspaceExtensionTip `json:"virtualWorkspaceExtensionTips,omitempty"`
ExtensionKeywords map[string][]string `json:"extensionKeywords,omitempty"`
KeymapExtensionTips []string `json:"keymapExtensionTips,omitempty"`
WebExtensionTips []string `json:"webExtensionTips,omitempty"`
LanguageExtensionTips []string `json:"languageExtensionTips,omitempty"`
TrustedExtensionURLPublicKeys map[string][]string `json:"trustedExtensionUrlPublicKeys,omitempty"`
TrustedExtensionAuthAccess any `json:"trustedExtensionAuthAccess,omitempty"`
TrustedExtensionProtocolHandlers []string `json:"trustedExtensionProtocolHandlers,omitempty"`
CommandPaletteSuggestedCommandIDs []string `json:"commandPaletteSuggestedCommandIds,omitempty"`
CrashReporter *struct {
CompanyName string `json:"companyName"`
ProductName string `json:"productName"`
} `json:"crashReporter,omitempty"`
RemoveTelemetryMachineID *bool `json:"removeTelemetryMachineId,omitempty"`
EnabledTelemetryLevels struct {
Error bool `json:"error"`
Usage bool `json:"usage"`
} `json:"enabledTelemetryLevels"`
EnableTelemetry *bool `json:"enableTelemetry,omitempty"`
OpenToWelcomeMainPage *bool `json:"openToWelcomeMainPage,omitempty"`
AiConfig *struct {
AriaKey string `json:"ariaKey"`
} `json:"aiConfig,omitempty"`
DocumentationURL *string `json:"documentationUrl,omitempty"`
ServerDocumentationURL *string `json:"serverDocumentationUrl,omitempty"`
ReleaseNotesURL *string `json:"releaseNotesUrl,omitempty"`
KeyboardShortcutsURLMac *string `json:"keyboardShortcutsUrlMac,omitempty"`
KeyboardShortcutsURLLinux *string `json:"keyboardShortcutsUrlLinux,omitempty"`
KeyboardShortcutsURLWin *string `json:"keyboardShortcutsUrlWin,omitempty"`
IntroductoryVideosURL *string `json:"introductoryVideosUrl,omitempty"`
TipsAndTricksURL *string `json:"tipsAndTricksUrl,omitempty"`
NewsletterSignupURL *string `json:"newsletterSignupUrl,omitempty"`
YouTubeURL *string `json:"youTubeUrl,omitempty"`
RequestFeatureURL *string `json:"requestFeatureUrl,omitempty"`
ReportIssueURL *string `json:"reportIssueUrl,omitempty"`
ReportMarketplaceIssueURL *string `json:"reportMarketplaceIssueUrl,omitempty"`
LicenseURL *string `json:"licenseUrl,omitempty"`
ServerLicenseURL *string `json:"serverLicenseUrl,omitempty"`
PrivacyStatementURL *string `json:"privacyStatementUrl,omitempty"`
ShowTelemetryOptOut *bool `json:"showTelemetryOptOut,omitempty"`
ServerGreeting []string `json:"serverGreeting,omitempty"`
ServerLicense []string `json:"serverLicense,omitempty"`
ServerLicensePrompt *string `json:"serverLicensePrompt,omitempty"`
ServerApplicationName string `json:"serverApplicationName"`
ServerDataFolderName *string `json:"serverDataFolderName,omitempty"`
TunnelApplicationName *string `json:"tunnelApplicationName,omitempty"`
TunnelApplicationConfig *TunnelApplicationConfig `json:"tunnelApplicationConfig,omitempty"`
NpsSurveyURL *string `json:"npsSurveyUrl,omitempty"`
CesSurveyURL *string `json:"cesSurveyUrl,omitempty"`
Surveys []SurveyData `json:"surveys,omitempty"`
Checksums map[string]string `json:"checksums,omitempty"`
ChecksumFailMoreInfoURL *string `json:"checksumFailMoreInfoUrl,omitempty"`
AppCenter *AppCenterConfiguration `json:"appCenter,omitempty"`
Portable *string `json:"portable,omitempty"`
ExtensionKind map[string][]string `json:"extensionKind,omitempty"`
ExtensionPointExtensionKind map[string][]string `json:"extensionPointExtensionKind,omitempty"`
ExtensionSyncedKeys map[string][]string `json:"extensionSyncedKeys,omitempty"`
ExtensionsEnabledWithApiProposalVersion []string `json:"extensionsEnabledWithApiProposalVersion,omitempty"`
ExtensionEnabledApiProposals map[string][]string `json:"extensionEnabledApiProposals,omitempty"`
ExtensionUntrustedWorkspaceSupport map[string]ExtensionUntrustedWorkspaceSupport `json:"extensionUntrustedWorkspaceSupport,omitempty"`
ExtensionVirtualWorkspacesSupport map[string]ExtensionVirtualWorkspaceSupport `json:"extensionVirtualWorkspacesSupport,omitempty"`
MsftInternalDomains []string `json:"msftInternalDomains,omitempty"`
LinkProtectionTrustedDomains []string `json:"linkProtectionTrustedDomains,omitempty"`
ConfigurationSyncStore *ConfigurationSyncStore `json:"configurationSync.store,omitempty"`
EditSessionsStore *ConfigurationSyncStore `json:"editSessions.store,omitempty"`
DarwinUniversalAssetID *string `json:"darwinUniversalAssetId,omitempty"`
ProfileTemplatesURL *string `json:"profileTemplatesUrl,omitempty"`
CommonlyUsedSettings []string `json:"commonlyUsedSettings,omitempty"`
AiGeneratedWorkspaceTrust *AIGeneratedWorkspaceTrust `json:"aiGeneratedWorkspaceTrust,omitempty"`
GitHubEntitlement *GitHubEntitlement `json:"gitHubEntitlement,omitempty"`
ChatParticipantRegistry *string `json:"chatParticipantRegistry,omitempty"`
}
type ConfigurationSyncStore ¶
type ExeBasedExtensionTip ¶
type ExeBasedExtensionTip struct {
FriendlyName string `json:"friendlyName"`
WindowsPath *string `json:"windowsPath,omitempty"`
Important *bool `json:"important,omitempty"`
Recommendations map[string]struct {
Name string `json:"name"`
Important *bool `json:"important,omitempty"`
IsExtensionPack *bool `json:"isExtensionPack,omitempty"`
WhenNotInstalled []string `json:"whenNotInstalled,omitempty"`
} `json:"recommendations"`
}
type ExtensionRecommendations ¶
type ExtensionRecommendations struct {
OnFileOpen []FileOpenCondition `json:"onFileOpen"`
OnSettingsEditorOpen *SettingsEditorOpenCondition `json:"onSettingsEditorOpen,omitempty"`
}
type FeaturedExtension ¶
type FileContentCondition ¶
type FileContentCondition struct {
ExtensionRecommendationCondition
FileLanguageCondition
FilePathCondition
ContentPattern string `json:"contentPattern"`
}
type FileLanguageCondition ¶
type FileLanguageCondition struct {
Languages []string `json:"languages"`
}
type FileOpenCondition ¶
type FileOpenCondition any
type FilePathCondition ¶
type FilePathCondition struct {
PathGlob string `json:"pathGlob"`
}
type GitHubEntitlement ¶
type GitHubEntitlement struct {
ProviderID string `json:"providerId"`
Command struct {
Title string `json:"title"`
TitleWithoutPlaceHolder string `json:"titleWithoutPlaceHolder"`
Action string `json:"action"`
When string `json:"when"`
} `json:"command"`
EntitlementURL string `json:"entitlementUrl"`
ExtensionID string `json:"extensionId"`
EnablementKey string `json:"enablementKey"`
ConfirmationMessage string `json:"confirmationMessage"`
ConfirmationAction string `json:"confirmationAction"`
}
type ProductWalkthrough ¶
type ProductWalkthrough struct {
ID string `json:"id"`
Steps []ProductWalkthroughStep `json:"steps"`
}
type ProductWalkthroughStep ¶
type RemoteExtensionTip ¶
type RemoteExtensionTip struct {
FriendlyName string `json:"friendlyName"`
ExtensionID string `json:"extensionId"`
SupportedPlatforms []string `json:"supportedPlatforms,omitempty"`
StartEntry struct {
HelpLink string `json:"helpLink"`
StartConnectLabel string `json:"startConnectLabel"`
StartCommand string `json:"startCommand"`
Priority int `json:"priority"`
} `json:"startEntry"`
}
type SurveyData ¶
type TunnelApplicationConfig ¶
type TunnelApplicationConfig struct {
AuthenticationProviders map[string]struct {
Scopes []string `json:"scopes"`
} `json:"authenticationProviders"`
EditorWebURL string `json:"editorWebUrl"`
Extension RemoteExtensionTip `json:"extension"`
}
type VirtualWorkspaceExtensionTip ¶
type VirtualWorkspaceExtensionTip struct {
FriendlyName string `json:"friendlyName"`
ExtensionID string `json:"extensionId"`
SupportedPlatforms []string `json:"supportedPlatforms,omitempty"`
StartEntry struct {
HelpLink string `json:"helpLink"`
StartConnectLabel string `json:"startConnectLabel"`
StartCommand string `json:"startCommand"`
Priority int `json:"priority"`
} `json:"startEntry"`
}
Click to show internal directories.
Click to hide internal directories.