|
|
[[_TOC_]]
|
|
|
|
|
|
# Setting Up Visual Studio Code for ELT DevEnv
|
|
|
This is a setup to configure and work on an ELT project using VSCode (or maybe [VSCodium](https://vscodium.com/)?).
|
|
|
This setup contemplates configuring C/C++ and (maybe one day) Python. The user will be able to connect to a remote ELTDEV workstation and work on his project from a local VSCode instance. WAF should have a proper integration when the configuration is finished.
|
|
|
|
|
|
*_Note: This is a work in progress, and I'm no way an expert on VSCode. Please share your findings to improve this documentation_*
|
|
|
|
|
|
## Summary
|
|
|
Following this document, you'll be able to:
|
|
|
- Create a proper [C/C++ configuration](#configure-cc-extension) for the C/C++ Extension on `.vscode/c_cpp_properties.json` file
|
... | ... | @@ -15,11 +15,11 @@ A few steps needs to be done on VSCode and in the ELT DevEnv where you want to w |
|
|
Installing extensions is not covered here, but the easiest way is to install them directly from VSCode Extension Tab (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>), you can also have a look at [Install Extension to Remote Host](#install-extension-to-remote-host)
|
|
|
|
|
|
1. Install [VSCode](https://code.visualstudio.com/) on your own PC. Maybe you want to have a look at [VSCode Getting Started page](https://code.visualstudio.com/docs/getstarted/introvideos) or [VSCode shortcuts](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf)
|
|
|
2. VSCode: Install extension [Remote SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
|
|
|
2. VSCode: Install extension [Remote SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh) - This extension is recommended since x11 forwarding has problems [Check Info](https://github.com/microsoft/vscode/issues/5243)
|
|
|
3. VSCode: Install Extension [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) on the Remote DevEnv Host
|
|
|
4. VSCode: Install Extension [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) on on the Remote DevEnv Host
|
|
|
5. DevEnv: Clone your project in your ELT DevEnv remote environment.
|
|
|
6. DevEnv: [Create compile_commands.json file](/CompilationDatabase/CompilationDatabase.md) by using `waf clangdb` on your project folder. Remember it has to be done after `waf configure`.
|
|
|
6. DevEnv: Create `compile_commands.json` file by using `waf clangdb` on your project folder. Remember it has to be done after `waf configure`.
|
|
|
|
|
|
# Configure C/C++ Extension
|
|
|
[Open your project](#opening-a-project-with-the-remote-ssh-extension). Make sure it is opened where the first `wscript` file is.
|
... | ... | |