hokein created this revision.
hokein added reviewers: sammccall, krasimir.
Herald added subscribers: ilya-biryukov, klimek.
Previously, we use a separate GitHub repository
(https://github.com/llvm-vs-code-extensions/vscode-clangd)
for publishing `vscode-clangd` extension to marketplace.
To reduce the maintain burden, we will use the vscode extension in the
clang-tools-extra, and deprecate the one on GitHub.
Test in
https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.clangd-vscode-test
Repository:
rCTE Clang Tools Extra
https://reviews.llvm.org/D41391
Files:
clangd/clients/clangd-vscode/README.md
clangd/clients/clangd-vscode/README.txt
clangd/clients/clangd-vscode/package.json
Index: clangd/clients/clangd-vscode/package.json
===================================================================
--- clangd/clients/clangd-vscode/package.json
+++ clangd/clients/clangd-vscode/package.json
@@ -1,17 +1,25 @@
{
- "name": "clangd-vscode",
- "displayName": "clangd-vscode",
+ "name": "vscode-clangd",
+ "displayName": "vscode-clangd",
"description": "Clang Language Server",
- "version": "0.0.1",
- "publisher": "Unpublished",
+ "version": "0.0.2",
+ "publisher": "llvm-vs-code-extensions",
"engines": {
"vscode": "^1.15.0"
},
"categories": [
"Languages",
"Linters",
"Snippets"
],
+ "keywords": [
+ "C",
+ "C++",
+ "LSP",
+ "Clang",
+ "LLVM",
+ "Clangd"
+ ],
"activationEvents": [
"onLanguage:cpp",
"onLanguage:c"
@@ -34,6 +42,10 @@
"@types/node": "^6.0.40",
"@types/mocha": "^2.2.32"
},
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/llvm-mirror/clang-tools-extra/tree/master/clangd/clients/clangd-vscode";
+ },
"contributes": {
"configuration": {
"type": "object",
Index: clangd/clients/clangd-vscode/README.txt
===================================================================
--- clangd/clients/clangd-vscode/README.txt
+++ /dev/null
@@ -1,11 +0,0 @@
-A *toy* VS Code integration for development purposes.
-
-Steps:
-1. Make sure you have clangd in /usr/bin/clangd or edit src/extension.ts to
-point to the binary.
-2. Make sure you have nodejs and npm installed.
-3. Make sure you have VS Code installed.
-4. In order to start a development instance of VS code extended with this, run:
- $ npm install
- $ code .
- When VS Code starts, press <F5>.
Index: clangd/clients/clangd-vscode/README.md
===================================================================
--- /dev/null
+++ clangd/clients/clangd-vscode/README.md
@@ -0,0 +1,53 @@
+# vscode-clangd
+
+Provides C/C++ language IDE features for VS Code using [clangd](https://clang.llvm.org/extra/clangd.html).
+
+## Usage
+
+`vscode-clangd` provides the features designated by the [Language Server
+Protocol](https://github.com/Microsoft/language-server-protocol), such as
+code completion, code formatting and goto definition.
+
+**Note**: `clangd` is under heavy development, not all LSP features are
+implemented. See [Current Status](https://clang.llvm.org/extra/clangd.html#current-status)
+for details.
+
+To use `vscode-clangd` extension in VS Code, you need to install `vscode-clangd`
+from VS Code extension marketplace.
+
+## Configuration
+
+`vscode-clangd` will attempt to find the `clangd` binary on your `PATH`.
+Alternatively, the `clangd` executable can be specified in your VS Code
+`settings.json` file:
+
+```json
+{
+ "clangd.path": "/absolute/path/to/clangd"
+}
+```
+
+To obtain `clangd` binary, please see the [installing Clangd](https://clang.llvm.org/extra/clangd.html#installing-clangd).
+
+## Development
+
+A guide of developing `vscode-clangd` extension.
+
+### Requirements
+
+* VS Code
+* nodejs and npm
+
+### Steps
+
+1. Make sure you disable the installed `vscode-clangd` extension in VS Code.
+2. Make sure you have clangd in /usr/bin/clangd or edit src/extension.ts to
+point to the binary.
+3. In order to start a development instance of VS code extended with this, run:
+
+```bash
+ $ cd /path/to/clang-tools-extra/clangd/clients/clangd-vscode/
+ $ npm install
+ $ code .
+ # When VS Code starts, press <F5>.
+```
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
