diff options
author | Craig Hesling <hesling@chromium.org> | 2020-12-11 11:26:46 -0800 |
---|---|---|
committer | Commit Bot <commit-bot@chromium.org> | 2020-12-14 20:28:17 +0000 |
commit | 25f715ec0a4dd41effdfa13cc377a9cee79b9d29 (patch) | |
tree | 4e7f99d205ee20963c84db9f0a4294dc29ac2b69 | |
parent | 5facd122c6ffad6ae31094ca6dd9e92c257c1390 (diff) | |
download | chrome-ec-25f715ec0a4dd41effdfa13cc377a9cee79b9d29.tar.gz |
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>
Signed-off-by: Abe Levkoy <alevkoy@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2590863
-rw-r--r-- | .gitignore | 6 | ||||
-rw-r--r-- | .vscode/README.md | 3 | ||||
-rw-r--r-- | .vscode/settings.json.default | 35 | ||||
-rw-r--r-- | docs/ide-support.md | 41 |
4 files changed, 49 insertions, 36 deletions
diff --git a/.gitignore b/.gitignore index 6532cf43ee..bb266eff45 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,9 @@ cscope.* .tests-passed .failedboards/ .sizes.txt + +# VSCode IDE +.vscode/* +!.vscode/README.md +!.vscode/settings.json.default +*.code-workspace diff --git a/.vscode/README.md b/.vscode/README.md new file mode 100644 index 0000000000..1e83806519 --- /dev/null +++ b/.vscode/README.md @@ -0,0 +1,3 @@ +# VSCode Setting + +See [docs/ide-support.md](/docs/ide-support.md). diff --git a/.vscode/settings.json.default b/.vscode/settings.json.default new file mode 100644 index 0000000000..1868e4f3af --- /dev/null +++ b/.vscode/settings.json.default @@ -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" + } +}
\ No newline at end of file diff --git a/docs/ide-support.md b/docs/ide-support.md index 022373042f..cec196be58 100644 --- a/docs/ide-support.md +++ b/docs/ide-support.md @@ -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: - - ```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" - } - } +5. Add the EC specific file associations and style settings. Do the following + to copy the default settings to `.vscode/settings.json`: + + ```bash + cp .vscode/settings.json.default .vscode/settings.json ``` |