Author: Nathan Ridge Date: 2020-03-05T15:28:40-05:00 New Revision: a7c655f1480fbcee853fb7d9f6fd4cff80a0dc2f
URL: https://github.com/llvm/llvm-project/commit/a7c655f1480fbcee853fb7d9f6fd4cff80a0dc2f DIFF: https://github.com/llvm/llvm-project/commit/a7c655f1480fbcee853fb7d9f6fd4cff80a0dc2f.diff LOG: [clangd] Remove vsc-extension-quickstart.md from the vscode-clangd plugin Summary: Subscribers: ilya-biryukov, MaskRay, jkorous, arphaman, kadircet, usaxena95, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D75292 Added: Modified: Removed: clang-tools-extra/clangd/clients/clangd-vscode/vsc-extension-quickstart.md ################################################################################ diff --git a/clang-tools-extra/clangd/clients/clangd-vscode/vsc-extension-quickstart.md b/clang-tools-extra/clangd/clients/clangd-vscode/vsc-extension-quickstart.md deleted file mode 100644 index 24675ec630ca..000000000000 --- a/clang-tools-extra/clangd/clients/clangd-vscode/vsc-extension-quickstart.md +++ /dev/null @@ -1,33 +0,0 @@ -# Toy VS Code Extension for clangd - -## What's in the folder -* This folder contains all of the files necessary for your extension -* `package.json` - this is the manifest file in which you declare your extension and command. -The sample plugin registers a command and defines its title and command name. With this information -VS Code can show the command in the command palette. It doesn’t yet need to load the plugin. -* `src/extension.ts` - this is the main file where you will provide the implementation of your command. -The file exports one function, `activate`, which is called the very first time your extension is -activated (in this case by executing the command). Inside the `activate` function we call `registerCommand`. -We pass the function containing the implementation of the command as the second parameter to -`registerCommand`. - -## Get up and running straight away -* press `F5` to open a new window with your extension loaded -* run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `Hello World` -* set breakpoints in your code inside `src/extension.ts` to debug your extension -* find output from your extension in the debug console - -## Make changes -* you can relaunch the extension from the debug toolbar after changing code in `src/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` - -## Run tests -* open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Launch Tests` -* press `F5` to run the tests in a new window with your extension loaded -* see the output of the test result in the debug console -* make changes to `test/extension.test.ts` or create new test files inside the `test` folder - * by convention, the test runner will only consider files matching the name pattern `**.test.ts` - * you can create folders inside the `test` folder to structure your tests any way you want \ No newline at end of file _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
