Skip to content

checked in .vscode directory causing problems during local dev #4497

@jmhodges

Description

@jmhodges

It would be nice to not check in the .vscode directory into the repo and instead have some documentation in CONTRIBUTING on how to set it up for this repo.

I'm currently trying to develop in this repo with a fresh copy with VSCode. As soon as I open it in vscode, there are edits made automatically to the .vscode directory by vscode.

Any changes a developer makes to what extensions they've installed for the workspace, and any changes they make to any workspace-wide (that is, repo-wide) settings will be reflected in the .vscode directory.

For instance, here's the diff to .vscode/settings.json that happens as soon as I open this repo in vscode on my macos machine. Every developer will have to remember to remove these kinds of changes every time they submit a new PR to this repo.

diff --git a/.vscode/settings.json b/.vscode/settings.json
index d81fc004..a79f975e 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -23,10 +23,42 @@
       "tidy": false,
       "upgrade_dependency": false,
       "vendor": false
-    },
+    }
   },
   "go.useLanguageServer": true,
   "go.buildOnSave": "off",
   "go.lintOnSave": "off",
   "go.vetOnSave": "off",
+  "bazel.projectview.notification": false,
+  "bazel.projectview.open": false,
+  "files.exclude": {
+    "**/.git": true,
+    "**/.svn": true,
+    "**/.hg": true,
+    "**/.DS_Store": true,
+    "**/Thumbs.db": true,
+    "**/.classpath": true,
+    "**/.project": true,
+    "**/.settings": true,
+    "**/.factorypath": true,
+    ".bazelci": false,
+    ".bcr": false,
+    ".eclipse": false,
+    ".git": false,
+    ".github": false,
+    ".vscode": false,
+    "docs": false,
+    "examples": false,
+    "extras": false,
+    "go": false,
+    "internal": false,
+    "proto": false,
+    "tests": false,
+    "third_party": false,
+    "tools": false,
+    "bazel-bin": false,
+    "bazel-rules_go": false,
+    "bazel-testlogs": false,
+    "bazel-out": false
+  }
 }

(There's also some number of processes from vscode extensions that decided to fire up automatically from vscode that stalled out my bazel 8.4.2 server, but perhaps unrelated. I've not dug into that)

Are y'all comfortable with a PR removing .vscode, adding it to .gitignore, and add some docs to CONTRIBUTING about it?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions