Page MenuHomePhabricator

[chore] add recommended extensions for vscode users
ClosedPublic

Authored by benschac on Mar 15 2022, 7:03 AM.
Tags
None
Referenced Files
F3409849: D3428.diff
Wed, Dec 4, 6:55 PM
F3405383: D3428.diff
Tue, Dec 3, 8:41 PM
Unknown Object (File)
Fri, Nov 15, 9:01 AM
Unknown Object (File)
Fri, Nov 15, 9:01 AM
Unknown Object (File)
Fri, Nov 15, 9:01 AM
Unknown Object (File)
Thu, Nov 14, 8:53 AM
Unknown Object (File)
Thu, Nov 14, 8:53 AM
Unknown Object (File)
Oct 27 2024, 5:29 AM

Details

Summary

A recommended extensions for vscode users. Initial addition adds Editor config (https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) package to recommended list. Followed steps here: https://dev.to/askrishnapravin/recommend-vs-code-extensions-to-your-future-teammates-4gkb

Test Plan

Download project, open vscode, recommend prompt should appear in the bottom corner.

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

.vscode/extensions.json
2 ↗(On Diff #10380)

Came when the file was initialized. Wasn't sure if I should keep it or not.

atul requested changes to this revision.EditedMar 15 2022, 7:21 AM

That was quick! Looks good, but I think we should cut the comments and add the extensions we have in Notion in one go.

(Specifically: dbaeumer.vscode-eslint, esbenp.prettier-vscode, flowtype.flow-for-vscode, and EditorConfig.EditorConfig )

.vscode/extensions.json
2 ↗(On Diff #10380)

I think we can remove all of the comments, they don't provide much value imo?

I also don't think you're supposed to have comments in JSON files, but it looks like VSCode disregards this all over the place.

6 ↗(On Diff #10380)
This revision now requires changes to proceed.Mar 15 2022, 7:21 AM

remove comments, add additional packages

.vscode/extensions.json
5 ↗(On Diff #10384)

Was in the file so I added it.

atul requested changes to this revision.Mar 15 2022, 10:35 AM

I think this should be good to go after removing GitLens and vscode.typescript-language-features

.vscode/extensions.json
5 ↗(On Diff #10384)

I think we should remove GitLens, this was more of an opinionated personal recommendation and doesn't provide anything relevant to our specific project.

I think we should let the user configure their editor however they want and suggest the minimal amount of additional extensions directly relevant to the project (eg flow).

(The GitLens default config is also very "heavy," so I think we'd need to feel really strongly about it to justify including it)

9 ↗(On Diff #10384)

I think we can remove this for now.

My understanding is that when you open a directory in VSCode:

  1. VSCode will suggest extensions based on file extensions (eg Python extension if there's a .py file, Gradle extension if there's a .gradle file, etc)
  2. VSCode will suggest extensions based on the .vscode/extensions.json file (if it exists)

In neither situation will the vscode.typescript-language-features extension be suggested because it's a built-in extension (which I don't believe can even be uninstalled). So we aren't really doing anything with this line.

This revision now requires changes to proceed.Mar 15 2022, 10:35 AM
This revision is now accepted and ready to land.Mar 15 2022, 10:41 AM
This revision was landed with ongoing or failed builds.Mar 15 2022, 10:43 AM
This revision was automatically updated to reflect the committed changes.
.gitignore
14 ↗(On Diff #10398)

By removing this you're all going to have a bunch of untracked files in your working copy. You probably want to keep the .vscode folder ignored EXCEPT for .vscode/extensions.json, right?

By removing this you're all going to have a bunch of untracked files in your working copy. You probably want to keep the .vscode folder ignored EXCEPT for .vscode/extensions.json, right? (@ashoat)

Ah my bad, I totally should have caught this in review. For some reason when I reviewed this I remember thinking .vscode was being added to .gitignore, not being removed.

@benschac do you want to put up another diff to fix this? I can do it really quick if you're busy with something else.

You probably want to keep the .vscode folder ignored EXCEPT for .vscode/extensions.json, right?

Addressed here: https://phabricator.ashoat.com/D3442