TSYS Group - Engineering Documentation - Visual Studio Code Environment Setup Guide

• TSYS Group - Engineering Documentation - Visual Studio Code Environment Setup Guide
  • Introduction
    • Environmental considerations/assumptions
  • Short version
  • Requirements and dependencies
    • Software Programs Used
    • Languages Used
    • Deployment Targets
    • General setup
  • Plugins - Team-*
    • General Tooling
    • Docker / k8s
    • Git
    • Remote development/debug
    • Cross Compile / Remote Debug
    • Markdown
    • Bash
  • Plugins - Team-SWEng
    • YAML
    • C/C++
      • Arduino/Seeduino
      • CUDA
    • Java
    • PHP
    • Geospatial
    • Python
  • Plugins - Team-MechEng
    • Octave
    • R
    • Jupyter
    • STL
    • G-code
    • Gerber

Introduction

This is the TSYS Visual Studio Code setup guide. It covers how to setup VsCode for all aspects of TSSY Group.

We have a very complex total stack, but don't despair, you will only need a small subset of this.

Which subset of course depends on what part of the TSYS mission you are supporting!

Environmental considerations/assumptions

• Charles setup is the most comprehensive, as he is the CTO and has/does need to develop for all pieces of the stack/products.

• Do not just blindly follow this guide! Pick the pieces you need for your work. If you have any questions, ask in Discord or post to Discourse.

• Working against a remote server/container/k8s cluster over SSH via VsCode Remote

• VsCode Remote Dev is heavily utilized (almost if not exclusively)

• Source code resides in home directory on the server farm, but is edited "locally" on your workstation with VsCode (Remote)

• Using TSYS self hosted Gitea git instance

• Using TSYS self hosted Jenkins CI

• docker/kubectl commands are present and configured to run against the cluster (and you are connected to the VPN)

• Developing in Windows 10/Mac OSX/Linux with a GUI environment running native VsCode (CNW daily driver is a raspberry pi 4 with 8gb ram to help ensure lowest common denominator support/good performance)

• Using Chrome web browser (firefox/safari may work, but are not supported at all)

• Developing primarily at the "git push, magic happens" abstraction layer

• Need to occasionally inspect/debug the magic at various stages of the pipeline

• Need to frequently debug running code on a variety of targets (pi/arduino etc)

• All text documentation is written in Markdown and is posted to Git/Discourse as Markdown

• (tbd soon, actively experimenting) All diagrams are produced using (blockdiag? uml? markdown? all the above? extension(s))

Short version

very soon (may 2021) you'll have two options for EZ stack deployment for your product development environment :

1. docker pull TSYSVSC and use with https://code.visualstudio.com/docs/remote/containers

2. Browse to https://desktop.turnsys.com and get a full engineering stack for whatever product you are working on.

Read on to understand the pieces and particulars in case you want to build your own setup.

Requirements and dependencies

Here is the tool and language requirements of all the TSYS engineering projects/programs/products.

Software Programs Used

You'll need to setup some subset of the tools below todo your job (in addition to VsCode), and also use VsCode with various TSYS hosted services like Gitea, Jenkins and Docker/K3s.

Setup of external tools is outside the scope of this document. For guidance on tool setup, please see the following links:

• https://git.turnsys.com/mrcharles/dotfiles/
• https://git.turnsys.com/MorseFlyer/docs
• https://git.turnsys.com/TSGTechops/docs-techops

This software has two modes of deployment:

• downloaded from the vendor and setup on your physical workstation (used for dev/testing/experimenting)
• downloaded from the /subo directory and ran on your physical workstation or run from the /subo directory on a virtual workstation you login to remotely

The software that is built/deployed in /subo is the only version approved for production use.

The exception to that is if it has an OTS notation next to it's name, in which case you can use the latest stable version from the vendor.

Once you've setup your needed external tools, return to this document and continue with setup of VsCode as needed to work with the tooling you installed.

Languages Used

Deployment Targets

General setup

These are steps you need to take before starting development in earnest.

Linux (or at least a mostly linux (WSL/mobaxterm)) environment is presumed for all the below.

You may well find GUI replacements and use them, especially on Windows/MACOSX. They are not supported in any way.

