ide-support: Add vscode default settings.json and gitignores

This adds a .default settings.json file for vscode, so that you
do not need to copy/paste form the ide-support.md doc. This also
makes it easier for people that don't known that the ide-support.md
doc exists.

This also adds the .vscode directory to the gitignores, so that local
customization/settings are not always in the git status.

BRANCH=none
BUG=none
TEST=Checked in Gitiles
TEST=Check that my settings.json is not in "git status".
TEST=Check that ec.code-workspace is not in "git status".

Change-Id: I4dd8cfcd79c291a6f4fb0d573df131f0cb0d9844
Signed-off-by: Craig Hesling <hesling@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2586041
Commit-Queue: Jett Rink <jettrink@chromium.org>
Reviewed-by: Jett Rink <jettrink@chromium.org>
This commit is contained in:
Craig Hesling 2020-12-11 11:26:46 -08:00 committed by Commit Bot
parent d76cd68529
commit bce4e485bb
4 changed files with 48 additions and 35 deletions

6
.gitignore vendored
View File

@ -11,3 +11,9 @@ cscope.*
.tests-passed
.failedboards/
.sizes.txt
# VSCode IDE
.vscode/*
!.vscode/README.md
!.vscode/settings.json.default
*.code-workspace

3
.vscode/README.md vendored Normal file
View File

@ -0,0 +1,3 @@
# VSCode Setting
See [docs/ide-support.md](/docs/ide-support.md).

35
.vscode/settings.json.default vendored Normal file
View File

@ -0,0 +1,35 @@
/* Copy this file to settings.json to active these defaults. */
{
"editor.rulers": [
80
],
/* C, Makefiles, ASM, Linkerfiles, Properties */
"editor.insertSpaces": false,
"editor.tabSize": 8,
/* Some exceptions based on current trends */
"[markdown]": {
"editor.insertSpaces": true,
"editor.tabSize": 2
},
"[python]": {
"editor.insertSpaces": true,
"editor.tabSize": 2
},
"[shellscript]": {
"editor.insertSpaces": true,
"editor.tabSize": 2
},
"[yaml]": {
"editor.insertSpaces": true,
"editor.tabSize": 2
},
"files.associations": {
"Makefile.*": "makefile",
"*.inc": "c",
"*.wrap": "c",
"*.tasklist": "c",
"*.irqlist": "c",
"*.mocklist": "c",
"*.testlist": "c"
}
}

View File

@ -49,40 +49,9 @@ includes selectable sub-configurations for every board/image pair.
can select a configuration by pressing `Ctrl-Shift-P` and selecting the
`C/C++ Select a Configuration...` option.
5. Add the EC specific file associations and style settings. Modify
`.vscode/settings.json` to have the following elements:
5. Add the EC specific file associations and style settings. Do the following
to copy the default settings to `.vscode/settings.json`:
```json
{
"editor.rulers": [80],
/* C, Makefiles, ASM, Linkerfiles, Properties */
"editor.insertSpaces": false,
"editor.tabSize": 8,
/* Some exceptions based on current trends */
"[markdown]": {
"editor.insertSpaces": true,
"editor.tabSize": 2
},
"[python]": {
"editor.insertSpaces": true,
"editor.tabSize": 2
},
"[shellscript]": {
"editor.insertSpaces": true,
"editor.tabSize": 2
},
"[yaml]": {
"editor.insertSpaces": true,
"editor.tabSize": 2
},
"files.associations": {
"Makefile.*": "makefile",
"*.inc": "c",
"*.wrap": "c",
"*.tasklist": "c",
"*.irqlist": "c",
"*.mocklist": "c",
"*.testlist": "c"
}
}
```bash
cp .vscode/settings.json.default .vscode/settings.json
```