VSCode Setup and Usage

Installation

Download from here

Installation Options

Accept the default installation path
keep “Register Code as an editor for supported file types” checked
keep “Add to PATH” checked
other options: set to your preference

Ubuntu-specific

cd ~/Downloads
sudo dpkg -i code_1.7* #.... tab complete
sudo apt install -yf

Useful command-line arguments

Note: this only works if you added vscode to your system PATH

Usage: code [options][paths...]

Example:

code -n ~/websites/danb0b.github.io/

will open a new folder with that path loaded in the explorer window

  -a --add <folder>      Add folder(s) to the last active window.
  -n --new-window        Force to open a new window.
  -r --reuse-window      Force to open a file or folder in an already opened window.
  --extensions-dir <dir> Set the root path for extensions.
  --list-extensions      List the installed extensions.
  --show-versions        Show versions of installed extensions, when using --list-extensions.
  --install-extension <ext-id | path> Installs or updates an extension. 
  --uninstall-extension <ext-id>      Uninstalls an extension.
  --enable-proposed-api <ext-id>      Enables proposed API features for
  --disable-extensions            Disable all installed extensions.
  --disable-extension <ext-id>    Disable an extension.
  --sync <on | off>               Turn sync on or off.

Shortcuts

Key Combination	Description
ctrl+shift+p	opens the command window
ctrl+shift+e	opens explorer
ctrl+shift+x	opens extensions
ctrl+shift+g	opens git
ctrl+shift+f	opens search
ctrl+shift+k	remove line
ctrl+shift+/	comment line:
ctrl+up	move line up
ctrl+down	move line down
ctrl+k,v	preview
ctrl+shift+i	format document
ctrl+i	italicize selection
ctrl+b	bold selection
alt+z	switch text wrap mode

Extensions

from here

open a terminal window and paste the following in:

code --install-extension bierner.markdown-yaml-preamble
code --install-extension DavidAnson.vscode-markdownlint
code --install-extension James-Yu.latex-workshop
code --install-extension ms-python.python
code --install-extension ms-python.vscode-pylance
code --install-extension ms-toolsai.jupyter
code --install-extension ms-toolsai.jupyter-keymap
code --install-extension ms-toolsai.jupyter-renderers
code --install-extension ms-toolsai.vscode-jupyter-cell-tags
code --install-extension ms-toolsai.vscode-jupyter-slideshow
code --install-extension PKief.markdown-checkbox
code --install-extension Pycom.pymakr-preview
code --install-extension redhat.vscode-yaml
code --install-extension shd101wyy.markdown-preview-enhanced
code --install-extension streetsidesoftware.code-spell-checker
code --install-extension tamasfe.even-better-toml
code --install-extension tecosaur.latex-utilities
code --install-extension torn4dom4n.latex-support
code --install-extension yzane.markdown-pdf
code --install-extension yzhang.markdown-all-in-one

code --list-extensions

Markdown all-in-one

go to settings @id:editor.defaultFormatter @lang:markdown formatter ctrl_+ shift + I then formats your document

Python

When working with multiple python environments, you should make sure to use the correct one for the task you are doing. To do this, you will need to select from a list of python interpreters. Type ctrl+shift+p then type / select “python select interpreter” from the list.

Debugging Python Code

see this reference to add a debug configuration

pymaker

install pymakr preview

code --install-extension Pycom.pymakr-preview

Getting Started with Pymakr (from here)

In File explorer(ctrl+shift+e)
1. add or create a project folder for holding your micropython code (suggestion: name it “micropython”). Consider creating one in your “code” git repository.
navigate to “Pymakr: Projects” tab in the workspace explorer window on the left
1. select “create project”. Select the same code folder as above and specify a project name (like “hello-world”). Select the option to create a subdirectory with the micropython folder.
2. Connect your device via usb to your computer
3. Within the “hello-world” project that is created within the “Pymakr: Projects” tab, add a new device. Follow the prompts to select the appropriate com port
4. Connect to the device by selecting the lightning bolt icon
5. Open up a terminal window by selecting the box with an arrow in it
6. A terminal window should open and look like this:
```
MicroPython v1.19.1 on 2022-06-18; ESP32 module with ESP32
Type "help()" for more information.
>>>
```
7. At the command prompt, type in
```
print('hello world')
```
  which should return
```
hello world
```
8. If you wish to disconnect, you can use:

Working with Micropython

Micropython can either run code from the interpreter (the “terminal” as VSCode puts it), or by loading a file from its onboard storage. When the ESP32 is reset (using the EN button), it looks for two files, in a specific order:

boot.py
main.py

if there are any loops in these files that prevent execution from ending, you must type ctrl+c to terminate execution from the interpreter window. This will stop any python files from running and bring control back to the interpreter

You must always stop execution on the ESP32 before trying to upload files to it.

Saving files to/from the ESP32

Within the “Pymakr: Projects” workspace there are several other buttons that you can use to sync files to the esp32

Upload project to device: Uploads all your project files to the device
Download project from device: Pulls files off the device
Open in Explorer: This opens up the ESP32 as a virtual file system in the file explorer and allows you to investigate and work with the file system directly.

From the file explorer window, you can also right click and select “pymakr–>upload to device” to upload individual files

External Resources

Keybindings

these are typically located in ~/.config/Code/User/keybindings.json

recent settings here

User Settings

located in ~/.config/Code/User/settings.json

recent settings here

All-in-one config

you can modify to suit…

mypath="$(echo $HOME)/.config/Code/User/" && \
cp "$(echo $mypath)settings.json" "$(echo $mypath)settings.json.bak" && \
cp "$(echo $mypath)keybindings.json" "$(echo $mypath)keybindings.json.bak" && \
curl https://danaukes.com/notebook/vscode-setup/settings.json -o "$(echo $mypath)settings.json" && \
curl https://danaukes.com/notebook/vscode-setup/keybindings.json -o "$(echo $mypath)keybindings.json"