From f718fd67dde6382fbf99de379cba71cd9facc000 Mon Sep 17 00:00:00 2001 From: Pine Wu Date: Tue, 28 May 2019 10:08:04 +0800 Subject: [PATCH] Update sample listing --- .scripts/samples.js | 65 ++++++++++++++++++++++++--------------------- README.md | 6 ++--- 2 files changed, 38 insertions(+), 33 deletions(-) diff --git a/.scripts/samples.js b/.scripts/samples.js index 05b777b1..31686616 100644 --- a/.scripts/samples.js +++ b/.scripts/samples.js @@ -122,10 +122,40 @@ const samples = [ `TextDocument` ], contributions: [] - } + }, // { description: 'webpack-sample', path: 'webpack-sample', guide: null, apis: [], contributions: [] }, + { + description: 'Source Control Sample', + path: 'source-control-sample', + guide: 'https://code.visualstudio.com/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: [] + } ] +/** LSP specific samples */ /** @type {Sample[]} */ const lspSamples = [ { @@ -163,37 +193,12 @@ const lspSamples = [ 'https://github.com/Microsoft/vscode/wiki/Extension-Authoring:-Adopting-Multi-Root-Workspace-APIs#language-client--language-server', apis: [], contributions: [] - }, - { - description: 'Source Control Sample', - path: 'source-control-sample', - guide: 'https://code.visualstudio.com/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: [] } ] +/** + * LSP specific samples + * DO NOT add non-LSP items here. Add it to `samples` list. + */ module.exports = { samples, diff --git a/README.md b/README.md index 7d257f70..979a616f 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,9 @@ You can expect from each sample: | [I18n Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/i18n-sample) | N/A | | | [Terminal Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/terminal-sample) | N/A | [window.createTerminal](https://code.visualstudio.com/api/references/vscode-api#window.createTerminal)
[window.onDidChangeActiveTerminal](https://code.visualstudio.com/api/references/vscode-api#window.onDidChangeActiveTerminal)
[window.onDidCloseTerminal](https://code.visualstudio.com/api/references/vscode-api#window.onDidCloseTerminal)
[window.onDidOpenTerminal](https://code.visualstudio.com/api/references/vscode-api#window.onDidOpenTerminal)
[window.Terminal](https://code.visualstudio.com/api/references/vscode-api#window.Terminal)
[window.terminals](https://code.visualstudio.com/api/references/vscode-api#window.terminals) | | [Vim Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/vim-sample) | N/A | [commands](https://code.visualstudio.com/api/references/vscode-api#commands)
[StatusBarItem](https://code.visualstudio.com/api/references/vscode-api#StatusBarItem)
[window.createStatusBarItem](https://code.visualstudio.com/api/references/vscode-api#window.createStatusBarItem)
[TextEditorCursorStyle](https://code.visualstudio.com/api/references/vscode-api#TextEditorCursorStyle)
[window.activeTextEditor](https://code.visualstudio.com/api/references/vscode-api#window.activeTextEditor)
[Position](https://code.visualstudio.com/api/references/vscode-api#Position)
[Range](https://code.visualstudio.com/api/references/vscode-api#Range)
[Selection](https://code.visualstudio.com/api/references/vscode-api#Selection)
[TextEditor](https://code.visualstudio.com/api/references/vscode-api#TextEditor)
[TextEditorRevealType](https://code.visualstudio.com/api/references/vscode-api#TextEditorRevealType)
[TextDocument](https://code.visualstudio.com/api/references/vscode-api#TextDocument) | +| [Source Control Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/source-control-sample) | https://code.visualstudio.com/api/extension-guides/scm-provider | [workspace.workspaceFolders](https://code.visualstudio.com/api/references/vscode-api#workspace.workspaceFolders)
[SourceControl](https://code.visualstudio.com/api/references/vscode-api#SourceControl)
[SourceControlResourceGroup](https://code.visualstudio.com/api/references/vscode-api#SourceControlResourceGroup)
[scm.createSourceControl](https://code.visualstudio.com/api/references/vscode-api#scm.createSourceControl)
[TextDocumentContentProvider](https://code.visualstudio.com/api/references/vscode-api#TextDocumentContentProvider)
[contributes.menus](https://code.visualstudio.com/api/references/contribution-points#contributes.menus) | +| [Commenting API Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/comment-sample) | N/A | | +| [Document Editing Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/document-editing-sample) | N/A | [commands](https://code.visualstudio.com/api/references/vscode-api#commands) | ### Language Protocol Server Samples @@ -52,9 +55,6 @@ You can expect from each sample: | [LSP Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/lsp-sample) | [/api/language-extensions/language-server-extension-guide](https://code.visualstudio.com/api/language-extensions/language-server-extension-guide) | | | [LSP Log Streaming Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/lsp-log-streaming-sample) | N/A | | | [LSP Multi Root Server Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/lsp-multi-server-sample) | https://github.com/Microsoft/vscode/wiki/Extension-Authoring:-Adopting-Multi-Root-Workspace-APIs#language-client--language-server | | -| [Source Control Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/source-control-sample) | https://code.visualstudio.com/api/extension-guides/scm-provider | [workspace.workspaceFolders](https://code.visualstudio.com/api/references/vscode-api#workspace.workspaceFolders)
[SourceControl](https://code.visualstudio.com/api/references/vscode-api#SourceControl)
[SourceControlResourceGroup](https://code.visualstudio.com/api/references/vscode-api#SourceControlResourceGroup)
[scm.createSourceControl](https://code.visualstudio.com/api/references/vscode-api#scm.createSourceControl)
[TextDocumentContentProvider](https://code.visualstudio.com/api/references/vscode-api#TextDocumentContentProvider)
[contributes.menus](https://code.visualstudio.com/api/references/contribution-points#contributes.menus) | -| [Commenting API Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/comment-sample) | N/A | | -| [Document Editing Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/document-editing-sample) | N/A | [commands](https://code.visualstudio.com/api/references/vscode-api#commands) | ## License