search

claritychallenge / clarity

Clarity Challenge toolkit - software for building Clarity Challenge systems
https://claritychallenge.github.io/clarity
MIT License
130 stars 54 forks source link

Directory .vscode in Repo #112

Closed groadabike closed 1 year ago

groadabike commented 1 year ago

Hi @ns-rse, we have the .vscode folder at the root of the repo. Shouldn't we delete this folder and add it to .gitignore?

ns-rse commented 1 year ago

Good spot @groadabike

I'm in two minds, technically its not strictly necessary. On the flip side any contributors may find the configuration it provides for VSCode useful. In this instance its saying that the Python plugin should use the black formatter which is kind of a good thing since we apply black using pre-commit anyway. This just means that the formatting will be applied on file save rather than by failing pre-commit, having the formatting applied and then the contributor having to then repeat their git commit.

The counter argument is that whilst its convenient its down to the contributor to configure their IDE as they desire.

Input/opinions welcome, personally I use Emacs with lsp-mode as my IDE so wouldn't use this.

groadabike commented 1 year ago

Good spot @groadabike

I'm in two minds, technically its not strictly necessary. On the flip side any contributors may find the configuration it provides for VSCode useful. In this instance its saying that the Python plugin should use the black formatter which is kind of a good thing since we apply black using pre-commit anyway. This just means that the formatting will be applied on file save rather than by failing pre-commit, having the formatting applied and then the contributor having to then repeat their git commit.

The counter argument is that whilst its convenient its down to the contributor to configure their IDE as they desire.

Input/opinions welcome, personally I use Emacs with lsp-mode as my IDE so wouldn't use this.

That's a good point @ns-rse, I didn't know you can export the config with that file, I use IntelliJ myself. But, I don't think we need to export .vscode configs, is not that we are encouraging people to use vscode. We could just add a badge indicating we use black like in Asteroid project https://github.com/asteroid-team/asteroid @jonbarker68 , @jwillbailey , @TuZehai what do you think?

ns-rse commented 1 year ago

Badges are good, others would be..

ns-rse commented 1 year ago

By the way @groadabike IntelliJ is a Java orientated IDE, you may want to give JetBrains Python IDE a whirl which is PyCharm (or Emacs :wink: )

jonbarker68 commented 1 year ago

This was a deliberate addition at some point: I think vscode layers 'workspace' settings over 'user' settings. The .vscode in the directory is a workspace setting which has been kept to a minimum of turning on the black formatter. It's a bit redundant as the pre-commit hooks enforce black anyway but I thought it might be helpful for people who did not know how to set this up. I'd suggest to keep it unless it is causing problems for people (The other useful thing it could contain is additions to the spellcheck dictionary)

ns-rse commented 1 year ago

I'm happy to leave this in if it simplifies the workflow for those using VSCode.

Shall we close this issue?

jonbarker68 commented 1 year ago

Yes, please - I don't see it causing any real issues. Let's close it for now. Can always revisit.

On Wed, 23 Nov 2022 at 08:43, Neil Shephard @.***> wrote:

I'm happy to leave this in if it simplifies the workflow for those using VSCode.

Shall we close this issue?

— Reply to this email directly, view it on GitHub https://github.com/claritychallenge/clarity/issues/112#issuecomment-1324713376, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACO7SJDMEHXY7RJOWXC7UYTWJXKJTANCNFSM6AAAAAASA4RREA . You are receiving this because you were mentioned.Message ID: @.***>

-- Professor Jon Barker, Department of Computer Science, University of Sheffield +44 (0) 114 222 1824

jonbarker68 commented 1 year ago

Closing this issue for now.