Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Git] Ignore jsconfig.json (VSCode config file) #4011

Merged
merged 1 commit into from
Apr 16, 2016
Merged

[Git] Ignore jsconfig.json (VSCode config file) #4011

merged 1 commit into from
Apr 16, 2016

Conversation

jakeboone02
Copy link
Contributor

  • PR has tests / docs demo, and is linted. (N/A)
  • Commit and PR titles begin with [ComponentName], and are in imperative form: "[Component] Fix leaky abstraction".
  • Description explains the issue / use-case resolved, and auto-closes the related issue(s) (http://tr.im/vFqem).

VSCode needs a jsconfig.json file in the root folder of a project to enable ES2015 syntax recognition. Options are 1) to include the file in the repo, or 2) add it to .gitignore. A quick search leads me to believe that option 2 is right for this project.

See Angular and other examples.

@oliviertassinari
Copy link
Member

oliviertassinari commented Apr 15, 2016

@jakeboone02 Why not adding jsconfig.json in your global .gitignore?
I don't think that we should handle all the IDE 💩.
What about killing the # Exclude IDE project folders section instead?

@jakeboone02
Copy link
Contributor Author

I could certainly be wrong, but I believe the file is useful to have committed in a repo for certain situations, so adding it to the global .gitignore could be problematic. I just looked at some other examples to see what they did and this is how they handled it.

I agree you probably don't want to manage every IDE config in the world, but handling the few most frequently used on any given project shouldn't add too much overhead and can ever-so-slightly lower the barriers to new contributors :).

@oliviertassinari
Copy link
Member

oliviertassinari commented Apr 15, 2016

ever-so-slightly lower the barriers to new contributors

That's a very good point.

@mbrookes
Copy link
Member

mbrookes commented Apr 15, 2016

@oliviertassinari - I'm with @jakeboone02 here.

I hadn't considered global .gitignore until your comment on another similar PR. I've set mine up now so I'm covered. However, the cost to us of accepting PRs to update .gitignore for additional editor configs or other files is effectively zero, so I don't think we should remove the IDE section.

@jakeboone02
Copy link
Contributor Author

@mbrookes, can you clarify? Your comment seems to contradict itself but I'm probably misreading it.

@mbrookes
Copy link
Member

@jakeboone02 - thanks - rephrased the words after 'I don't think' to clarify.

@jakeboone02
Copy link
Contributor Author

Got it. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: system Specific to @mui/system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants