Update samples listing

2026-04-27 16:55:44 +08:00 · 2018-11-26 12:58:46 -08:00
parent 97f49bd82a
commit 9d8a25c625
2 changed files with 158 additions and 131 deletions
--- a/.scripts/samples.js
+++ b/.scripts/samples.js
@ -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
 }
--- a/README.md
+++ b/README.md
@ -30,16 +30,16 @@ You can expect from each sample:
 <!-- SAMPLES_BEGIN -->
 | Sample | Guide on VS Code Website | API & Contribution |
 | ------ | ----- | --- |
-| [Multi Root Sample](basic-multi-root-sample) | N/A | [workspace.getWorkspaceFolder](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#workspace.getWorkspaceFolder)<br>[workspace.onDidChangeWorkspaceFolders](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#workspace.onDidChangeWorkspaceFolders) |
 | [Webview Sample](webview-sample) | [/api/extension-guides/webview](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/webview) | [window.createWebviewPanel](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createWebviewPanel)<br>[window.registerWebviewPanelSerializer](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.registerWebviewPanelSerializer) |
-| [Status Bar](statusbar-sample) | [/api/extension-guides/status-bar](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/status-bar) | [StatusBarItem](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#StatusBarItem) |
+| [Status Bar Sample](statusbar-sample) | [/api/extension-guides/status-bar](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/status-bar) | [window.createStatusBarItem](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createStatusBarItem)<br>[StatusBarItem](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#StatusBarItem) |
+| [Tree View Sample](tree-view-sample) | [/api/extension-guides/tree-view](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/tree-view) | [window.createTreeView](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createTreeView)<br>[window.registerTreeDataProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.registerTreeDataProvider)<br>[TreeView](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TreeView)<br>[TreeDataProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TreeDataProvider)<br>[contributes.views](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.views)<br>[contributes.viewsContainers](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.viewsContainers) |
+| [Task Provider Sample](task-provider-sample) | [/api/extension-guides/task-provider](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/task-provider) | [tasks.registerTaskProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#tasks.registerTaskProvider)<br>[Task](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#Task)<br>[ShellExecution](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#ShellExecution)<br>[contributes.taskDefinitions](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.taskDefinitions) |
+| [Multi Root Sample](basic-multi-root-sample) | N/A | [workspace.getWorkspaceFolder](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#workspace.getWorkspaceFolder)<br>[workspace.onDidChangeWorkspaceFolders](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#workspace.onDidChangeWorkspaceFolders) |
 | [Completion Provider Sample](completions-sample) | N/A | [languages.registerCompletionItemProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#languages.registerCompletionItemProvider)<br>[CompletionItem](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#CompletionItem)<br>[SnippetString](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#SnippetString) |
 | [File System Provider Sample](fsprovider-sample) | N/A | [workspace.registerFileSystemProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#workspace.registerFileSystemProvider) |
-| [Editor Decorator Sample](decorator-sample) | N/A | [TextEditor.setDecorations](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditor.setDecorations)<br>[DecorationOptions](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#DecorationOptions)<br>[DecorationInstanceRenderOptions](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#DecorationInstanceRenderOptions)<br>[ThemableDecorationInstanceRenderOptions](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#ThemableDecorationInstanceRenderOptions)<br>[window.createTextEditorDecorationType](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createTextEditorDecorationType)<br>[TextEditorDecorationType](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditorDecorationType)<br>[contributes.colors](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.colors) |
+| [Editor Decoractor Sample](decorator-sample) | N/A | [TextEditor.setDecorations](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditor.setDecorations)<br>[DecorationOptions](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#DecorationOptions)<br>[DecorationInstanceRenderOptions](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#DecorationInstanceRenderOptions)<br>[ThemableDecorationInstanceRenderOptions](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#ThemableDecorationInstanceRenderOptions)<br>[window.createTextEditorDecorationType](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createTextEditorDecorationType)<br>[TextEditorDecorationType](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditorDecorationType)<br>[contributes.colors](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.colors) |
 | [I18n Sample](i18n-sample) | N/A |  |
-| [Task Provider Sample](task-provider-sample) | [/api/extension-guides/task-provider](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/task-provider) | [tasks.registerTaskProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#tasks.registerTaskProvider)<br>[Task](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#Task)<br>[ShellExecution](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#ShellExecution)<br>[contributes.taskDefinitions](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.taskDefinitions) |
 | [Terminal Sample](terminal-sample) | N/A | [window.createTerminal](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createTerminal)<br>[window.onDidChangeActiveTerminal](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.onDidChangeActiveTerminal)<br>[window.onDidCloseTerminal](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.onDidCloseTerminal)<br>[window.onDidOpenTerminal](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.onDidOpenTerminal)<br>[window.Terminal](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.Terminal)<br>[window.terminals](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.terminals) |
-| [Tree View Sample](tree-view-sample) | [/api/extension-guides/tree-view](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/tree-view) | [window.createTreeView](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createTreeView)<br>[window.registerTreeDataProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.registerTreeDataProvider)<br>[TreeView](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TreeView)<br>[TreeDataProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TreeDataProvider)<br>[contributes.views](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.views)<br>[contributes.viewsContainers](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.viewsContainers) |
 | [Vim Sample](vim-sample) | N/A | [commands](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#commands)<br>[StatusBarItem](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#StatusBarItem)<br>[window.createStatusBarItem](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createStatusBarItem)<br>[TextEditorCursorStyle](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditorCursorStyle)<br>[window.activeTextEditor](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.activeTextEditor)<br>[Position](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#Position)<br>[Range](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#Range)<br>[Selection](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#Selection)<br>[TextEditor](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditor)<br>[TextEditorRevealType](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditorRevealType)<br>[TextDocument](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextDocument) |
 <!-- SAMPLES_END -->