-
Notifications
You must be signed in to change notification settings - Fork 11
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
Add VSCode folder to gitignore #255
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #255 +/- ##
=======================================
Coverage 76.93% 76.93%
=======================================
Files 78 78
Lines 3894 3894
=======================================
Hits 2996 2996
Misses 898 898 ☔ View full report in Codecov by Sentry. |
.vscode/settings.json
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All lines besides "python.testing.pytestEnabled": true,
are the default values.
Any reason why they are added?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So that it works out of the box.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if the values are default they should work out of the box, no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm pretty sure the env file isn't default anyways. The rest is auto-generated by VSCode but without declaring the env file it won't work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The path for the env file is the default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really can't follow.
I'm pretty sure the pytest enabled setting is added automatically by VSCode when you press the configure tests button then select pytest
That is not
So that it works out of the box.
That is why suggested to
At least values which are different from the default should stay in the file which is only
"python.testing.pytestEnabled": true
So, why is it now completely removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you open up the project in VSCode and go to the tests side bar, if there's no settings.json
it will prompt you to configure tests. If you press that button you can select pytest, then it auto generates the settings.json
file. That "python.testing.pytestEnabled": true
is part of that file. And as you said, so is the env path. So imo there's no need to include that file in the repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Anything holding this pr back?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basically me who still doesn't know what's the goal here. If it is to just ignore the settings.json
, it's fine.
If it is to work "out of the box", then it's missing stuff.
As already described, without a settings.json
, VSCode will prompt you to configure tests but that's a selection between two different frameworks where the wrong one is even described as Standard Python test framework
Eventually there should be at least an example .env
file in the README
or a .env
file with placeholders?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, it'd be nice to figure out so I don't have to keep a settings.json
file with changes on every branch I work on.
Adds a basic settings file, then gitignores the
.vscode
folder