Zengtudor/ccls
1
0
Fork 0
mirror of https://github.com/MaskRay/ccls.git synced 2024-11-22 07:35:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Visual Studio Code (markdown)

Evgenii Balai 2020-04-14 23:33:19 -04:00 committed by Fangrui Song
parent f9aca3810f
commit 939778093f
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Visual-Studio-Code.md

@ -5,27 +5,25 @@ Install the ccls extension from the marketplace [here](https://marketplace.visua
If you run into issues, you can view debug output by running the If you run into issues, you can view debug output by running the
(`F1`) `View: Toggle Output` command and opening the `ccls` output section. (`F1`) `View: Toggle Output` command and opening the `ccls` output section.
To use the vscode-ccls extension without installing it, you can launch VS code from the comand-line with the name of the extension as a command argument: To use the vscode-ccls extension without installing it, you can launch VS code from the command-line with the path to local copy of vscode-ccls repository as a command argument.
Example: Example:
```bash ```bash
code vscode-ccls code vscode-ccls
``` ```
Then press F5 to launch a copy of vscode with the plugin temporarily installed. To use vscode-ccls, you can open your project in the new instance of vscode.
## Setting up the extension
You probably will want to configure the vscode-ccls plugin before initial use. You probably will want to configure the vscode-ccls plugin before initial use.
To access the configuration while running VS Code, this may be perfomed via the _Command Pallete_. To access the configuration while running VS Code, this may be performed via the _Command Pallete_.
(Hint: "Ctrl+Shift+P", or View->Command Pallete.), and enter the following text: (Hint: "Ctrl+Shift+P", or View->Command Pallete.), and enter the following text:
* `@ext:ccls-project.ccls` * `@ext:ccls-project.ccls`
Now you may start using the features of vscode-ccls with your development project.
* Open the project root with "Open Folder" (<kbd>C-k C-o</kbd>)
After changing some ccls configurations in `settings.json`, trigger the command `ccls: Restart language server` or reload the plugin to take effect. After changing some ccls configurations in `settings.json`, trigger the command `ccls: Restart language server` or reload the plugin to take effect.
## Setting up the extension
To tell the extension where to find ccls, either add ccls to your `PATH` or set "ccls.launch.command" in User Settings to the absolute path pointing to ccls. To tell the extension where to find ccls, either add ccls to your `PATH` or set "ccls.launch.command" in User Settings to the absolute path pointing to ccls.
```json ```json
@ -69,6 +67,10 @@ In case `compile_commands.json` is located not in default place ($root)
In this case it is located in `$root/build/compile_commands.json` In this case it is located in `$root/build/compile_commands.json`
Now you may start using the features of vscode-ccls with your development project.
* Open the project root with "Open Folder" (<kbd>C-k C-o</kbd>)
### Semantic highlight ### Semantic highlight
<img src="https://raw.githubusercontent.com/MaskRay/ccls-static/master/vscode-ccls/highlight.webp" title="semantic highlight"> <img src="https://raw.githubusercontent.com/MaskRay/ccls-static/master/vscode-ccls/highlight.webp" title="semantic highlight">