Skip to content

Conversation

@AprilSylph
Copy link
Owner

@AprilSylph AprilSylph commented Jan 6, 2026

Description

Another little thing in my "hey let's make the repository more friendly to new contributors" crusade.

These are all the VS Code extensions I use when developing addons. Yes, all six of them.

I think being able to trivially configure your workspace to match that of the author-maintainer is useful, no?

This is committed via git add --force rather than modifying our gitignore file, so other changes to files in the .vscode/ directory remain untracked by default. This allows individuals to customise their workspace for this repository without their settings.json getting picked up by git and unintentionally pushed as part of a PR.

Testing steps

  1. Open this branch in VS Code
  2. Go to Extensions → "Search Extensions in Marketplace"
  3. Search for @recommended
    • Expected result: Six items appear under "Workspace Recommendations": ESLint, EditorConfig for VS Code, GitHub Theme, GitHub Actions, Git Graph, GitHub Pull Requests

(I assume that a fresh VS Code install would, upon starting up with this file committed, prompt to install these if they're not already installed; I can make no assumptions about your install, so I don't know if you'll be prompted!)

@marcustyphoon
Copy link
Collaborator

I don't know offhand what git add --force does; I can look for documentation, but do you have any offhand?

Alternatively, does it make more sense to unignore this specific file in .gitignore?

@AprilSylph
Copy link
Owner Author

git add --force just ignores gitignore. If anyone makes any changes to this file in order to customise their workspace, because the file is still gitignored, their changes won't be tracked by git unless they too use git add --force. It's useful for this exact scenario where we want to provide a default but don't care about the file beyond that.

@marcustyphoon
Copy link
Collaborator

Hm. Unless github desktop is doing unusual checkout and stage commands, I don't think that works.

@AprilSylph
Copy link
Owner Author

Hm. Unless github desktop is doing unusual checkout and stage commands, I don't think that works.

How do you mean? Do the file changes not show up when checking out this branch?

@marcustyphoon
Copy link
Collaborator

Didn't test that much yet, but I believe repo file changes overwrite existing content and local changes to files are tracked. That's been my experience in the past: .gitignore doesn't matter once a file is tracked. You can work around it on an individual basis (skip-worktree, or something?) but I never found a way to do it from the repo side.

@AprilSylph
Copy link
Owner Author

Ah! That's... interesting, and unexpected. Let me play with it.

@AprilSylph AprilSylph marked this pull request as draft January 6, 2026 11:53
@marcustyphoon
Copy link
Collaborator

I could definitely be wrong! But I'm trying to imagine how it would work if I am wrong. Presumably what you want is "a clone to an empty folder includes the file but a clone to a—

...okay, I'm not sure I actually know how to finish that sentence :D

@AprilSylph
Copy link
Owner Author

What I was going for was a committed version of doing git update-index --assume-unchanged .vscode/extensions.json, but that's not how .gitignore works at all.

@AprilSylph AprilSylph closed this Jan 6, 2026
@AprilSylph AprilSylph deleted the aprilsylph/vscode-extension-recommendations branch January 6, 2026 12:11
@AprilSylph
Copy link
Owner Author

Hm, closing this was silly. I made a bad assumption about the details (#2052 deserves to stay closed) but this file in particular shouldn't need to be touched by individual developers unless they're planning to propose new recommended extensions anyway.

@AprilSylph AprilSylph restored the aprilsylph/vscode-extension-recommendations branch January 6, 2026 14:40
@AprilSylph
Copy link
Owner Author

No changes to gitignore needed to continue to ignore other files in the .vscode/ directory.

@AprilSylph AprilSylph reopened this Jan 6, 2026
@AprilSylph AprilSylph marked this pull request as ready for review January 6, 2026 14:48
Copy link
Collaborator

@marcustyphoon marcustyphoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The extension page for git graph crashes in my vs code, so that's fun, but I don't think that's related to the PR :D

@AprilSylph AprilSylph merged commit f56d21c into master Jan 7, 2026
7 checks passed
@AprilSylph AprilSylph deleted the aprilsylph/vscode-extension-recommendations branch January 7, 2026 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants