VS Code extension pack and settings for CamiTK developers
As a | CEP developer |
I would like to | have guideline and default settings for Visual Studio Code / codium |
So that | I can quickly start and efficiently develop my CamiTK extension |
Description / Overview
This should supersede Issue #143 (closed).
VS Code / Codium is more and more used among developers, including C++ developers. It has many advantages over previous recommended solution (e.g., KDevelop, Visual Studio):
- it supports both Linux and Windows the same way
- it is versatile as you can use it to write code, markdown documentation or report, article with LaTeX...
- it can be used to develop inside docker containers
- it integrates every tools that makes it easier for developer (debugger, git...)
It would be nice for developers if the CamiTK team recommend a list of extension and/or provide a default VS code
configuration file that sets everything up.
Hints
List of currently used and recommended (to cleanup/update/verify/classify in subcategories):
- MS C/C++ / MS C/C++ Extension pack
- native debug
- CMake Tools and CMake
- astyle + astyle configuration (in
${workspaceRoot}/.vscode/astylerc
) - TODO highlight
- MS Dev Containers
- Git : git graph ???, GitLab Workflow???, GitLens ???
We can also have recommandation for other categories such as: markdown preview enhanced, markdownlint, LTeX grammar check, Atom One light theme, better C++ syntax, bookmarks, code spell checker, docker, LaTeX Workshop, project manager, Paste image, how to install plantuml local server, ...
See also old internal doc
Acceptance tests
A progressive list of deliverables
-
Website page describing the recommended extensions -
add the command to install the extensions (from the command line and from inside code) in the website page -
add the recommended way to install VS code and codium depending on the OS -
create a CamiTK extension pack see this or that -
configuration template in the CamiTK Community Edition source (something like .vscode/.vscode-template
or at the user level in~/.config
) -
configuration template .devcontainer
for working inside docker containers