Feature/vscode config #1

MarkoSagadin · 2024-04-18T08:59:17Z

Description

This PR adds a VSCode configuration files and accompanying documentation.

Closes #18

Areas of interest for the reviewer

I would like to ask reviewers to clone this repo to their machines, checkout the feature/vscode_config branch and try to setup the VSCode by following the instructions in the README.md.

I would like you to spend some time using this configuration and see, if it is suitable for our use.
If you see that something that should be added/changed/removed, don't hesitate to mention it.

My main goal with this configuration is that provides a good solid editor base for our developers

After-review steps

I will merge PR by myself.

MarkoSagadin · 2024-04-18T11:12:37Z

@vid553 @NejcKle @TjazVracko

I should be more explicit on how to test this:

before testing this disable settings sync on your VSCode account.
backup the mentioned folders
follow the setup instructions in the Readme

TjazVracko

Very nice!

You must also install clang-format in a script somewhere

TjazVracko · 2024-04-19T13:13:49Z

dotfiles/place_dotfiles.sh

You can remove all sudo calls here, you are modifying only the home directory.

TjazVracko · 2024-04-19T13:34:37Z

README.md

+   ./installation_scripts/install_vscode.sh
+   ```
+
+2. To install all extensions run:


Before step 2 all vscode instances must be closed!

TjazVracko · 2024-04-22T07:30:40Z

Some more probably usefull settings to add to settings.json:

  "explorer.confirmDelete": false,  // does not ask with popup when you want to delete files
  "window.titleBarStyle": "custom",  // Title bar matches your theme

    "editor.rulers": [100] // under the [c][cpp] section??

  "editor.inlineSuggest.enabled": true,  // This replaces the sugess

// You can use this to control which file types are enabled for copilot
"github.copilot.enable": {
    "*": true,
    "plaintext": false,
    "markdown": true,
    "scminput": false  // This is the git commit message box, haha.
  },

  "diffEditor.ignoreTrimWhitespace": false  // See all changes in whitespace when viewing diffs. So that you don't accidentally change some whitespace and then not see in in the diff view.


  // Maybe a bit to personal. This also highlights the word TEST:
 // (I suggest we add a guideline when to use TODO, FIXME, TEST and other such words.)
  "todohighlight.keywords": [
    {
      "text": "TEST:",
      "color": "#ff0000",
      "backgroundColor": "#30CB30",
      "overviewRulerColor": "grey"
    }
  ]

TjazVracko · 2024-04-22T11:03:41Z

@MarkoSagadin The snippets only work in c files, not in cpp files.

This can be fixed by either having a separate cpp.json file in the snippets folder, or by modifying the file associations settings:

  "files.associations": {
    "CMakeLists.txt": "cmake",
    "*.h": "c",
    "*.hpp": "c",
    "*.cpp": "c"
  },

TjazVracko · 2024-04-24T08:31:18Z

Vscode automatically detects most conf files to be YAML, and then proceeds to show a bunch of yaml sintax errors...

There must be a way to define file associations for conf files, which usually don't have file extension (like <boardname>_defconfig)

explore using the Kconfig extension from Nordic? - after a quick test this works out of the box with almost no settings changes. A build folder is the only required thing for it to work.
File associations:

  "files.associations": {
    "*_defconfig": "kconfig",
    "*.conf": "kconfig"
  },

TjazVracko · 2024-04-24T09:34:59Z

I also did a quick check of the nRF DeviceTree extension. It kinda works.
It requires a workspace setting "devicetree.zephyr": "<path to zephyr root>", which I was unable to configure using a relative path. So it would would have to be set for every project specifically.

The extensions shows errors and warning when viewing a DTS file and also support a GUI editor (think CubeMX). But how accurate/valid the information shown actually is I do not know (do not have time currently to check).

MarkoSagadin · 2024-04-26T12:53:02Z

@TjazVracko

I force-pushed a commit with requested changes. I added the settings that you suggested except the below ones, I think that they are too specific:

  "window.titleBarStyle": "custom",  // Title bar matches your theme
  "todohighlight.keywords": [
    {
      "text": "TEST:",
      "color": "#ff0000",
      "backgroundColor": "#30CB30",
      "overviewRulerColor": "grey"
    }
  ]

I added instructions for using Profile files. Check, if they are ok.

I also added most of the Nordic plugins except the main one.

vid553

Good work :)

I have evaluated this PR using Ubuntu 22.04.
Profile importing works great, I especially like the fact that you can choose which extensions it should install.
I had however problems when running extension installation script. The script didn't install any extensions and threw Buffer is deprecated error on each install attempt.

Comments on extensions:

the scripts didn't disable / uninstall Microsoft's c/c++ extension, which I think is not desired to be enabled?
I recommend adding the Code Spell Checker extension
Consider changing Github theme and Noctis extension to be optional as not every user wants to use any of those themes
I also think IntelliCode extension should be included as it provides code suggestions for python and TS/JS projects (writing this as I didn't get any suggestions using the setup that was made from this PR)
I also recommend adding isort extension which automatically sorts the imports for python
I also in RN projects use the extension React Native tools, please add it here as well

Settings:
Consider adding these settings:

"telemetry.telemetryLevel": "crash",
  "github.copilot.enable": {
    "markdown": true,
  },
  "git.autofetch": true,
  "terminal.integrated.defaultProfile.windows": "Command Prompt",
  "terminal.integrated.defaultProfile.osx": "zsh",
  "terminal.integrated.profiles.osx": {
    "zsh": {
      "path": "zsh",
      "args": [
        "-l",
        "-i"
      ]
    },
  },

vid553 · 2024-04-28T17:31:53Z

dotfiles/.config/Code/User/settings.json

+    "editor.detectIndentation": false,
+    "editor.tabSize": 8,
+    "editor.insertSpaces": false,
+    "editor.rulers": [


I think this should be removed as it's too specific.

Only editor.rulers

I will remove it.

vid553 · 2024-04-28T18:04:09Z

dotfiles/.config/Code/User/settings.json

+  "debug.focusWindowOnBreak": false,
+  "debug.focusEditorOnBreak": false,
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"


this is wrong, it should be:

"[markdown]": { "editor.defaultFormatter": "yzhang.markdown-all-in-one" }

This is on purpose. Prettier works much better for formatting the markdowns than markdownlint does.

MarkoSagadin · 2024-04-29T09:56:52Z

@vid553

I had however problems when running extension installation script. The script didn't install any
extensions and threw Buffer is deprecated error on each install attempt.

I have seen this warning on my side as well, but the extensions were installed anyway. This might be
a difference between MacOS and Linux.

the scripts didn't disable / uninstall Microsoft's c/c++ extension, which I think is not desired
to be enabled?

If scripts are used they should be used on a completely clean VSCode setup. They won't uninstall
anything by default. The C/C++ extension is actually disabled in the settings.json:
"C_Cpp.intelliSenseEngine": "disabled", (it must be so that is not fighting with the Clangd).

Did you back up your existing configuration before trying scripts?

I recommend adding the Code Spell Checker extension

We have the tekumara.typos-vscode extension that does the same thing. Benefit of using this one is
that is using the same typos tool that our pre-commit does.

Consider changing Github theme and Noctis extension to be optional as not every user wants to use
any of those themes.

They are only installed but not configured to be used (the used theme is the VSCode default one,
"Default Dark Modern"). Should I remove them from the install_extensions.sh script?

I also think IntelliCode extension should be included as it provides code suggestions for python
and TS/JS projects (writing this as I didn't get any suggestions using the setup that was made
from this PR)

I will add it, I was not aware of it.

I also recommend adding isort extension which automatically sorts the imports for python

So, this extension is supported in Ruff and is also already enabled in our ruff.toml file that is provided with the irnas-zephyr-template (see line 5).

To have the consistent formatting in your Python files just copy the ruff.toml into your project's
root dir and it will work.

I also in RN projects use the extension React Native tools, please add it here as well.

I have added it.

Consider adding these settings:

Our Copilot setting already does what you want so that is ok. I will make
"telemetry.telemetryLevel": "none", (thank you for that I was not aware of it).

Everything else I would say that is personal preference, and should be added explicitly by the user.

infra: add initial project structure and pre-commit files

e15533e

github-actions bot added the pull request Pull request, added automatically by CI. label Apr 18, 2024

MarkoSagadin requested review from NejcKle, TjazVracko and vid553 April 18, 2024 10:21

MarkoSagadin force-pushed the feature/vscode_config branch 3 times, most recently from bb4769b to b7c121e Compare April 18, 2024 11:38

NejcKle approved these changes Apr 18, 2024

View reviewed changes

TjazVracko requested changes Apr 19, 2024

View reviewed changes

MarkoSagadin force-pushed the feature/vscode_config branch 3 times, most recently from 5dc5924 to 4dec3ea Compare April 26, 2024 12:52

MarkoSagadin requested a review from TjazVracko April 26, 2024 12:53

vid553 approved these changes Apr 29, 2024

View reviewed changes

MarkoSagadin force-pushed the feature/vscode_config branch from 4dec3ea to 23bc74a Compare April 29, 2024 10:00

feat: add VSCode config files and docs

514b1cd

MarkoSagadin force-pushed the feature/vscode_config branch from 23bc74a to 514b1cd Compare April 29, 2024 11:07

MarkoSagadin merged commit 564b029 into main Apr 30, 2024

MarkoSagadin deleted the feature/vscode_config branch April 30, 2024 10:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/vscode config #1

Feature/vscode config #1

MarkoSagadin commented Apr 18, 2024

MarkoSagadin commented Apr 18, 2024 •

edited

Loading

TjazVracko left a comment

TjazVracko Apr 19, 2024

TjazVracko Apr 19, 2024

TjazVracko commented Apr 22, 2024 •

edited

Loading

TjazVracko commented Apr 22, 2024 •

edited

Loading

TjazVracko commented Apr 24, 2024 •

edited

Loading

TjazVracko commented Apr 24, 2024

MarkoSagadin commented Apr 26, 2024

vid553 left a comment

vid553 Apr 28, 2024

vid553 Apr 29, 2024

MarkoSagadin Apr 29, 2024

vid553 Apr 28, 2024

MarkoSagadin Apr 29, 2024

MarkoSagadin commented Apr 29, 2024 •

edited

Loading

Feature/vscode config #1

Feature/vscode config #1

Conversation

MarkoSagadin commented Apr 18, 2024

Description

Areas of interest for the reviewer

After-review steps

MarkoSagadin commented Apr 18, 2024 • edited Loading

TjazVracko left a comment

Choose a reason for hiding this comment

TjazVracko Apr 19, 2024

Choose a reason for hiding this comment

TjazVracko Apr 19, 2024

Choose a reason for hiding this comment

TjazVracko commented Apr 22, 2024 • edited Loading

TjazVracko commented Apr 22, 2024 • edited Loading

TjazVracko commented Apr 24, 2024 • edited Loading

TjazVracko commented Apr 24, 2024

MarkoSagadin commented Apr 26, 2024

vid553 left a comment

Choose a reason for hiding this comment

vid553 Apr 28, 2024

Choose a reason for hiding this comment

vid553 Apr 29, 2024

Choose a reason for hiding this comment

MarkoSagadin Apr 29, 2024

Choose a reason for hiding this comment

vid553 Apr 28, 2024

Choose a reason for hiding this comment

MarkoSagadin Apr 29, 2024

Choose a reason for hiding this comment

MarkoSagadin commented Apr 29, 2024 • edited Loading

MarkoSagadin commented Apr 18, 2024 •

edited

Loading

TjazVracko commented Apr 22, 2024 •

edited

Loading

TjazVracko commented Apr 22, 2024 •

edited

Loading

TjazVracko commented Apr 24, 2024 •

edited

Loading

MarkoSagadin commented Apr 29, 2024 •

edited

Loading