hokein updated this revision to Diff 127529.
hokein marked 3 inline comments as done.
hokein added a comment.
Address review comments and add license.
Repository:
rCTE Clang Tools Extra
https://reviews.llvm.org/D41391
Files:
clangd/clients/clangd-vscode/LICENSE
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",
+ "homepage": "https://clang.llvm.org/extra/clangd.html";,
"engines": {
"vscode": "^1.15.0"
},
"categories": [
"Languages",
"Linters",
"Snippets"
],
+ "keywords": [
+ "C",
+ "C++",
+ "LSP",
+ "Clangd",
+ "LLVM"
+ ],
"activationEvents": [
"onLanguage:cpp",
"onLanguage:c"
@@ -34,6 +42,10 @@
"@types/node": "^6.0.40",
"@types/mocha": "^2.2.32"
},
+ "repository": {
+ "type": "svn",
+ "url": "http://llvm.org/svn/llvm-project/clang-tools-extra/trunk/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,51 @@
+# 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.
+
+`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
+* node.js 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>.
+```
Index: clangd/clients/clangd-vscode/LICENSE
===================================================================
--- /dev/null
+++ clangd/clients/clangd-vscode/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 The LLVM Developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
