vscode-extension-samples/.scripts/samples.ts

export interface Sample {
	readonly description: string;
	readonly path: string;
	readonly guide: string | null;
	readonly apis: readonly string[];
	readonly contributions: readonly string[];
	readonly excludeFromReadme?: boolean;
}

export const samples: Sample[] = [
	{
		description: 'Webview Sample',
		path: 'webview-sample',
		guide: '/api/extension-guides/webview',
		apis: ['window.createWebviewPanel', 'window.registerWebviewPanelSerializer'],
		contributions: []
	},
	{
		description: 'Webview View Sample',
		path: 'webview-view-sample',
		guide: null,
		apis: ['window.registerWebviewViewProvider'],
		contributions: []
	},
	{
		description: 'Webview Codicons Sample',
		path: 'webview-codicons-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'Status Bar Sample',
		path: 'statusbar-sample',
		guide: null,
		apis: ['window.createStatusBarItem', 'StatusBarItem'],
		contributions: []
	},
	{
		description: 'Tree View Sample',
		path: 'tree-view-sample',
		guide: '/api/extension-guides/tree-view',
		apis: ['window.createTreeView', 'window.registerTreeDataProvider', 'TreeView', 'TreeDataProvider'],
		contributions: ['views', 'viewsContainers']
	},
	{
		description: 'Task Provider Sample',
		path: 'task-provider-sample',
		guide: '/api/extension-guides/task-provider',
		apis: ['tasks.registerTaskProvider', 'Task', 'ShellExecution'],
		contributions: ['taskDefinitions']
	},
	{
		description: 'Multi Root Sample',
		path: 'basic-multi-root-sample',
		guide: null,
		apis: ['workspace.getWorkspaceFolder', 'workspace.onDidChangeWorkspaceFolders'],
		contributions: []
	},
	{
		description: 'Completion Provider Sample',
		path: 'completions-sample',
		guide: null,
		apis: ['languages.registerCompletionItemProvider', 'CompletionItem', 'SnippetString'],
		contributions: []
	},
	{
		description: 'Code Actions Sample',
		path: 'code-actions-sample',
		guide: null,
		apis: ['languages.registerCodeActionsProvider', 'CodeActionProvider'],
		contributions: []
	},
	{
		description: 'File System Provider Sample',
		path: 'fsprovider-sample',
		guide: null,
		apis: ['workspace.registerFileSystemProvider'],
		contributions: []
	},
	{
		description: 'Editor Decorator Sample',
		path: 'decorator-sample',
		guide: null,
		apis: [
			'TextEditor.setDecorations',
			'DecorationOptions',
			'DecorationInstanceRenderOptions',
			'ThemableDecorationInstanceRenderOptions',
			'window.createTextEditorDecorationType',
			'TextEditorDecorationType'
		],
		contributions: ['colors']
	},
	{
		description: 'L10n Sample',
		path: 'l10n-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'Terminal Sample',
		path: 'terminal-sample',
		guide: null,
		apis: [
			'window.createTerminal',
			'window.onDidChangeActiveTerminal',
			'window.onDidCloseTerminal',
			'window.onDidOpenTerminal',
			'window.Terminal',
			'window.terminals'
		],
		contributions: []
	},
	{
		description: 'Extension Terminal Sample',
		path: 'extension-terminal-sample',
		guide: null,
		apis: [
			'window.createTerminal',
			'window.Pseudoterminal',
			'window.ExtensionTerminalOptions'
		],
		contributions: []
	},
	{
		description: 'Color Theme Sample',
		path: 'theme-sample',
		guide: '/api/extension-guides/color-theme',
		apis: [],
		contributions: ['themes']
	},
	{
		description: 'Product Icon Theme Sample',
		path: 'product-icon-theme-sample',
		guide: '/api/extension-guides/product-icon-theme',
		apis: [],
		contributions: ['productIconThemes']
	},
	{
		description: 'Vim Sample',
		path: 'vim-sample',
		guide: null,
		apis: [
			`commands`,
			`StatusBarItem`,
			`window.createStatusBarItem`,
			`TextEditorCursorStyle`,
			`window.activeTextEditor`,
			`Position`,
			`Range`,
			`Selection`,
			`TextEditor`,
			`TextEditorRevealType`,
			`TextDocument`
		],
		contributions: []
	},
	{
		description: 'webpack-sample',
		path: 'webpack-sample',
		guide: '/api/working-with-extensions/bundling-extension',
		apis: [],
		contributions: []
	},
	{
		description: 'esbuild-sample',
		path: 'esbuild-sample',
		guide: '/api/working-with-extensions/bundling-extension',
		apis: [],
		contributions: []
	},
	{
		description: 'Source Control Sample',
		path: 'source-control-sample',
		guide: '/api/extension-guides/scm-provider',
		apis: [
			'workspace.workspaceFolders',
			'SourceControl',
			'SourceControlResourceGroup',
			'scm.createSourceControl',
			'TextDocumentContentProvider'
		],
		contributions: ["menus"]
	},
	{
		description: 'Commenting API Sample',
		path: 'comment-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'Document Editing Sample',
		path: 'document-editing-sample',
		guide: null,
		apis: [
			`commands`
		],
		contributions: []
	},
	{
		description: 'Custom Data Sample',
		path: 'custom-data-sample',
		guide: '/api/extension-guides/custom-data-extension',
		apis: [],
		contributions: []
	},
	{
		description: 'CodeLens Provider Sample',
		path: 'codelens-sample',
		guide: null,
		apis: [`languages.registerCodeLensProvider`, `CodeLensProvider`, `CodeLens`],
		contributions: []
	},
	{
		description: 'Call Hierarchy Sample',
		path: 'call-hierarchy-sample',
		guide: null,
		apis: [`languages.registerCallHierarchyProvider`, `CallHierarchyProvider`, `CallHierarchyItem`, `CallHierarchyOutgoingCall`, `CallHierarchyIncomingCall`],
		contributions: []
	},
	{
		description: 'Custom Editors Sample',
		path: 'custom-editor-sample',
		guide: '/api/extension-guides/custom-editors',
		apis: ['window.registerCustomEditorProvider', 'CustomTextEditorProvider'],
		contributions: ["customEditors"]
	},
	{
		description: 'Semantic tokens',
		path: 'semantic-tokens-sample',
		guide: '/api/language-extensions/semantic-highlight-guide',
		apis: ['languages.registerDocumentSemanticTokensProvider', 'vscode.DocumentSemanticTokensProvider'],
		contributions: []
	},
	{
		description: 'Test Provider Sample',
		path: 'test-provider-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'Getting Started Sample',
		path: 'getting-started-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'notebook-renderer-sample',
		path: 'notebook-renderer-sample',
		guide: "/api/extension-guides/notebook#notebook-renderer",
		apis: [],
		contributions: ["notebookRenderer"]
	},
	{
		description: 'notebook-extend-markdown-renderer-sample',
		path: 'notebook-extend-markdown-renderer-sample',
		guide: "/api/extension-guides/notebook#notebook-renderer",
		apis: [],
		contributions: ["notebookRenderer"]
	},
	{
		description: 'jupyter-server-provider-sample',
		path: 'jupyter-server-provider-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'Chat Sample',
		path: 'chat-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'Chat Tutorial',
		path: 'chat-tutorial',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'Notifications Sample',
		path: 'notifications-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{ description: 'authenticationprovider-sample', excludeFromReadme: true, path: 'authenticationprovider-sample', guide: null, apis: [], contributions: [] },
	{ description: 'configuration-sample', excludeFromReadme: true, path: 'configuration-sample', guide: null, apis: [], contributions: [] },
	{ description: 'chat-model-provider-sample', excludeFromReadme: true, path: 'chat-model-provider-sample', guide: null, apis: [], contributions: [] },
	{ description: 'chat-output-renderer-sample', excludeFromReadme: true, path: 'chat-output-renderer-sample', guide: null, apis: [], contributions: [] },
	{ description: 'contentprovider-sample', excludeFromReadme: true, path: 'contentprovider-sample', guide: null, apis: [], contributions: [] },
	{ description: 'diagnostic-related-information-sample', excludeFromReadme: true, path: 'diagnostic-related-information-sample', guide: null, apis: [], contributions: [] },
	{ description: 'document-paste', excludeFromReadme: true, path: 'document-paste', guide: null, apis: [], contributions: [] },
	{ description: 'drop-on-document', excludeFromReadme: true, path: 'drop-on-document', guide: null, apis: [], contributions: [] },
	{ description: 'fsconsumer-sample', excludeFromReadme: true, path: 'fsconsumer-sample', guide: null, apis: [], contributions: [] },
	{ description: 'github-authentication-sample', excludeFromReadme: true, path: 'github-authentication-sample', guide: null, apis: [], contributions: [] },
	{ description: 'helloworld-minimal-sample', excludeFromReadme: true, path: 'helloworld-minimal-sample', guide: null, apis: [], contributions: [] },
	{ description: 'helloworld-sample', excludeFromReadme: true, path: 'helloworld-sample', guide: null, apis: [], contributions: [] },
	{ description: 'helloworld-test-cli-sample', excludeFromReadme: true, path: 'helloworld-test-cli-sample', guide: null, apis: [], contributions: [] },
	{ description: 'helloworld-test-sample', excludeFromReadme: true, path: 'helloworld-test-sample', guide: null, apis: [], contributions: [] },
	{ description: 'helloworld-web-sample', excludeFromReadme: true, path: 'helloworld-web-sample', guide: null, apis: [], contributions: [] },
	{ description: 'inline-completions', excludeFromReadme: true, path: 'inline-completions', guide: null, apis: [], contributions: [] },
	{ description: 'jupyter-kernel-execution-sample', excludeFromReadme: true, path: 'jupyter-kernel-execution-sample', guide: null, apis: [], contributions: [] },
	{ description: 'lm-api-tutorial', excludeFromReadme: true, path: 'lm-api-tutorial', guide: null, apis: [], contributions: [] },
	{ description: 'mcp-extension-sample', excludeFromReadme: true, path: 'mcp-extension-sample', guide: null, apis: [], contributions: [] },
	{ description: 'nodefs-provider-sample', excludeFromReadme: true, path: 'nodefs-provider-sample', guide: null, apis: [], contributions: [] },
	{ description: 'notebook-format-code-action-sample', excludeFromReadme: true, path: 'notebook-format-code-action-sample', guide: null, apis: [], contributions: [] },
	{ description: 'notebook-renderer-react-sample', excludeFromReadme: true, path: 'notebook-renderer-react-sample', guide: null, apis: [], contributions: [] },
	{ description: 'notebook-serializer-sample', excludeFromReadme: true, path: 'notebook-serializer-sample', guide: null, apis: [], contributions: [] },
	{ description: 'progress-sample', excludeFromReadme: true, path: 'progress-sample', guide: null, apis: [], contributions: [] },
	{ description: 'proposed-api-sample', excludeFromReadme: true, path: 'proposed-api-sample', guide: null, apis: [], contributions: [] },
	{ description: 'quickinput-sample', excludeFromReadme: true, path: 'quickinput-sample', guide: null, apis: [], contributions: [] },
	{ description: 'shell-integration-sample', excludeFromReadme: true, path: 'shell-integration-sample', guide: null, apis: [], contributions: [] },
	{ description: 'tabs-api-sample', excludeFromReadme: true, path: 'tabs-api-sample', guide: null, apis: [], contributions: [] },
	{ description: 'telemetry-sample', excludeFromReadme: true, path: 'telemetry-sample', guide: null, apis: [], contributions: [] },
	{ description: 'uri-handler-sample', excludeFromReadme: true, path: 'uri-handler-sample', guide: null, apis: [], contributions: [] },
	{ description: 'virtual-document-sample', excludeFromReadme: true, path: 'virtual-document-sample', guide: null, apis: [], contributions: [] },
	{ description: 'wasm-component-model-async', excludeFromReadme: true, path: 'wasm-component-model-async', guide: null, apis: [], contributions: [] },
	{ description: 'wasm-component-model-resource', excludeFromReadme: true, path: 'wasm-component-model-resource', guide: null, apis: [], contributions: [] },
	{ description: 'wasm-component-model', excludeFromReadme: true, path: 'wasm-component-model', guide: null, apis: [], contributions: [] },
	{ description: 'welcome-view-content-sample', excludeFromReadme: true, path: 'welcome-view-content-sample', guide: null, apis: [], contributions: [] },
	{ description: 'chat-context-sample', excludeFromReadme: true, path: 'chat-context-sample', guide: null, apis: ['chatContextProvider'], contributions: [] },
]

/**
 * LSP specific samples
 * DO NOT add non-LSP items here. Add it to {@link samples} list.
 */
export const lspSamples: Sample[] = [
	{
		description: 'Snippet Sample',
		path: 'snippet-sample',
		guide: '/api/language-extensions/snippet-guide',
		apis: [],
		contributions: ['snippets']
	},
	{
		description: 'Language Configuration Sample',
		path: 'language-configuration-sample',
		guide: '/api/language-extensions/language-configuration-guide',
		apis: [],
		contributions: ['languages']
	},
	{
		description: 'LSP Sample',
		path: 'lsp-sample',
		guide: '/api/language-extensions/language-server-extension-guide',
		apis: [],
		contributions: []
	},
	{
		description: 'LSP Log Streaming Sample',
		path: 'lsp-log-streaming-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'LSP Multi Root Server Sample',
		path: 'lsp-multi-server-sample',
		guide:
			'https://github.com/Microsoft/vscode/wiki/Extension-Authoring:-Adopting-Multi-Root-Workspace-APIs#language-client--language-server',
		apis: [],
		contributions: []
	},
	{
		description: 'LSP Web Extension Sample',
		path: 'lsp-web-extension-sample',
		guide: '/api/language-extensions/language-server-extension-guide',
		apis: [],
		contributions: []
	},
	{
		description: 'LSP User Input Sample',
		path: 'lsp-user-input-sample',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'LSP Embedded Language Service',
		path: 'lsp-embedded-language-service',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'LSP Embedded Request Forwarding',
		path: 'lsp-embedded-request-forwarding',
		guide: null,
		apis: [],
		contributions: []
	},
	{
		description: 'Wasm language server',
		path: 'wasm-language-server',
		guide: null,
		apis: [],
		contributions: []
	},
];