fbaeuerlein / cpp-vscode-guide Goto Github PK

View Code? Open in Web Editor NEW

77.0 77.0 5.0 766 KB

A small guide for C/C++ developers to useful extensions to unleash the power of Visual Studio Code

License: Creative Commons Zero v1.0 Universal

Shell 100.00%

c cpp examples guide static-analysis tutorial visual-studio-code vscode

cpp-vscode-guide's People

Contributors

Stargazers

Watchers

Forkers

hboshnak 20083017 mdsaimonhafiz ttotal truongpham1997

cpp-vscode-guide's Issues

Configuration for clang-tidy with include paths

Clang tidy finds errors if the include paths are missing (e.g. at tests).
Find a possible configuration to avoid this

Static Analysis: IKOS

Evaluate IKOS (https://github.com/NASA-SW-VnV/ikos) and look for VSC integration.

Add https://code.visualstudio.com/docs/cpp/config-linux to references

Add c++ configuration to README.md

e.g. add compiler flags

see: https://code.visualstudio.com/docs/cpp/config-msvc#_cc-configurations

Create coverage workflow

Create workflow for coverage

build and run tests
run lcov accordingly (maybe via extension)

Example for task:

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Run lcov",
            "type": "shell",
            "command": "lcov --capture --directory .. --output-file lcov.info && lcov --remove lcov.info '/usr/*' '*/googletest/*' --output-file lcov.info", 
            "options": {
                "cwd": "${workspaceFolder}/build" }
        }, 
        
        {
            "label": "Run genhtml",
            "type": "shell",
            "command": "genhtml lcov.info --output-directory coverage", 
            "options": {
                "cwd": "${workspaceFolder}/build" }
        }
    ]
}

Together with TaskRunner extension a nice idea ...

https://code.visualstudio.com/docs/editor/tasks#_next-steps

Create debug section

Add debugging related stuff:

https://devblogs.microsoft.com/cppblog/visual-studio-code-c-extension-july-2020-update-doxygen-comments-and-logpoints/

Replace clang-format, clang-tidy, etc. with clangd

Possible settings.json configuration

"clangd.semanticHighlighting": true,
"clangd.checkUpdates": true,
"clangd.arguments": [
    "-clang-tidy",
    "--compile-commands-dir=${workspaceFolder}/build",        
    "--header-insertion=iwyu",
    // "--suggest-missing-includes", 
    "-log=verbose"
]

Seems not to work currently together with clang-tidy. No errors are displayed (e.g. nullptr deref). Maybe wait for update of ext or vscode.

Powerful tasks

add newline to all files (e.g. if compiler complains about it): https://unix.stackexchange.com/questions/31947/how-to-add-a-newline-to-the-end-of-a-file

Rework coverage Tasks

Some rework necessary:

Baseline creation for displaying non executed code (https://stackoverflow.com/questions/44203156/can-lcov-genhtml-show-files-that-were-never-executed)
Clean/Build -> Baseline -> Run tests -> Generate COV report

Working with legacy code

Extensions/Examples for working with legacy code bases

sourcetrail extension (https://github.com/CoatiSoftware/Sourcetrail)

Minor issues + additions

describe debugging feature of C++ Test Mate
extend lcov example with removal lcov --remove lcov.info '*/googletest/*' --output-file lcov.info (considered in #8)
add https://github.com/microsoft/vscode-cmake-tools/blob/develop/docs/README.md to CMake section
add https://cmake.org/cmake/help/latest/manual/ctest.1.html to CMake section
add https://code.visualstudio.com/docs/cpp/cpp-ide to VSCode CPP section

Restructuring in multiple READMEs and style

Restructure in multiple files
Look for a nice style/format

Add configuration to run valgrind via VS Code

Look for task/extension to run valgrind for tests

Maybe leave out, instead refer to sanitizers

Add links for sanitizer comparison: https://github.com/google/sanitizers/wiki/AddressSanitizerComparisonOfMemoryTools

User rights mismatch for remote container. Investigate how to use the same UID in container as on the host machine.

COV + ASan cmake-variants.yaml

Choosing two variants that define the same compiler flags are overwriting each other so that only one is used. Mention that in the documentation.

Rework embedding of referred images

Some images are not displayed, maybe not resolved due to content length error of github referer

Testing - gtest + TestMate

Link to test-source and codelens only works with gtest-1.8.0 or above!
Update description

Extensions to evaluate

mscgen:
~~- https://marketplace.visualstudio.com/items?itemName=arichika.previewseqdiag-vscode~~
~~- https://marketplace.visualstudio.com/items?itemName=mscgenjs.vscode-mscgen~~

plantuml:
~~- https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml~~ (included with 485ba3a)

Add working sample cmake-variants.yaml to .vscode

Some sample:


buildType:
  default: debug
  choices:
    debug:
      short: Debug
      long: Emit debug information
      buildType: Debug
    release:
      short: Release
      long: Optimize generated code
      buildType: Release


instrumentation:

  default: NoInstrumentation # no sanitizer/no instrumentation
  choices:

    NoSan:
      short: NoInstrumentation
      long: build without any instrumentation

    Coverage:
      short: Coverage
      long: build with coverage instrumentation
      settings:
        CMAKE_CXX_FLAGS: "-fprofile-arcs -ftest-coverage "
        CMAKE_C_FLAGS: "-fprofile-arcs -ftest-coverage"
        CMAKE_EXE_LINKER_FLAGS: "--coverage"

    ASan:
      short: ASan
      long: build with adresss sanitizer instrumentation
      settings:
        CMAKE_CXX_FLAGS: "-fsanitize=address -fno-omit-frame-pointer -fsanitize-address-use-after-scope"
        CMAKE_C_FLAGS: "-fsanitize=address -fno-omit-frame-pointer -fsanitize-address-use-after-scope"
        CMAKE_EXE_LINKER_FLAGS: "-fsanitize=address"

    TSan:
      short: TSan
      long: build with thread sanitizer instrumentation
      settings:
        CMAKE_CXX_FLAGS: "-fsanitize=thread"
        CMAKE_C_FLAGS: "-fsanitize=thread"
        CMAKE_EXE_LINKER_FLAGS: "-fsanitize=thread"