From a5278f14c12e2803361c8d24d3d8dd29fded79fe Mon Sep 17 00:00:00 2001 From: Pine Wu Date: Mon, 29 Oct 2018 11:56:14 -0700 Subject: [PATCH] Update table listing generation --- .scripts/samples.js | 6 +++--- .scripts/update-readme.js | 2 +- README.md | 5 ++++- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.scripts/samples.js b/.scripts/samples.js index 150cba2c..abdc473a 100644 --- a/.scripts/samples.js +++ b/.scripts/samples.js @@ -52,7 +52,7 @@ const samples = [{ path: 'decorator-sample', guide: null, apis: ['TextEditor.setDecorations', 'DecorationOptions', 'DecorationInstanceRenderOptions', 'ThemableDecorationInstanceRenderOptions', 'window.createTextEditorDecorationType', 'TextEditorDecorationType'], - contributions: [ 'colors'] + contributions: ['colors'] }, // { description: 'extension-deps-sample', path: 'extension-deps-sample', guide: null, apis: [], contributions: [] }, // { description: 'hellocode-minimal-sample', path: 'hellocode-minimal-sample', guide: null, apis: [], contributions: [] }, @@ -71,9 +71,9 @@ const samples = [{ // { 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: 'Contribute Tasks via an Extension', + description: 'Task Provider Sample', path: 'task-provider-sample', - guide: '/api/extension-guides/api-tasks', + guide: '/api/extension-guides/task-provider', apis: ['tasks.registerTaskProvider', 'Task', 'ShellExecution'], contributions: ['taskDefinitions'] }, diff --git a/.scripts/update-readme.js b/.scripts/update-readme.js index b3b687a6..ba88ec18 100644 --- a/.scripts/update-readme.js +++ b/.scripts/update-readme.js @@ -26,7 +26,7 @@ const getTableRow = sample => { return `[${api}](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#${api})` }) const contributions = sample.contributions.map(c => { - return `[${c}](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#${c})` + return `[contributes.${c}](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.${c})` }) const apiAndContributionCell = apis.concat(contributions).join('
') diff --git a/README.md b/README.md index f1e99684..ce83b199 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,11 @@ You can expect from each sample: | [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) | | [completions-sample](completions-sample) | N/A | [languages.registerCompletionItemProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#languages.registerCompletionItemProvider)
[CompletionItem](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#CompletionItem)
[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) | +| [decorator-sample](decorator-sample) | N/A | [TextEditor.setDecorations](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditor.setDecorations)
[DecorationOptions](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#DecorationOptions)
[DecorationInstanceRenderOptions](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#DecorationInstanceRenderOptions)
[ThemableDecorationInstanceRenderOptions](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#ThemableDecorationInstanceRenderOptions)
[window.createTextEditorDecorationType](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createTextEditorDecorationType)
[TextEditorDecorationType](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditorDecorationType)
[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)
[Task](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#Task)
[ShellExecution](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#ShellExecution)
[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)
[window.onDidChangeActiveTerminal](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.onDidChangeActiveTerminal)
[window.onDidCloseTerminal](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.onDidCloseTerminal)
[window.onDidOpenTerminal](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.onDidOpenTerminal)
[window.Terminal](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.Terminal)
[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)
[window.registerTreeDataProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.registerTreeDataProvider)
[TreeView](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TreeView)
[TreeDataProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TreeDataProvider)
[views](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#views)
[viewsContainers](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#viewsContainers) | +| [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)
[window.registerTreeDataProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.registerTreeDataProvider)
[TreeView](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TreeView)
[TreeDataProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TreeDataProvider)
[contributes.views](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.views)
[contributes.viewsContainers](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.viewsContainers) | ### Language Protocol Server Samples