From fb6514abb485828ccb75d921bd0eb321f809adea Mon Sep 17 00:00:00 2001 From: Pine Wu Date: Tue, 23 Oct 2018 22:39:45 -0700 Subject: [PATCH] Take out unqualified samples --- .scripts/samples.js | 41 +++++++++++++++++++-------------------- .scripts/update-readme.js | 16 +++++---------- README.md | 24 ----------------------- 3 files changed, 25 insertions(+), 56 deletions(-) diff --git a/.scripts/samples.js b/.scripts/samples.js index 5ec8ac66..f77635fb 100644 --- a/.scripts/samples.js +++ b/.scripts/samples.js @@ -33,16 +33,15 @@ const samples = [ contributions: [] }, { description: 'File System Provider Sample', path: 'fsprovider-sample', guide: null, apis: ['workspace.registerFileSystemProvider'], contributions: [] }, - // TODO: Fix your sample and move it to above - { description: 'completions-sample', path: 'completions-sample', guide: null, apis: [], contributions: [] }, - { description: 'configuration-sample', path: 'configuration-sample', guide: null, apis: [], contributions: [] }, - { description: 'contentprovider-sample', path: 'contentprovider-sample', guide: null, apis: [], contributions: [] }, - { description: 'decorator-sample', path: 'decorator-sample', guide: null, apis: [], contributions: [] }, - { description: 'extension-deps-sample', path: 'extension-deps-sample', guide: null, apis: [], contributions: [] }, - { description: 'hellocode-minimal-sample', path: 'hellocode-minimal-sample', guide: null, apis: [], contributions: [] }, - { description: 'hellocode-sample', path: 'hellocode-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: 'completions-sample', path: 'completions-sample', guide: null, apis: [], contributions: [] }, + // { description: 'configuration-sample', path: 'configuration-sample', guide: null, apis: [], contributions: [] }, + // { description: 'contentprovider-sample', path: 'contentprovider-sample', guide: null, apis: [], contributions: [] }, + // { description: 'decorator-sample', path: 'decorator-sample', guide: null, apis: [], contributions: [] }, + // { description: 'extension-deps-sample', path: 'extension-deps-sample', guide: null, apis: [], contributions: [] }, + // { description: 'hellocode-minimal-sample', path: 'hellocode-minimal-sample', guide: null, apis: [], contributions: [] }, + // { description: 'hellocode-sample', path: 'hellocode-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: 'LSP Log Streaming Sample', path: 'lsp-log-streaming-sample', @@ -64,17 +63,17 @@ const samples = [ 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: null, apis: [], contributions: [] }, - { description: 'terminal-sample', path: 'terminal-sample', guide: null, apis: [], contributions: [] }, - { description: 'theme-sample', path: 'theme-sample', guide: null, apis: [], contributions: [] }, - { description: 'tree-view-sample', path: 'tree-view-sample', guide: null, apis: [], contributions: [] }, - { description: 'vim-sample', path: 'vim-sample', guide: null, apis: [], contributions: [] }, - { description: 'webpack-sample', path: 'webpack-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: 'task-provider-sample', path: 'task-provider-sample', guide: null, apis: [], contributions: [] }, + // { description: 'terminal-sample', path: 'terminal-sample', guide: null, apis: [], contributions: [] }, + // { description: 'theme-sample', path: 'theme-sample', guide: null, apis: [], contributions: [] }, + // { description: 'tree-view-sample', path: 'tree-view-sample', guide: null, apis: [], contributions: [] }, + // { description: 'vim-sample', path: 'vim-sample', guide: null, apis: [], contributions: [] }, + // { description: 'webpack-sample', path: 'webpack-sample', guide: null, apis: [], contributions: [] }, ]; module.exports = samples; diff --git a/.scripts/update-readme.js b/.scripts/update-readme.js index fb5e5545..c9a59a35 100644 --- a/.scripts/update-readme.js +++ b/.scripts/update-readme.js @@ -2,15 +2,11 @@ const fs = require('fs') const SAMPLES = require('./samples') -const TABLE_HEAD = ` - +const TABLE_HEAD = ` | Sample | Guide on VS Code Website | API & Contribution | -| ------ | ----- | --- | -` +| ------ | ----- | --- |` -const TABLE_END = ` - -` +const TABLE_END = `` const getTableRow = sample => { const descriptionCell = `[${sample.description}](${sample.path})` @@ -37,11 +33,9 @@ const getTableRow = sample => { const getSamplesTable = samples => { const samplesMd = samples.map(s => getTableRow(s)).join('\n') - return ` -${TABLE_HEAD.trim()} + return `${TABLE_HEAD.trim()} ${samplesMd} -${TABLE_END.trim()} -` +${TABLE_END.trim()}` } const readme = fs.readFileSync('README.md', 'utf-8') diff --git a/README.md b/README.md index decefcfe..c4d12ee6 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,6 @@ You can expect from each sample: ## Samples - - | Sample | Guide on VS Code Website | API & Contribution | | ------ | ----- | --- | @@ -22,33 +20,11 @@ You can expect from each sample: | [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)
[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) | | [File System Provider Sample](fsprovider-sample) | N/A | [workspace.registerFileSystemProvider](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#workspace.registerFileSystemProvider) | -| [completions-sample](completions-sample) | N/A | | -| [configuration-sample](configuration-sample) | N/A | | -| [contentprovider-sample](contentprovider-sample) | N/A | | -| [decorator-sample](decorator-sample) | N/A | | -| [extension-deps-sample](extension-deps-sample) | N/A | | -| [hellocode-minimal-sample](hellocode-minimal-sample) | N/A | | -| [hellocode-sample](hellocode-sample) | N/A | | -| [i18n-sample](i18n-sample) | N/A | | -| [legacy-samples](legacy-samples) | N/A | | | [LSP Log Streaming Sample](lsp-log-streaming-sample) | N/A | | | [LSP Multi Root Server Sample](lsp-multi-server-sample) | https://github.com/Microsoft/vscode/wiki/Extension-Authoring:-Adopting-Multi-Root-Workspace-APIs#language-client--language-server | | | [LSP Sample](lsp-sample) | [/api/language-extensions/smart-editing-lsp-guide](https://vscode-ext-docs.azurewebsites.net/api/language-extensions/smart-editing-lsp-guide) | | -| [multi-diagnostics-sample](multi-diagnostics-sample) | N/A | | -| [nodefs-provider-sample](nodefs-provider-sample) | N/A | | -| [progress-sample](progress-sample) | N/A | | -| [quickinput-sample](quickinput-sample) | N/A | | -| [smart-template-strings-sample](smart-template-strings-sample) | N/A | | -| [task-provider-sample](task-provider-sample) | N/A | | -| [terminal-sample](terminal-sample) | N/A | | -| [theme-sample](theme-sample) | N/A | | -| [tree-view-sample](tree-view-sample) | N/A | | -| [vim-sample](vim-sample) | N/A | | -| [webpack-sample](webpack-sample) | N/A | | - - ## :warning: Legacy Samples :warning: Legacy samples are at [`/legacy-samples`](/legacy-samples). They are unlikely to receive any updates and might not work with the latest version of VS Code.