Take out unqualified samples

This commit is contained in:
Pine Wu
2018-10-23 22:39:45 -07:00
parent e4d1e28ca1
commit fb6514abb4
3 changed files with 25 additions and 56 deletions

View File

@ -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;

View File

@ -2,15 +2,11 @@ const fs = require('fs')
const SAMPLES = require('./samples')
const TABLE_HEAD = `
<!-- SAMPLES_BEGIN -->
const TABLE_HEAD = `<!-- SAMPLES_BEGIN -->
| Sample | Guide on VS Code Website | API & Contribution |
| ------ | ----- | --- |
`
| ------ | ----- | --- |`
const TABLE_END = `
<!-- SAMPLES_END -->
`
const TABLE_END = `<!-- SAMPLES_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')