Add support for VSCode (UBC-Thunderbots#1824)

* wip debugging not working

* remove debugging support

* remove running stuff through vscode

* Update getting-started.md

Author: akhilveeraghanta

.gitignore

@@ -34,11 +34,13 @@ Makefile
 .setting/
 
 # VSCode
-.vscode/
+.vscode/.*
+!.vscode/extensions.json
 
 # Vim
 *.swo
 *.swp
+src/compile_commands.json
 
 # Stuff generated by vimdiff
 *_BACKUP_*.txt

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "ms-vscode.cpptools",
+        "bazelbuild.vscode-bazel",
+        "ms-python.python"
+    ]
+}
+

docs/getting-started.md

@@ -18,6 +18,7 @@
    * [Installing CLion](#installing-clion)
       * [Getting your Student License](#getting-your-student-license)
       * [Installing CLion](#installing-clion-1)
+   * [Installing VSCode](#installing-vscode)
 * [Building and Running the Code](#building-and-running-the-code)
 * [Debugging](#debugging)
 * [Profiling](#profiling)
@@ -89,7 +90,7 @@ We have several setup scripts to help you easily install the necessary dependenc
 
 ### Installing CLion
 
-CLion is our main IDE for editing our C/C++ code. It is designed to work with our build system, `bazel`, and has all the great features of an IDE such as code completion, syntax highlighting etc. We **strongly** recommend installing CLion and using it for development.
+CLion is our main IDE for editing our C/C++ code. It is designed to work with our build system, `bazel`, and has all the great features of an IDE such as code completion, syntax highlighting etc. If you are running Software on an ultrabook or a virtual machine, see [Installing VSCode](#installing-vscode) for a less resource intensive option.
 
 #### Getting your Student License
 
@@ -105,6 +106,15 @@ CLion is free for students, and you can use your UBC alumni email address to cre
 * Run `./install_clion.sh` (* **DO NOT** download CLion yourself unless you know what you're doing. The `install_clion.sh` script will grab the correct version of CLion and the Bazel plugin to ensure everything is compatible *).
 * When you run CLion for the first time you will be prompted to enter your JetBrains account or License credentials. Use your student account.
 
+### Installing VSCode
+
+1. Inside a terminal, navigate to the environment_setup folder. Eg. `cd path/to/the/repository/Software/environment_setup`
+2. Run `./install_vscode.sh` (* **DO NOT** download VSCode yourself unless you know what you're doing. The `install_vscode.sh` script will grab the most stable version of VSCode)
+3. Open `vscode`. You can type `vscode` in the terminal, or click the icon on your Desktop.
+&. Click `Open Folder` and navigate to where you cloned software. So if I cloned the repo to `/home/my_username/Downloads/Software`, I would select `/home/my_username/Downloads/Software`.
+4. VSCode will prompt you to install recommended extensions, click `Install`, this installs necessary plugins to work on the codebase. (Bazel, C++, Python, etc..)
+5. Navigate to File -> Preferences -> Settings -> Workspace -> Extensions -> Bazel and select the `Bazel: Enable Code Lens` option.
+
 ## Building and Running the Code
 
 ### From the command-line
@@ -129,7 +139,6 @@ First we need to setup CLion
 6. Change the Project Name to whatever you want. Leave everything else as it is ("Use shared project view file" should be selected).
 7. Click `Finish` and you're good to go! Give CLion some time to find everything in your repo.
 
-
 Now that you're setup, if you can run it on the command line, you can run it in clion. There are two main ways of doing so.
 1. Open any `BUILD` file and right clight in a `cc_library()` call. This will give you the option to `Run` or `Debug` that specific target. Try it by opening `Software/src/software/geom/BUILD` and right-clicking on the `cc_library` for `angle_test`!
 2. Add a custom build configuration (more powerful, so make sure you understand this!)
@@ -138,6 +147,12 @@ Now that you're setup, if you can run it on the command line, you can run it in
     3. For `Target Expression`, you can put anything that comes after a `build`, `run`, `test`, etc. call on the command line. For example: `//software/geom:angle_test`.
     4. For `Bazel Command` you can put any bazel command, like `build`, `run`, `test`, etc.
     5. Click `Ok`, then there should be a green arrow in the top right corner by the drop-down menu. Click it and the test will run!
+ 
+### With VSCode
+1. Open VSCode
+2. Navigate to `Software/src/software/geom/BUILD`
+3. On top of every `cc_test`, `cc_library` and `cc_binary` there should be a `Test ...`, `Build ...` or `Run ...` for the respective target.
+4. Click `Test //software/geom:angle_test` to run the `angle_test`
 
 ### Running our AI, Simulator or Robot Diagnostics
 

environment_setup/install_vscode.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+echo "================================================================"
+echo "Installing VSCode"
+echo "================================================================"
+
+if [ "$EUID" -ne 0 ]
+  then echo "Please run as root"
+  exit
+fi
+
+if [ -d "/opt/VSCode-linux-x64" ] 
+then
+    echo "Old VSCode installation detected, please delete /opt/VSCode-linux-x64 and re-run" 
+    exit 1
+fi
+
+# permalink obtained from here: https://github.com/microsoft/vscode/issues/1084
+download_permalink_linux64=http://go.microsoft.com/fwlink/?LinkID=620884
+vscode_executable_path="/usr/local/bin/vscode"
+
+echo "Downloading Stable VSCode"
+wget -O /tmp/vscode-stable.tar.gz $download_permalink_linux64
+
+echo "Unzipping to /opt folder"
+tar -xvf /tmp/vscode-stable.tar.gz -C /opt
+
+echo "Creating Desktop Entry"
+
+VSCODE_DESKTOP_ENTRY='''
+[Desktop Entry]
+Name=Visual Studio Code
+Comment=Programming Text Editor
+Exec=/opt/VSCode-linux-x64/code
+Icon=/opt/VSCode-linux-x64/resources/app/resources/linux/code.png
+Terminal=false
+Type=Application
+Categories=Programming;
+'''
+echo "$VSCODE_DESKTOP_ENTRY" > ~/.local/share/applications/vscode.desktop
+
+echo "Symlink VSCode"
+sudo ln -s -f /opt/VSCode-linux-x64/code ${vscode_executable_path}
+
+echo "================================================================"
+echo "Done"
+echo "================================================================"