diff --git a/.scripts/samples.js b/.scripts/samples.js index 5774af83c..4457980c7 100644 --- a/.scripts/samples.js +++ b/.scripts/samples.js @@ -126,10 +126,17 @@ const lspSamples = [ { description: 'Language Configuration Sample', path: 'language-configuration-sample', - guide: 'https://vscode-ext-docs.azurewebsites.net/api/language-extensions/language-configuration-guide', + 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'] + }, ] module.exports = { diff --git a/README.md b/README.md index 40c467faf..f994a9069 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,8 @@ You can expect from each sample: | [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 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) | 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) | +| [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) | ## :warning: Legacy Samples :warning: diff --git a/language-configuration-sample/README.md b/language-configuration-sample/README.md index af6f53219..856596bd0 100644 --- a/language-configuration-sample/README.md +++ b/language-configuration-sample/README.md @@ -6,7 +6,7 @@ This is the source code for the [Language Configuration Guide](https://vscode-ex ### Contribution Points -- [`contributes.languages`](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributeslanguages) +- [`contributes.languages`](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.languages) ## Running the Sample diff --git a/language-configuration-sample/package.json b/language-configuration-sample/package.json index b9012c9a2..9849216ed 100644 --- a/language-configuration-sample/package.json +++ b/language-configuration-sample/package.json @@ -8,7 +8,7 @@ "vscode": "^1.28.0" }, "categories": [ - "Other" + "Programming Languages" ], "contributes": { "languages": [ diff --git a/snippet-sample/.vscode/launch.json b/snippet-sample/.vscode/launch.json new file mode 100644 index 000000000..f8336da9d --- /dev/null +++ b/snippet-sample/.vscode/launch.json @@ -0,0 +1,17 @@ +// A launch configuration that compiles the extension and then opens it inside a new window +// Use IntelliSense to learn about possible attributes. +// Hover to view descriptions of existing attributes. +// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 +{ + "version": "0.2.0", + "configurations": [{ + "name": "Run Extension", + "type": "extensionHost", + "request": "launch", + "runtimeExecutable": "${execPath}", + "args": [ + "--extensionDevelopmentPath=${workspaceFolder}" + ] + } + ] +} diff --git a/snippet-sample/.vscode/settings.json b/snippet-sample/.vscode/settings.json new file mode 100644 index 000000000..e46111f13 --- /dev/null +++ b/snippet-sample/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "editor.insertSpaces": false +} \ No newline at end of file diff --git a/snippet-sample/README.md b/snippet-sample/README.md new file mode 100644 index 000000000..22e8af941 --- /dev/null +++ b/snippet-sample/README.md @@ -0,0 +1,14 @@ +# Snippet Sample + +This is the source code for [Snippet Guide](https://vscode-ext-docs.azurewebsites.net/api/language-extensions/snippet-guide). + +## VS Code API + +### Contribution Points + +- [`contributes.snippets`](https://vscode-ext-docs.azurewebsites.net/api/references/contribution-points#contributes.snippets) + +## Running the Sample + +- Run the `Run Extension` target in the Debug View +- When you type `log` in a JavaScript file, you would see the snippet `Print to console`. \ No newline at end of file diff --git a/snippet-sample/package.json b/snippet-sample/package.json new file mode 100644 index 000000000..fdf941427 --- /dev/null +++ b/snippet-sample/package.json @@ -0,0 +1,21 @@ +{ + "name": "snippet-sample", + "displayName": "Snippet Sample", + "description": "Snippet Sample", + "version": "0.0.1", + "publisher": "vscode-samples", + "engines": { + "vscode": "^1.28.0" + }, + "categories": [ + "Snippets" + ], + "contributes": { + "snippets": [ + { + "language": "javascript", + "path": "./snippets.json" + } + ] + } +} diff --git a/snippet-sample/snippets.json b/snippet-sample/snippets.json new file mode 100644 index 000000000..2fd87308c --- /dev/null +++ b/snippet-sample/snippets.json @@ -0,0 +1,10 @@ +{ + "Print to console": { + "prefix": "log", + "body": [ + "console.log('$1');", + "$2" + ], + "description": "Log output to console" + } +} \ No newline at end of file