From a7420d7d1a3e038d30dd213ba4d7c62230bc4801 Mon Sep 17 00:00:00 2001 From: Pine Wu Date: Sun, 16 Dec 2018 21:08:20 -0800 Subject: [PATCH 1/5] Update all links for Microsoft/vscode-docs#2165 --- .github/SAMPLE_GUIDELINE.md | 2 +- .scripts/update-readme.js | 4 +-- README.md | 30 ++++++++++----------- completions-sample/README.md | 2 +- contentprovider-sample/README.md | 4 +-- contentprovider-sample/src/provider.ts | 2 +- decorator-sample/USAGE.md | 10 +++---- extension-samples-quickstart.md | 18 ------------- helloworld-minimal-sample/README.md | 6 ++--- helloworld-sample/README.md | 8 +++--- i18n-sample/README.md | 2 +- index.js | 26 ------------------ language-configuration-sample/README.md | 4 +-- legacy-samples/previewhtml-sample/README.md | 6 ++--- lsp-sample/README.md | 2 +- progress-sample/README.md | 2 +- quickinput-sample/README.md | 2 +- snippet-sample/README.md | 4 +-- statusbar-sample/README.md | 2 +- task-provider-sample/README.md | 6 ++--- terminal-sample/README.md | 14 +++++----- theme-sample/README.md | 6 ++--- tree-view-sample/USAGE.md | 10 +++---- virtual-document-sample/README.md | 6 ++--- webview-sample/README.md | 6 ++--- 25 files changed, 70 insertions(+), 114 deletions(-) delete mode 100644 extension-samples-quickstart.md delete mode 100644 index.js diff --git a/.github/SAMPLE_GUIDELINE.md b/.github/SAMPLE_GUIDELINE.md index 08e867dd..91c4cf6d 100644 --- a/.github/SAMPLE_GUIDELINE.md +++ b/.github/SAMPLE_GUIDELINE.md @@ -5,7 +5,7 @@ The quickest way is to start your project by copying [.base-sample](https://gith ## 1: Sample Listing -- 1.1: Each sample should add itself to the sample listing at `.scripts/samples.js`. This file will be used for generating tables in the README and on the [Extension Guides / Overview](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/overview) topic of the website. +- 1.1: Each sample should add itself to the sample listing at `.scripts/samples.js`. This file will be used for generating tables in the README and on the [Extension Guides / Overview](https://code.visualstudio.com/api/extension-guides/overview) topic of the website. - 1.2: Each sample should list the API / Contribution that it means to illustrate. ## 2: README diff --git a/.scripts/update-readme.js b/.scripts/update-readme.js index ba88ec18..05bda870 100644 --- a/.scripts/update-readme.js +++ b/.scripts/update-readme.js @@ -23,10 +23,10 @@ const getTableRow = sample => { } const apis = sample.apis.map(api => { - return `[${api}](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#${api})` + return `[${api}](https://code.visualstudio.com/api/references/vscode-api#${api})` }) const contributions = sample.contributions.map(c => { - return `[contributes.${c}](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.${c})` + return `[contributes.${c}](https://code.visualstudio.com/api/references/contribution-points#contributes.${c})` }) const apiAndContributionCell = apis.concat(contributions).join('
') diff --git a/README.md b/README.md index 89efb85b..23a2a842 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ VS Code Extension Samples -This repository contains sample code illustrating the VS Code extension API. Each sample is a self-contained extension that explains one topic in [VS Code API](https://code.visualstudio.com/docs/extensionAPI/vscode-api) or VS Code's [Contribution Points](https://code.visualstudio.com/docs/extensionAPI/extension-points). You can read, play with or adapt from these samples to create your own extensions. +This repository contains sample code illustrating the VS Code extension API. Each sample is a self-contained extension that explains one topic in [VS Code API](https://code.visualstudio.com/api/references/vscode-api) or VS Code's [Contribution Points](https://code.visualstudio.com/api/references/contribution-points). You can read, play with or adapt from these samples to create your own extensions. You can expect from each sample: - An explanation of its functionality @@ -25,22 +25,22 @@ You can expect from each sample: ## Samples -**:construction: Some links point to our work-in-progress [API Extension](https://vscode-ext-docs.azurewebsites.net/api) documentation that is not yet published :construction:** +**:construction: Some links point to our work-in-progress [API Extension](https://code.visualstudio.com/api) documentation that is not yet published :construction:** | Sample | Guide on VS Code Website | API & Contribution | | ------ | ----- | --- | -| [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 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)
[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)
[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) | -| [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) | -| [Multi Root Sample](basic-multi-root-sample) | N/A | [workspace.getWorkspaceFolder](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#workspace.getWorkspaceFolder)
[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)
[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) | -| [Editor Decoractor 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) | +| [Webview Sample](webview-sample) | [/api/extension-guides/webview](https://code.visualstudio.com/api/extension-guides/webview) | [window.createWebviewPanel](https://code.visualstudio.com/api/references/vscode-api#window.createWebviewPanel)
[window.registerWebviewPanelSerializer](https://code.visualstudio.com/api/references/vscode-api#window.registerWebviewPanelSerializer) | +| [Status Bar Sample](statusbar-sample) | [/api/extension-guides/status-bar](https://code.visualstudio.com/api/extension-guides/status-bar) | [window.createStatusBarItem](https://code.visualstudio.com/api/references/vscode-api#window.createStatusBarItem)
[StatusBarItem](https://code.visualstudio.com/api/references/vscode-api#StatusBarItem) | +| [Tree View Sample](tree-view-sample) | [/api/extension-guides/tree-view](https://code.visualstudio.com/api/extension-guides/tree-view) | [window.createTreeView](https://code.visualstudio.com/api/references/vscode-api#window.createTreeView)
[window.registerTreeDataProvider](https://code.visualstudio.com/api/references/vscode-api#window.registerTreeDataProvider)
[TreeView](https://code.visualstudio.com/api/references/vscode-api#TreeView)
[TreeDataProvider](https://code.visualstudio.com/api/references/vscode-api#TreeDataProvider)
[contributes.views](https://code.visualstudio.com/api/references/contribution-points#contributes.views)
[contributes.viewsContainers](https://code.visualstudio.com/api/references/contribution-points#contributes.viewsContainers) | +| [Task Provider Sample](task-provider-sample) | [/api/extension-guides/task-provider](https://code.visualstudio.com/api/extension-guides/task-provider) | [tasks.registerTaskProvider](https://code.visualstudio.com/api/references/vscode-api#tasks.registerTaskProvider)
[Task](https://code.visualstudio.com/api/references/vscode-api#Task)
[ShellExecution](https://code.visualstudio.com/api/references/vscode-api#ShellExecution)
[contributes.taskDefinitions](https://code.visualstudio.com/api/references/contribution-points#contributes.taskDefinitions) | +| [Multi Root Sample](basic-multi-root-sample) | N/A | [workspace.getWorkspaceFolder](https://code.visualstudio.com/api/references/vscode-api#workspace.getWorkspaceFolder)
[workspace.onDidChangeWorkspaceFolders](https://code.visualstudio.com/api/references/vscode-api#workspace.onDidChangeWorkspaceFolders) | +| [Completion Provider Sample](completions-sample) | N/A | [languages.registerCompletionItemProvider](https://code.visualstudio.com/api/references/vscode-api#languages.registerCompletionItemProvider)
[CompletionItem](https://code.visualstudio.com/api/references/vscode-api#CompletionItem)
[SnippetString](https://code.visualstudio.com/api/references/vscode-api#SnippetString) | +| [File System Provider Sample](fsprovider-sample) | N/A | [workspace.registerFileSystemProvider](https://code.visualstudio.com/api/references/vscode-api#workspace.registerFileSystemProvider) | +| [Editor Decoractor Sample](decorator-sample) | N/A | [TextEditor.setDecorations](https://code.visualstudio.com/api/references/vscode-api#TextEditor.setDecorations)
[DecorationOptions](https://code.visualstudio.com/api/references/vscode-api#DecorationOptions)
[DecorationInstanceRenderOptions](https://code.visualstudio.com/api/references/vscode-api#DecorationInstanceRenderOptions)
[ThemableDecorationInstanceRenderOptions](https://code.visualstudio.com/api/references/vscode-api#ThemableDecorationInstanceRenderOptions)
[window.createTextEditorDecorationType](https://code.visualstudio.com/api/references/vscode-api#window.createTextEditorDecorationType)
[TextEditorDecorationType](https://code.visualstudio.com/api/references/vscode-api#TextEditorDecorationType)
[contributes.colors](https://code.visualstudio.com/api/references/contribution-points#contributes.colors) | | [I18n Sample](i18n-sample) | N/A | | -| [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) | -| [Vim Sample](vim-sample) | N/A | [commands](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#commands)
[StatusBarItem](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#StatusBarItem)
[window.createStatusBarItem](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.createStatusBarItem)
[TextEditorCursorStyle](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditorCursorStyle)
[window.activeTextEditor](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#window.activeTextEditor)
[Position](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#Position)
[Range](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#Range)
[Selection](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#Selection)
[TextEditor](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditor)
[TextEditorRevealType](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextEditorRevealType)
[TextDocument](https://vscode-ext-docs.azurewebsites.net/api/references/vscode-api#TextDocument) | +| [Terminal Sample](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](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) | ### Language Protocol Server Samples @@ -48,11 +48,11 @@ You can expect from each sample: | Sample | Guide on VS Code Website | API & Contribution | | ------ | ----- | --- | -| [LSP Sample](lsp-sample) | [/api/language-extensions/smart-editing-lsp-guide](https://vscode-ext-docs.azurewebsites.net/api/language-extensions/smart-editing-lsp-guide) | | +| [LSP Sample](lsp-sample) | [/api/language-extensions/smart-editing-lsp-guide](https://code.visualstudio.com/api/language-extensions/smart-editing-lsp-guide) | | | [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 | | -| [Language Configuration Sample](language-configuration-sample) | [/api/language-extensions/language-configuration-guide](https://vscode-ext-docs.azurewebsites.net/api/language-extensions/language-configuration-guide) | [contributes.languages](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.languages) | -| [Snippet Sample](snippet-sample) | [/api/language-extensions/snippet-guide](https://vscode-ext-docs.azurewebsites.net/api/language-extensions/snippet-guide) | [contributes.snippets](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.snippets) | +| [Language Configuration Sample](language-configuration-sample) | [/api/language-extensions/language-configuration-guide](https://code.visualstudio.com/api/language-extensions/language-configuration-guide) | [contributes.languages](https://code.visualstudio.com/api/references/contribution-points#contributes.languages) | +| [Snippet Sample](snippet-sample) | [/api/language-extensions/snippet-guide](https://code.visualstudio.com/api/language-extensions/snippet-guide) | [contributes.snippets](https://code.visualstudio.com/api/references/contribution-points#contributes.snippets) | ## :warning: Legacy Samples :warning: diff --git a/completions-sample/README.md b/completions-sample/README.md index 833077ad..b10cf569 100644 --- a/completions-sample/README.md +++ b/completions-sample/README.md @@ -9,4 +9,4 @@ This sample shows how to provide completions aka IntelliSense into the editor. T ### `vscode` module -- [`languages.registerCompletionItemProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#languages.registerCompletionItemProvider) +- [`languages.registerCompletionItemProvider`](https://code.visualstudio.com/api/references/vscode-api#languages.registerCompletionItemProvider) diff --git a/contentprovider-sample/README.md b/contentprovider-sample/README.md index 13998b3e..5d8e070b 100644 --- a/contentprovider-sample/README.md +++ b/contentprovider-sample/README.md @@ -13,8 +13,8 @@ It is not intended as a product quality extension. # How it works, what it shows? -- The extension implements and registers a [`TextDocumentContentProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#TextDocumentContentProvider) for a particular URI scheme. -- The content provider uses the [`vscode.executeReferenceProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api-commands)-API command to delegate searching for references to the language extensions, like TypeScript, vscode-go, or C# +- The extension implements and registers a [`TextDocumentContentProvider`](https://code.visualstudio.com/api/references/vscode-api#TextDocumentContentProvider) for a particular URI scheme. +- The content provider uses the [`vscode.executeReferenceProvider`](https://code.visualstudio.com/api/references/commands)-API command to delegate searching for references to the language extensions, like TypeScript, vscode-go, or C# - The generated document initially contains a caption only and incrementally updates as each reference location is resolved. - Add links for each result in the virtual document pointing to the reference. - Add an entry to editor context menu via `package.json` diff --git a/contentprovider-sample/src/provider.ts b/contentprovider-sample/src/provider.ts index a1e0112a..2452fcd9 100644 --- a/contentprovider-sample/src/provider.ts +++ b/contentprovider-sample/src/provider.ts @@ -47,7 +47,7 @@ export default class Provider implements vscode.TextDocumentContentProvider, vsc } // Decode target-uri and target-position from the provided uri and execute the - // `reference provider` command (https://code.visualstudio.com/docs/extensionAPI/vscode-api-commands). + // `reference provider` command (https://code.visualstudio.com/api/references/commands). // From the result create a references document which is in charge of loading, // printing, and formatting references const [target, pos] = decodeLocation(uri); diff --git a/decorator-sample/USAGE.md b/decorator-sample/USAGE.md index 7a38187d..bc535499 100644 --- a/decorator-sample/USAGE.md +++ b/decorator-sample/USAGE.md @@ -6,9 +6,9 @@ The following steps can be done to decorate content in an editor: ## Decoration Types -the [TextEditorDecorationType](https://code.visualstudio.com/docs/extensionAPI/vscode-api#TextEditorDecorationType) class defines how to style a decoration. +the [TextEditorDecorationType](https://code.visualstudio.com/api/references/vscode-api#TextEditorDecorationType) class defines how to style a decoration. -It can be created using `vscode.window.createTextEditorDecorationType`. It takes an object as a parameter which includes any of the properties of [DecorationRenderOptions](https://code.visualstudio.com/docs/extensionAPI/vscode-api#DecorationRenderOptions) which match up to their CSS properties. +It can be created using `vscode.window.createTextEditorDecorationType`. It takes an object as a parameter which includes any of the properties of [DecorationRenderOptions](https://code.visualstudio.com/api/references/vscode-api#DecorationRenderOptions) which match up to their CSS properties. ```typescript const smallNumberDecorationType = vscode.window.createTextEditorDecorationType({ @@ -29,9 +29,9 @@ const smallNumberDecorationType = vscode.window.createTextEditorDecorationType({ ## Creating an array of Ranges -the Decorator API requires an array of [Ranges](https://code.visualstudio.com/docs/extensionAPI/vscode-api#Range). A VS Code range object describes a range of code which can span across both rows and columns in a single file. +the Decorator API requires an array of [Ranges](https://code.visualstudio.com/api/references/vscode-api#Range). A VS Code range object describes a range of code which can span across both rows and columns in a single file. -you can either use a `Range[]` or a [DecorationOptions[]](https://code.visualstudio.com/docs/extensionAPI/vscode-api#DecorationOptions). +you can either use a `Range[]` or a [DecorationOptions[]](https://code.visualstudio.com/api/references/vscode-api#DecorationOptions). For simple sets of selections, using a regular expression can be useful. @@ -56,7 +56,7 @@ const decoration = { range: new vscode.Range(startPos, endPos), hoverMessage: 'N ## Setting the decoration -Finally, you can insert the decoration into any editor with the `setDecorations` method of the [TextEditor](https://code.visualstudio.com/docs/extensionAPI/vscode-api#TextEditor) class. It takes two arguments: +Finally, you can insert the decoration into any editor with the `setDecorations` method of the [TextEditor](https://code.visualstudio.com/api/references/vscode-api#TextEditor) class. It takes two arguments: * The `TextEditorDecorationType` defined for the decoration. * Either a `Range` array or a `DecorationOptions` array. diff --git a/extension-samples-quickstart.md b/extension-samples-quickstart.md deleted file mode 100644 index d84df700..00000000 --- a/extension-samples-quickstart.md +++ /dev/null @@ -1,18 +0,0 @@ -# Welcome to the extension samples - -## What's here -* These folders contain sample [VS Code extensions](https://code.visualstudio.com/docs/extensions/overview) that demonstrate various extension APIs. - -## Get up and running straight away -* Launch `npm install` in terminal in the root folder to initialize all samples -* Open the debug view and select the sample to launch -* set breakpoints inside a sample's `extension.ts` to debug an extension -* find output from your extension in the debug console - -## Make changes -* you can relaunch a sample from the debug toolbar after changing code in `extension.ts` -* you can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes - -## Explore the API -* you can open the full set of our API when you open the file node_modules/vscode/vscode.d.ts in each -sample \ No newline at end of file diff --git a/helloworld-minimal-sample/README.md b/helloworld-minimal-sample/README.md index 336783ec..bd7d5a2f 100644 --- a/helloworld-minimal-sample/README.md +++ b/helloworld-minimal-sample/README.md @@ -8,12 +8,12 @@ It does not use TypeScript and only includes the `vscode` devDependency needed f ### `vscode` module -- [`commands.registerCommand`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#commands.registerCommand) -- [`window.showInformationMessage`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.showInformationMessage) +- [`commands.registerCommand`](https://code.visualstudio.com/api/references/vscode-api#commands.registerCommand) +- [`window.showInformationMessage`](https://code.visualstudio.com/api/references/vscode-api#window.showInformationMessage) ### Contribution Points -- [`contributes.commands`](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributescommands) +- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributescommands) ## Running the Sample diff --git a/helloworld-sample/README.md b/helloworld-sample/README.md index 96403c70..529a8791 100644 --- a/helloworld-sample/README.md +++ b/helloworld-sample/README.md @@ -2,7 +2,7 @@ This is a Hello World example that shows you how to use VS Code API. -Guide for this sample: https://vscode-ext-docs.azurewebsites.net/api/hello-code/introduction. +Guide for this sample: https://code.visualstudio.com/api/hello-code/introduction. ## Demo @@ -12,12 +12,12 @@ Guide for this sample: https://vscode-ext-docs.azurewebsites.net/api/hello-code/ ### `vscode` module -- [`commands.registerCommand`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#commands.registerCommand) -- [`window.showInformationMessage`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.showInformationMessage) +- [`commands.registerCommand`](https://code.visualstudio.com/api/references/vscode-api#commands.registerCommand) +- [`window.showInformationMessage`](https://code.visualstudio.com/api/references/vscode-api#window.showInformationMessage) ### Contribution Points -- [`contributes.commands`](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributescommands) +- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributescommands) ## Running the Sample diff --git a/i18n-sample/README.md b/i18n-sample/README.md index bc005232..38b3f1c6 100644 --- a/i18n-sample/README.md +++ b/i18n-sample/README.md @@ -20,7 +20,7 @@ Localization values are only applied when running the gulp `build` task. During 1. Ensure that you have `gulp-cli` installed globally using `npm install --global gulp-cli`. 1. Run `npm install` to bring in the dependencies. -1. Follow the steps at https://code.visualstudio.com/docs/extensions/publish-extension to ensure that you have installed vsce and have a publisher account. +1. Follow the steps at https://code.visualstudio.com/api/working-with-extensions/publishing-extension to ensure that you have installed vsce and have a publisher account. 1. Run `gulp package` to produce a .vsix file. 1. Install the .vsix file following the instructions at https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix 1. Change your locale to Japanese by invoking "Configure Language" from the Command Palette. diff --git a/index.js b/index.js deleted file mode 100644 index 15f4d2a0..00000000 --- a/index.js +++ /dev/null @@ -1,26 +0,0 @@ -const fs = require('fs'); -const path = require('path'); -const cp = require('child_process'); -const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm'; - -function npmInstall(location) { - const result = cp.spawnSync(npm, ['install', '-D', 'tslint'], { - cwd: location, - stdio: 'inherit' - }); - - if (result.error || result.status !== 0) { - process.exit(1); - } -} - - -const cwd = process.cwd(); -for (const element of fs.readdirSync(cwd)) { - if (element[0] !== '.' && element.endsWith('-sample')) { - const fullpath = path.join(cwd, element, 'package.json'); - if (fs.existsSync(fullpath)) { - npmInstall(path.join(cwd, element)); - } - } -} \ No newline at end of file diff --git a/language-configuration-sample/README.md b/language-configuration-sample/README.md index 991a258c..76e78f66 100644 --- a/language-configuration-sample/README.md +++ b/language-configuration-sample/README.md @@ -1,6 +1,6 @@ # Language Configuration Sample -This is the source code for the [Language Configuration Guide](https://vscode-ext-docs.azurewebsites.net/api/language-extensions/language-configuration-guide). This sample controls the following [Declarative Language Features](https://vscode-ext-docs.azurewebsites.net/api/language-extensions/overview#declarative-language-support) for JavaScript: +This is the source code for the [Language Configuration Guide](https://code.visualstudio.com/api/language-extensions/language-configuration-guide). This sample controls the following [Declarative Language Features](https://code.visualstudio.com/api/language-extensions/overview#declarative-language-support) for JavaScript: - Comment toggling - Brackets definition @@ -14,7 +14,7 @@ This is the source code for the [Language Configuration Guide](https://vscode-ex ### Contribution Points -- [`contributes.languages`](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.languages) +- [`contributes.languages`](https://code.visualstudio.com/api/references/contribution-points#contributes.languages) ## Running the Sample diff --git a/legacy-samples/previewhtml-sample/README.md b/legacy-samples/previewhtml-sample/README.md index 5ca36cd0..09183da7 100644 --- a/legacy-samples/previewhtml-sample/README.md +++ b/legacy-samples/previewhtml-sample/README.md @@ -2,13 +2,13 @@ Please use the new Webview API instead: -- Guide: https://code.visualstudio.com/docs/extensions/webview +- Guide: https://code.visualstudio.com/api/extension-guides/webview - Sample: https://github.com/Microsoft/vscode-extension-samples/tree/master/webview-sample # CSS Properties Preview Sample This is an sample extension that illustrates the use of virtual documents or `TextDocumentContentProviders` together with the `vscode.previewHtml` -[command](https://code.visualstudio.com/docs/extensionAPI/vscode-api-commands#_commands). +[command](https://code.visualstudio.com/api/references/commands#_commands). It is not intended as a product quality extension. @@ -24,7 +24,7 @@ The purpose of the extension is to show a preview of the properties in the decla # How it works -- The extension implements and registers a [`TextDocumentContentProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#TextDocumentContentProvider) for a particular URI scheme. +- The extension implements and registers a [`TextDocumentContentProvider`](https://code.visualstudio.com/api/references/vscode-api#TextDocumentContentProvider) for a particular URI scheme. - The content provider creates a HTML document that contains the declaration block of the selected CSS rule in the active editor. - The generated HTML document contains a link that invokes a contributed command to highlight the CSS rule in the source editor - The generated HTML document is then opened in an editor in the 2nd Column using the command `vscode.previewHtml`. diff --git a/lsp-sample/README.md b/lsp-sample/README.md index b6df202c..00de362a 100644 --- a/lsp-sample/README.md +++ b/lsp-sample/README.md @@ -1,6 +1,6 @@ # LSP Example -Heavily documented sample code for https://code.visualstudio.com/docs/extensions/example-language-server. +Heavily documented sample code for https://code.visualstudio.com/api/language-extensions/smart-editing-lsp-guide ## Functionality diff --git a/progress-sample/README.md b/progress-sample/README.md index dd78d223..f33c306b 100644 --- a/progress-sample/README.md +++ b/progress-sample/README.md @@ -12,7 +12,7 @@ It is not intended as a product quality extension. # How it works, what it shows? -- The extension uses the [`withProgress`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#ProgressOptions) API to show the task in the notification area. +- The extension uses the [`withProgress`](https://code.visualstudio.com/api/references/vscode-api#ProgressOptions) API to show the task in the notification area. - Registers a command via `package.json` that will trigger the task # How to run locally diff --git a/quickinput-sample/README.md b/quickinput-sample/README.md index 2e73b8c8..9c88e280 100644 --- a/quickinput-sample/README.md +++ b/quickinput-sample/README.md @@ -14,7 +14,7 @@ It is not intended as a production quality extension. # How it works, what it shows? -- The extension uses the [`QuickPick`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#QuickPick) and [`InputBox`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#InputBox) API to show a UI for user input. +- The extension uses the [`QuickPick`](https://code.visualstudio.com/api/references/vscode-api#QuickPick) and [`InputBox`](https://code.visualstudio.com/api/references/vscode-api#InputBox) API to show a UI for user input. - Registers a command via `package.json` that will trigger the task # How to run locally diff --git a/snippet-sample/README.md b/snippet-sample/README.md index 22e8af94..d0863aa4 100644 --- a/snippet-sample/README.md +++ b/snippet-sample/README.md @@ -1,12 +1,12 @@ # Snippet Sample -This is the source code for [Snippet Guide](https://vscode-ext-docs.azurewebsites.net/api/language-extensions/snippet-guide). +This is the source code for [Snippet Guide](https://code.visualstudio.com/api/language-extensions/snippet-guide). ## VS Code API ### Contribution Points -- [`contributes.snippets`](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.snippets) +- [`contributes.snippets`](https://code.visualstudio.com/api/references/contribution-points#contributes.snippets) ## Running the Sample diff --git a/statusbar-sample/README.md b/statusbar-sample/README.md index 0f0fafd8..299e5da0 100644 --- a/statusbar-sample/README.md +++ b/statusbar-sample/README.md @@ -9,4 +9,4 @@ This is a sample extension that adds a status bar entry showing the current numb ### `vscode` module -- [`languages.registerCompletionItemProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.createStatusBarItem) +- [`languages.registerCompletionItemProvider`](https://code.visualstudio.com/api/references/vscode-api#window.createStatusBarItem) diff --git a/task-provider-sample/README.md b/task-provider-sample/README.md index f28dc0a3..b919ea2e 100644 --- a/task-provider-sample/README.md +++ b/task-provider-sample/README.md @@ -1,16 +1,16 @@ # Task Provider Sample -This is the source code for the [Task Provider Guide](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/task-provider). It auto-detects tasks in [Rakefiles](https://ruby.github.io/rake/). +This is the source code for the [Task Provider Guide](https://code.visualstudio.com/api/extension-guides/task-provider). It auto-detects tasks in [Rakefiles](https://ruby.github.io/rake/). ## VS Code API ### `vscode` module -- [`tasks`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#_tasks) +- [`tasks`](https://code.visualstudio.com/api/references/vscode-api#_tasks) ### Contribution Points -- [`contributes.taskdefinitions`](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributestaskdefinitions) +- [`contributes.taskdefinitions`](https://code.visualstudio.com/api/references/contribution-points#contributestaskdefinitions) ## Running the example diff --git a/terminal-sample/README.md b/terminal-sample/README.md index a58971e7..9186b52c 100644 --- a/terminal-sample/README.md +++ b/terminal-sample/README.md @@ -8,12 +8,12 @@ This sample provides several commands that demonstrates how to utilize the integ ### `vscode` module -- [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) +- [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) ### Proposed API @@ -22,7 +22,7 @@ This sample provides several commands that demonstrates how to utilize the integ ### Contribution Points -- [`contributes.commands`](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributescommands) +- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributescommands) ## Running the Sample diff --git a/theme-sample/README.md b/theme-sample/README.md index 5a2c1149..7118960f 100644 --- a/theme-sample/README.md +++ b/theme-sample/README.md @@ -2,9 +2,9 @@ This sample color theme extension contains two TextMate themes. -Text Mate themes describe the theming rules used for syntax highlighting. Each rule consists of one or more scope selectors and a set of styles. To learn more about scopes and how they're used, check out the [color theme](https://code.visualstudio.com/docs/extensions/themes-snippets-colorizers#_adding-a-new-color-theme) documentation. +Text Mate themes describe the theming rules used for syntax highlighting. Each rule consists of one or more scope selectors and a set of styles. To learn more about scopes and how they're used, check out the [color theme](https://code.visualstudio.com/api/extension-guides/color-theme) documentation. -You can directly use .tmTheme files in your extensions or import/convert them with VS Code's extension generator [yo code](https://code.visualstudio.com/docs/extensions/yocode). +You can directly use .tmTheme files in your extensions or import/convert them with VS Code's extension generator [yo code](https://code.visualstudio.com/api/get-started/your-first-extension). ## Demo @@ -20,7 +20,7 @@ Sample Dark ### Contribution Points -- [contributes.themes](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributesthemes) +- [contributes.themes](https://code.visualstudio.com/api/references/contribution-points#contributesthemes) ## Running the sample diff --git a/tree-view-sample/USAGE.md b/tree-view-sample/USAGE.md index c03290bb..08b525dc 100644 --- a/tree-view-sample/USAGE.md +++ b/tree-view-sample/USAGE.md @@ -1,9 +1,9 @@ # Contributing a View Container & View -* Contribute a view container using the [viewContainers](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributesviewscontainers) extension point. -* Contribute a view using the [views](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributesviews) extension point. -* Register a data provider for the view using the [TreeDataProvider](https://code.visualstudio.com/docs/extensionAPI/vscode-api#_TreeDataProvider) API. -* Contribute actions to the view using `view/title` and `view/item/context` locations in [menus](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributesmenus) extension point. +* Contribute a view container using the [viewContainers](https://code.visualstudio.com/api/references/contribution-points#contributesviewscontainers) extension point. +* Contribute a view using the [views](https://code.visualstudio.com/api/references/contribution-points#contributesviews) extension point. +* Register a data provider for the view using the [TreeDataProvider](https://code.visualstudio.com/api/references/vscode-api#_TreeDataProvider) API. +* Contribute actions to the view using `view/title` and `view/item/context` locations in [menus](https://code.visualstudio.com/api/references/contribution-points#contributesmenus) extension point. ## contributes.viewsContainers extension point @@ -105,7 +105,7 @@ Examples: ## TreeDataProvider -Extension writers should register a [provider](/docs/extensionAPI/vscode-api.md#TreeDataProvider) programmatically to populate data in the view. +Extension writers should register a [provider](https://code.visualstudio.com/api/references/vscode-api#TreeDataProvider) programmatically to populate data in the view. ```typescript vscode.window.registerTreeDataProvider('nodeDependencies', new DepNodeProvider()); diff --git a/virtual-document-sample/README.md b/virtual-document-sample/README.md index c609c37a..57cfd9f5 100644 --- a/virtual-document-sample/README.md +++ b/virtual-document-sample/README.md @@ -9,6 +9,6 @@ This is a sample extension that shows how to add virtual documents to the editor ### `vscode` module -- [`workspace.registerTextDocumentContentProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#workspace.registerTextDocumentContentProvider) -- [`commands.registerCommand`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#commands.registerCommand) -- [`window.showInputBox`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.showInputBox) +- [`workspace.registerTextDocumentContentProvider`](https://code.visualstudio.com/api/references/vscode-api#workspace.registerTextDocumentContentProvider) +- [`commands.registerCommand`](https://code.visualstudio.com/api/references/vscode-api#commands.registerCommand) +- [`window.showInputBox`](https://code.visualstudio.com/api/references/vscode-api#window.showInputBox) diff --git a/webview-sample/README.md b/webview-sample/README.md index ae3bccd0..dfe5e461 100644 --- a/webview-sample/README.md +++ b/webview-sample/README.md @@ -1,6 +1,6 @@ # Cat Coding — A Webview API Sample -Demonstrates VS Code's [webview API](https://code.visualstudio.com/docs/extensions/webview). This includes: +Demonstrates VS Code's [webview API](https://code.visualstudio.com/api/extension-guides/webview). This includes: - Creating and showing a basic webview. - Dynamically updating a webview's content. @@ -21,8 +21,8 @@ Demonstrates VS Code's [webview API](https://code.visualstudio.com/docs/extensio ### `vscode` module -- [`window.createWebviewPanel`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.createWebviewPanel) -- [`window.registerWebviewPanelSerializer`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.registerWebviewPanelSerializer) +- [`window.createWebviewPanel`](https://code.visualstudio.com/api/references/vscode-api#window.createWebviewPanel) +- [`window.registerWebviewPanelSerializer`](https://code.visualstudio.com/api/references/vscode-api#window.registerWebviewPanelSerializer) ## Running the example From 4762e4e8fff74ac05b512f7faaba9e9781fb27b0 Mon Sep 17 00:00:00 2001 From: Julien Croain Date: Fri, 21 Dec 2018 13:45:29 +0100 Subject: [PATCH 2/5] Fix SCM label in contributes views --- tree-view-sample/USAGE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tree-view-sample/USAGE.md b/tree-view-sample/USAGE.md index c03290bb..d61d9a40 100644 --- a/tree-view-sample/USAGE.md +++ b/tree-view-sample/USAGE.md @@ -22,7 +22,7 @@ You must specify an identifier and name for the view. You can contribute to foll - `explorer`: Explorer view in the Side bar - `debug`: Debug view in the Side bar -- `scm`: Debug view in the Side bar +- `scm`: Source Control Management view in the Side bar When the user opens the view, VS Code will then emit an activationEvent `onView:${viewId}` (e.g. `onView:nodeDependencies` for the example below). You can also control the visibility of the view by providing the `when` context value. From eb5924c95472acc2dfa8346ea3a073616584b0af Mon Sep 17 00:00:00 2001 From: Pine Wu Date: Fri, 21 Dec 2018 10:06:05 -0800 Subject: [PATCH 3/5] Fix various anchors --- .scripts/samples.js | 2 +- helloworld-minimal-sample/README.md | 2 +- helloworld-sample/README.md | 2 +- legacy-samples/previewhtml-sample/README.md | 2 +- lsp-sample/README.md | 2 +- task-provider-sample/README.md | 2 +- terminal-sample/README.md | 2 +- theme-sample/README.md | 2 +- tree-view-sample/USAGE.md | 4 ++-- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.scripts/samples.js b/.scripts/samples.js index ec211f45..84704831 100644 --- a/.scripts/samples.js +++ b/.scripts/samples.js @@ -131,7 +131,7 @@ const lspSamples = [ { description: 'LSP Sample', path: 'lsp-sample', - guide: '/api/language-extensions/smart-editing-lsp-guide', + guide: '/api/language-extensions/language-server-extension-guide', apis: [], contributions: [] }, diff --git a/helloworld-minimal-sample/README.md b/helloworld-minimal-sample/README.md index bd7d5a2f..903a1b99 100644 --- a/helloworld-minimal-sample/README.md +++ b/helloworld-minimal-sample/README.md @@ -13,7 +13,7 @@ It does not use TypeScript and only includes the `vscode` devDependency needed f ### Contribution Points -- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributescommands) +- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributes.commands) ## Running the Sample diff --git a/helloworld-sample/README.md b/helloworld-sample/README.md index 529a8791..e126165a 100644 --- a/helloworld-sample/README.md +++ b/helloworld-sample/README.md @@ -17,7 +17,7 @@ Guide for this sample: https://code.visualstudio.com/api/hello-code/introduction ### Contribution Points -- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributescommands) +- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributes.commands) ## Running the Sample diff --git a/legacy-samples/previewhtml-sample/README.md b/legacy-samples/previewhtml-sample/README.md index 09183da7..b2576918 100644 --- a/legacy-samples/previewhtml-sample/README.md +++ b/legacy-samples/previewhtml-sample/README.md @@ -8,7 +8,7 @@ Please use the new Webview API instead: # CSS Properties Preview Sample This is an sample extension that illustrates the use of virtual documents or `TextDocumentContentProviders` together with the `vscode.previewHtml` -[command](https://code.visualstudio.com/api/references/commands#_commands). +[command](https://code.visualstudio.com/api/references/commands#commands). It is not intended as a product quality extension. diff --git a/lsp-sample/README.md b/lsp-sample/README.md index 00de362a..e370e76a 100644 --- a/lsp-sample/README.md +++ b/lsp-sample/README.md @@ -1,6 +1,6 @@ # LSP Example -Heavily documented sample code for https://code.visualstudio.com/api/language-extensions/smart-editing-lsp-guide +Heavily documented sample code for https://code.visualstudio.com/api/language-extensions/language-server-extension-guide ## Functionality diff --git a/task-provider-sample/README.md b/task-provider-sample/README.md index b919ea2e..e92ec2c7 100644 --- a/task-provider-sample/README.md +++ b/task-provider-sample/README.md @@ -10,7 +10,7 @@ This is the source code for the [Task Provider Guide](https://code.visualstudio. ### Contribution Points -- [`contributes.taskdefinitions`](https://code.visualstudio.com/api/references/contribution-points#contributestaskdefinitions) +- [`contributes.taskdefinitions`](https://code.visualstudio.com/api/references/contribution-points#contributes.taskDefinitions) ## Running the example diff --git a/terminal-sample/README.md b/terminal-sample/README.md index 9186b52c..84f7945f 100644 --- a/terminal-sample/README.md +++ b/terminal-sample/README.md @@ -22,7 +22,7 @@ This sample provides several commands that demonstrates how to utilize the integ ### Contribution Points -- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributescommands) +- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributes.commands) ## Running the Sample diff --git a/theme-sample/README.md b/theme-sample/README.md index 7118960f..c7e6d98b 100644 --- a/theme-sample/README.md +++ b/theme-sample/README.md @@ -20,7 +20,7 @@ Sample Dark ### Contribution Points -- [contributes.themes](https://code.visualstudio.com/api/references/contribution-points#contributesthemes) +- [contributes.themes](https://code.visualstudio.com/api/references/contribution-points#contributes.themes) ## Running the sample diff --git a/tree-view-sample/USAGE.md b/tree-view-sample/USAGE.md index 08b525dc..c0594762 100644 --- a/tree-view-sample/USAGE.md +++ b/tree-view-sample/USAGE.md @@ -1,7 +1,7 @@ # Contributing a View Container & View -* Contribute a view container using the [viewContainers](https://code.visualstudio.com/api/references/contribution-points#contributesviewscontainers) extension point. -* Contribute a view using the [views](https://code.visualstudio.com/api/references/contribution-points#contributesviews) extension point. +* Contribute a view container using the [viewContainers](https://code.visualstudio.com/api/references/contribution-points#contributes.viewsContainers) extension point. +* Contribute a view using the [views](https://code.visualstudio.com/api/references/contribution-points#contributes.views) extension point. * Register a data provider for the view using the [TreeDataProvider](https://code.visualstudio.com/api/references/vscode-api#_TreeDataProvider) API. * Contribute actions to the view using `view/title` and `view/item/context` locations in [menus](https://code.visualstudio.com/api/references/contribution-points#contributesmenus) extension point. From 792ffb7f6f1c428cb1ba1eb1136ff76a14e21e9c Mon Sep 17 00:00:00 2001 From: Greg Van Liew Date: Sun, 23 Dec 2018 22:24:23 -0800 Subject: [PATCH 4/5] Fix broken link to Hello World extension tutorial --- helloworld-sample/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/helloworld-sample/README.md b/helloworld-sample/README.md index e126165a..b0c530e6 100644 --- a/helloworld-sample/README.md +++ b/helloworld-sample/README.md @@ -2,7 +2,7 @@ This is a Hello World example that shows you how to use VS Code API. -Guide for this sample: https://code.visualstudio.com/api/hello-code/introduction. +Guide for this sample: https://code.visualstudio.com/api/get-started/your-first-extension. ## Demo From 33381f644d569852e5f13260cf28b33bcf3b9a54 Mon Sep 17 00:00:00 2001 From: Pine Wu Date: Mon, 24 Dec 2018 09:51:18 -0800 Subject: [PATCH 5/5] Update link generation logic --- .scripts/samples.js | 30 +++++++++++++++--------------- .scripts/update-readme.js | 4 ++-- README.md | 34 ++++++++++++++++------------------ 3 files changed, 33 insertions(+), 35 deletions(-) diff --git a/.scripts/samples.js b/.scripts/samples.js index 84704831..8b0f5359 100644 --- a/.scripts/samples.js +++ b/.scripts/samples.js @@ -21,7 +21,7 @@ const samples = [ { description: 'Status Bar Sample', path: 'statusbar-sample', - guide: '/api/extension-guides/status-bar', + guide: null, apis: ['window.createStatusBarItem', 'StatusBarItem'], contributions: [] }, @@ -128,6 +128,20 @@ const samples = [ /** @type {Sample[]} */ const lspSamples = [ + { + description: 'Snippet Sample', + path: 'snippet-sample', + guide: '/api/language-extensions/snippet-guide', + apis: [], + contributions: ['snippets'] + }, + { + description: 'Language Configuration Sample', + path: 'language-configuration-sample', + guide: '/api/language-extensions/language-configuration-guide', + apis: [], + contributions: ['languages'] + }, { description: 'LSP Sample', path: 'lsp-sample', @@ -149,20 +163,6 @@ const lspSamples = [ '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'] } ] diff --git a/.scripts/update-readme.js b/.scripts/update-readme.js index 05bda870..4f2b9295 100644 --- a/.scripts/update-readme.js +++ b/.scripts/update-readme.js @@ -12,14 +12,14 @@ const LSP_TABLE_HEAD = ` const LSP_TABLE_END = `` const getTableRow = sample => { - const descriptionCell = `[${sample.description}](${sample.path})` + const descriptionCell = `[${sample.description}](https://github.com/Microsoft/vscode-extension-samples/tree/master/${sample.path})` let guideCell if (!sample.guide) { guideCell = 'N/A' } else if (sample.guide && sample.guide.startsWith('http')) { guideCell = sample.guide } else { - guideCell = `[${sample.guide}](https://vscode-ext-docs.azurewebsites.net${sample.guide})` + guideCell = `[${sample.guide}](https://code.visualstudio.com${sample.guide})` } const apis = sample.apis.map(api => { diff --git a/README.md b/README.md index 23a2a842..ea11809a 100644 --- a/README.md +++ b/README.md @@ -25,22 +25,20 @@ You can expect from each sample: ## Samples -**:construction: Some links point to our work-in-progress [API Extension](https://code.visualstudio.com/api) documentation that is not yet published :construction:** - | Sample | Guide on VS Code Website | API & Contribution | | ------ | ----- | --- | -| [Webview Sample](webview-sample) | [/api/extension-guides/webview](https://code.visualstudio.com/api/extension-guides/webview) | [window.createWebviewPanel](https://code.visualstudio.com/api/references/vscode-api#window.createWebviewPanel)
[window.registerWebviewPanelSerializer](https://code.visualstudio.com/api/references/vscode-api#window.registerWebviewPanelSerializer) | -| [Status Bar Sample](statusbar-sample) | [/api/extension-guides/status-bar](https://code.visualstudio.com/api/extension-guides/status-bar) | [window.createStatusBarItem](https://code.visualstudio.com/api/references/vscode-api#window.createStatusBarItem)
[StatusBarItem](https://code.visualstudio.com/api/references/vscode-api#StatusBarItem) | -| [Tree View Sample](tree-view-sample) | [/api/extension-guides/tree-view](https://code.visualstudio.com/api/extension-guides/tree-view) | [window.createTreeView](https://code.visualstudio.com/api/references/vscode-api#window.createTreeView)
[window.registerTreeDataProvider](https://code.visualstudio.com/api/references/vscode-api#window.registerTreeDataProvider)
[TreeView](https://code.visualstudio.com/api/references/vscode-api#TreeView)
[TreeDataProvider](https://code.visualstudio.com/api/references/vscode-api#TreeDataProvider)
[contributes.views](https://code.visualstudio.com/api/references/contribution-points#contributes.views)
[contributes.viewsContainers](https://code.visualstudio.com/api/references/contribution-points#contributes.viewsContainers) | -| [Task Provider Sample](task-provider-sample) | [/api/extension-guides/task-provider](https://code.visualstudio.com/api/extension-guides/task-provider) | [tasks.registerTaskProvider](https://code.visualstudio.com/api/references/vscode-api#tasks.registerTaskProvider)
[Task](https://code.visualstudio.com/api/references/vscode-api#Task)
[ShellExecution](https://code.visualstudio.com/api/references/vscode-api#ShellExecution)
[contributes.taskDefinitions](https://code.visualstudio.com/api/references/contribution-points#contributes.taskDefinitions) | -| [Multi Root Sample](basic-multi-root-sample) | N/A | [workspace.getWorkspaceFolder](https://code.visualstudio.com/api/references/vscode-api#workspace.getWorkspaceFolder)
[workspace.onDidChangeWorkspaceFolders](https://code.visualstudio.com/api/references/vscode-api#workspace.onDidChangeWorkspaceFolders) | -| [Completion Provider Sample](completions-sample) | N/A | [languages.registerCompletionItemProvider](https://code.visualstudio.com/api/references/vscode-api#languages.registerCompletionItemProvider)
[CompletionItem](https://code.visualstudio.com/api/references/vscode-api#CompletionItem)
[SnippetString](https://code.visualstudio.com/api/references/vscode-api#SnippetString) | -| [File System Provider Sample](fsprovider-sample) | N/A | [workspace.registerFileSystemProvider](https://code.visualstudio.com/api/references/vscode-api#workspace.registerFileSystemProvider) | -| [Editor Decoractor Sample](decorator-sample) | N/A | [TextEditor.setDecorations](https://code.visualstudio.com/api/references/vscode-api#TextEditor.setDecorations)
[DecorationOptions](https://code.visualstudio.com/api/references/vscode-api#DecorationOptions)
[DecorationInstanceRenderOptions](https://code.visualstudio.com/api/references/vscode-api#DecorationInstanceRenderOptions)
[ThemableDecorationInstanceRenderOptions](https://code.visualstudio.com/api/references/vscode-api#ThemableDecorationInstanceRenderOptions)
[window.createTextEditorDecorationType](https://code.visualstudio.com/api/references/vscode-api#window.createTextEditorDecorationType)
[TextEditorDecorationType](https://code.visualstudio.com/api/references/vscode-api#TextEditorDecorationType)
[contributes.colors](https://code.visualstudio.com/api/references/contribution-points#contributes.colors) | -| [I18n Sample](i18n-sample) | N/A | | -| [Terminal Sample](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](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) | +| [Webview Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/webview-sample) | [/api/extension-guides/webview](https://code.visualstudio.com/api/extension-guides/webview) | [window.createWebviewPanel](https://code.visualstudio.com/api/references/vscode-api#window.createWebviewPanel)
[window.registerWebviewPanelSerializer](https://code.visualstudio.com/api/references/vscode-api#window.registerWebviewPanelSerializer) | +| [Status Bar Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/statusbar-sample) | N/A | [window.createStatusBarItem](https://code.visualstudio.com/api/references/vscode-api#window.createStatusBarItem)
[StatusBarItem](https://code.visualstudio.com/api/references/vscode-api#StatusBarItem) | +| [Tree View Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/tree-view-sample) | [/api/extension-guides/tree-view](https://code.visualstudio.com/api/extension-guides/tree-view) | [window.createTreeView](https://code.visualstudio.com/api/references/vscode-api#window.createTreeView)
[window.registerTreeDataProvider](https://code.visualstudio.com/api/references/vscode-api#window.registerTreeDataProvider)
[TreeView](https://code.visualstudio.com/api/references/vscode-api#TreeView)
[TreeDataProvider](https://code.visualstudio.com/api/references/vscode-api#TreeDataProvider)
[contributes.views](https://code.visualstudio.com/api/references/contribution-points#contributes.views)
[contributes.viewsContainers](https://code.visualstudio.com/api/references/contribution-points#contributes.viewsContainers) | +| [Task Provider Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/task-provider-sample) | [/api/extension-guides/task-provider](https://code.visualstudio.com/api/extension-guides/task-provider) | [tasks.registerTaskProvider](https://code.visualstudio.com/api/references/vscode-api#tasks.registerTaskProvider)
[Task](https://code.visualstudio.com/api/references/vscode-api#Task)
[ShellExecution](https://code.visualstudio.com/api/references/vscode-api#ShellExecution)
[contributes.taskDefinitions](https://code.visualstudio.com/api/references/contribution-points#contributes.taskDefinitions) | +| [Multi Root Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/basic-multi-root-sample) | N/A | [workspace.getWorkspaceFolder](https://code.visualstudio.com/api/references/vscode-api#workspace.getWorkspaceFolder)
[workspace.onDidChangeWorkspaceFolders](https://code.visualstudio.com/api/references/vscode-api#workspace.onDidChangeWorkspaceFolders) | +| [Completion Provider Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/completions-sample) | N/A | [languages.registerCompletionItemProvider](https://code.visualstudio.com/api/references/vscode-api#languages.registerCompletionItemProvider)
[CompletionItem](https://code.visualstudio.com/api/references/vscode-api#CompletionItem)
[SnippetString](https://code.visualstudio.com/api/references/vscode-api#SnippetString) | +| [File System Provider Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/fsprovider-sample) | N/A | [workspace.registerFileSystemProvider](https://code.visualstudio.com/api/references/vscode-api#workspace.registerFileSystemProvider) | +| [Editor Decoractor Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/decorator-sample) | N/A | [TextEditor.setDecorations](https://code.visualstudio.com/api/references/vscode-api#TextEditor.setDecorations)
[DecorationOptions](https://code.visualstudio.com/api/references/vscode-api#DecorationOptions)
[DecorationInstanceRenderOptions](https://code.visualstudio.com/api/references/vscode-api#DecorationInstanceRenderOptions)
[ThemableDecorationInstanceRenderOptions](https://code.visualstudio.com/api/references/vscode-api#ThemableDecorationInstanceRenderOptions)
[window.createTextEditorDecorationType](https://code.visualstudio.com/api/references/vscode-api#window.createTextEditorDecorationType)
[TextEditorDecorationType](https://code.visualstudio.com/api/references/vscode-api#TextEditorDecorationType)
[contributes.colors](https://code.visualstudio.com/api/references/contribution-points#contributes.colors) | +| [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) | ### Language Protocol Server Samples @@ -48,11 +46,11 @@ You can expect from each sample: | Sample | Guide on VS Code Website | API & Contribution | | ------ | ----- | --- | -| [LSP Sample](lsp-sample) | [/api/language-extensions/smart-editing-lsp-guide](https://code.visualstudio.com/api/language-extensions/smart-editing-lsp-guide) | | -| [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 | | -| [Language Configuration Sample](language-configuration-sample) | [/api/language-extensions/language-configuration-guide](https://code.visualstudio.com/api/language-extensions/language-configuration-guide) | [contributes.languages](https://code.visualstudio.com/api/references/contribution-points#contributes.languages) | -| [Snippet Sample](snippet-sample) | [/api/language-extensions/snippet-guide](https://code.visualstudio.com/api/language-extensions/snippet-guide) | [contributes.snippets](https://code.visualstudio.com/api/references/contribution-points#contributes.snippets) | +| [Snippet Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/snippet-sample) | [/api/language-extensions/snippet-guide](https://code.visualstudio.com/api/language-extensions/snippet-guide) | [contributes.snippets](https://code.visualstudio.com/api/references/contribution-points#contributes.snippets) | +| [Language Configuration Sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/language-configuration-sample) | [/api/language-extensions/language-configuration-guide](https://code.visualstudio.com/api/language-extensions/language-configuration-guide) | [contributes.languages](https://code.visualstudio.com/api/references/contribution-points#contributes.languages) | +| [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 | | ## :warning: Legacy Samples :warning: