mirror of
https://github.com/microsoft/vscode-extension-samples.git
synced 2026-04-27 16:55:44 +08:00
Update samples listing
This commit is contained in:
@ -10,136 +10,163 @@
|
||||
*/
|
||||
|
||||
/** @type {Sample[]} */
|
||||
const samples = [{
|
||||
description: 'Multi Root Sample',
|
||||
path: 'basic-multi-root-sample',
|
||||
guide: null,
|
||||
apis: ['workspace.getWorkspaceFolder', 'workspace.onDidChangeWorkspaceFolders'],
|
||||
contributions: []
|
||||
},
|
||||
{
|
||||
description: 'Webview Sample',
|
||||
path: 'webview-sample',
|
||||
guide: '/api/extension-guides/webview',
|
||||
apis: ['window.createWebviewPanel', 'window.registerWebviewPanelSerializer'],
|
||||
contributions: []
|
||||
},
|
||||
{
|
||||
description: 'Status Bar',
|
||||
path: 'statusbar-sample',
|
||||
guide: '/api/extension-guides/status-bar',
|
||||
apis: ['window.createStatusBarItem', 'StatusBarItem'],
|
||||
contributions: []
|
||||
},
|
||||
{
|
||||
description: 'Completion Provider Sample',
|
||||
path: 'completions-sample',
|
||||
guide: null,
|
||||
apis: ['languages.registerCompletionItemProvider', 'CompletionItem', 'SnippetString'],
|
||||
contributions: []
|
||||
},
|
||||
{
|
||||
description: 'File System Provider Sample',
|
||||
path: 'fsprovider-sample',
|
||||
guide: null,
|
||||
apis: ['workspace.registerFileSystemProvider'],
|
||||
contributions: []
|
||||
},
|
||||
// { description: 'configuration-sample', path: 'configuration-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'contentprovider-sample', path: 'contentprovider-sample', guide: null, apis: [], contributions: [] },
|
||||
{
|
||||
description: 'Editor Decoractor Sample',
|
||||
path: 'decorator-sample',
|
||||
guide: null,
|
||||
apis: ['TextEditor.setDecorations', 'DecorationOptions', 'DecorationInstanceRenderOptions', 'ThemableDecorationInstanceRenderOptions', 'window.createTextEditorDecorationType', 'TextEditorDecorationType'],
|
||||
contributions: ['colors']
|
||||
},
|
||||
// { description: 'extension-deps-sample', path: 'extension-deps-sample', guide: null, apis: [], contributions: [] },
|
||||
{
|
||||
description: 'I18n Sample',
|
||||
path: 'i18n-sample',
|
||||
guide: null,
|
||||
apis: [],
|
||||
contributions: []
|
||||
},
|
||||
// { description: 'legacy-samples', path: 'legacy-samples', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'multi-diagnostics-sample', path: 'multi-diagnostics-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'nodefs-provider-sample', path: 'nodefs-provider-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'progress-sample', path: 'progress-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'quickinput-sample', path: 'quickinput-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'smart-template-strings-sample', path: 'smart-template-strings-sample', guide: null, apis: [], contributions: [] },
|
||||
{
|
||||
description: 'Task Provider Sample',
|
||||
path: 'task-provider-sample',
|
||||
guide: '/api/extension-guides/task-provider',
|
||||
apis: ['tasks.registerTaskProvider', 'Task', 'ShellExecution'],
|
||||
contributions: ['taskDefinitions']
|
||||
},
|
||||
{
|
||||
description: 'Terminal Sample',
|
||||
path: 'terminal-sample',
|
||||
guide: null,
|
||||
apis: ['window.createTerminal', 'window.onDidChangeActiveTerminal', 'window.onDidCloseTerminal', 'window.onDidOpenTerminal', 'window.Terminal', 'window.terminals'],
|
||||
contributions: []
|
||||
},
|
||||
// { description: 'theme-sample', path: 'theme-sample', guide: null, apis: [], 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: '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: null, apis: [], contributions: [] },
|
||||
];
|
||||
const samples = [
|
||||
{
|
||||
description: 'Webview Sample',
|
||||
path: 'webview-sample',
|
||||
guide: '/api/extension-guides/webview',
|
||||
apis: ['window.createWebviewPanel', 'window.registerWebviewPanelSerializer'],
|
||||
contributions: []
|
||||
},
|
||||
{
|
||||
description: 'Status Bar Sample',
|
||||
path: 'statusbar-sample',
|
||||
guide: '/api/extension-guides/status-bar',
|
||||
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: 'File System Provider Sample',
|
||||
path: 'fsprovider-sample',
|
||||
guide: null,
|
||||
apis: ['workspace.registerFileSystemProvider'],
|
||||
contributions: []
|
||||
},
|
||||
// { description: 'configuration-sample', path: 'configuration-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'contentprovider-sample', path: 'contentprovider-sample', guide: null, apis: [], contributions: [] },
|
||||
{
|
||||
description: 'Editor Decoractor Sample',
|
||||
path: 'decorator-sample',
|
||||
guide: null,
|
||||
apis: [
|
||||
'TextEditor.setDecorations',
|
||||
'DecorationOptions',
|
||||
'DecorationInstanceRenderOptions',
|
||||
'ThemableDecorationInstanceRenderOptions',
|
||||
'window.createTextEditorDecorationType',
|
||||
'TextEditorDecorationType'
|
||||
],
|
||||
contributions: ['colors']
|
||||
},
|
||||
// { description: 'extension-deps-sample', path: 'extension-deps-sample', guide: null, apis: [], contributions: [] },
|
||||
{
|
||||
description: 'I18n Sample',
|
||||
path: 'i18n-sample',
|
||||
guide: null,
|
||||
apis: [],
|
||||
contributions: []
|
||||
},
|
||||
// { description: 'multi-diagnostics-sample', path: 'multi-diagnostics-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'nodefs-provider-sample', path: 'nodefs-provider-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'progress-sample', path: 'progress-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'quickinput-sample', path: 'quickinput-sample', guide: null, apis: [], contributions: [] },
|
||||
// { description: 'smart-template-strings-sample', path: 'smart-template-strings-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: 'theme-sample', path: 'theme-sample', guide: null, apis: [], contributions: [] },
|
||||
{
|
||||
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: null, apis: [], contributions: [] },
|
||||
]
|
||||
|
||||
/** @type {Sample[]} */
|
||||
const lspSamples = [
|
||||
{
|
||||
description: 'LSP Sample',
|
||||
path: 'lsp-sample',
|
||||
guide: '/api/language-extensions/smart-editing-lsp-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: 'Language Configuration Sample',
|
||||
path: 'language-configuration-sample',
|
||||
guide: '/api/language-extensions/language-configuration-guide',
|
||||
apis: [],
|
||||
contributions: ['languages']
|
||||
},
|
||||
{
|
||||
description: 'Snippet Sample',
|
||||
path: 'snippet-sample',
|
||||
guide: '/api/language-extensions/snippet-guide',
|
||||
apis: [],
|
||||
contributions: ['snippets']
|
||||
},
|
||||
{
|
||||
description: 'LSP Sample',
|
||||
path: 'lsp-sample',
|
||||
guide: '/api/language-extensions/smart-editing-lsp-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: 'Language Configuration Sample',
|
||||
path: 'language-configuration-sample',
|
||||
guide: '/api/language-extensions/language-configuration-guide',
|
||||
apis: [],
|
||||
contributions: ['languages']
|
||||
},
|
||||
{
|
||||
description: 'Snippet Sample',
|
||||
path: 'snippet-sample',
|
||||
guide: '/api/language-extensions/snippet-guide',
|
||||
apis: [],
|
||||
contributions: ['snippets']
|
||||
}
|
||||
]
|
||||
|
||||
module.exports = {
|
||||
samples,
|
||||
lspSamples
|
||||
samples,
|
||||
lspSamples
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user