• Setup gitea
  • Login once to https://git.turnsys.com so you can be added to the appropriate repos/teams/orgs.
  • Customize any profile etc settings that you wish.
• Setup SSH
  • Setup SSH key
  • Add SSH public key to gitea
• Setup git
  • For all git users:
    • $ git config --global user.name "John Doe"
    • $ git config --global user.email johndoe@example.com
    • Setup git lg : git config --global alias.lg "log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit"
  • for zsh users (and you really should use zsh/oh-my-zsh :)
    • git config --add oh-my-zsh.hide-status 1
    • git config --add oh-my-zsh.hide-dirty 1

Plugins - Team-*

The plugins documented here are known to work, and are in active/frequent use by Charles as CTO as he hacks on the stack. Other options exist for almost all the below. If you find something that works better for you, use it!

Consider the below as a suggested/supported baseline.

General Tooling

• Code Spell Checker https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
• Vim https://marketplace.visualstudio.com/items?itemName=vscodevim.vim

Docker / k8s

• Docker:
  • https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker
  • https://code.visualstudio.com/docs/containers/overview
• Docker explorer https://marketplace.visualstudio.com/items?itemName=formulahendry.docker-explorer
• Bridge to K8s https://marketplace.visualstudio.com/items?itemName=mindaro.mindaro https://code.visualstudio.com/docs/containers/bridge-to-kubernetes

Git

• Git Extension Pack https://marketplace.visualstudio.com/items?itemName=donjayamanne.git-extension-pack
• Git Tree Compare https://marketplace.visualstudio.com/items?itemName=letmaik.git-tree-compare
• Git Tags https://marketplace.visualstudio.com/items?itemName=howardzuo.vscode-git-tags
• Gitea-VsCode https://marketplace.visualstudio.com/items?itemName=ijustdev.gitea-vscode

Remote development/debug

THis is used regularly by Techops and Charles and is well supported.

• https://code.visualstudio.com/docs/remote/remote-overview
• https://code.visualstudio.com/docs/remote/ssh

Cross Compile / Remote Debug

• https://dimamoroz.com/2021/03/09/intel-nuc-for-development/
• https://github.com/Ed-Yang/rpidebug
• https://enes-ozturk.medium.com/remote-debugging-with-gdb-b4b0ca45b8c1
• https://enes-ozturk.medium.com/cross-compiling-with-cmake-and-vscode-9ca4976fdd1

Markdown

• Gitdoc https://marketplace.visualstudio.com/items?itemName=vsls-contrib.gitdoc
• Markdown All in One https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
• Markdown Preview Enhanced https://shd101wyy.github.io/markdown-preview-enhanced/
• markdownlint https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
• PlantUML
  • https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml
  • https://www.freecodecamp.org/news/inserting-uml-in-markdown-using-vscode/

Bash

• https://marketplace.visualstudio.com/items?itemName=mads-hartmann.bash-ide-vscode

Plugins - Team-SWEng

YAML

• https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml

C/C++

• https://ludwiguer.medium.com/configure-visual-studio-code-to-compile-and-run-c-c-3cef24b4f690
• https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack0
• https://marketplace.visualstudio.com/items?itemName=formulahendry.code-runner

Arduino/Seeduino

-_https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.vscode-arduino

CUDA

TBD. Pull requests welcome.

Java

• https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack

PHP

• https://github.com/cytopia/devilbox/blob/50ab236ea9780e6c3ba35d357a451d48aba9a5d2/docs/intermediate/configure-php-xdebug/linux/vscode.rst

Geospatial

• https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer

Python

• https://marketplace.visualstudio.com/items?itemName=ms-python.python

Plugins - Team-MechEng

Octave

TBD. Pull requests welcome.

R

TBD. Pull requests welcome.

Jupyter

• https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter

STL

• https://marketplace.visualstudio.com/items?itemName=xdan.stlint-vscode-plugin
• https://marketplace.visualstudio.com/items?itemName=md2perpe.vscode-3dviewer
• https://marketplace.visualstudio.com/items?itemName=slevesque.vscode-3dviewer

G-code

TBD. Pull requests welcome.

Gerber

TBD. Pull requests welcome.