Add VS code settings.json file

[alexdewar]

So I started out by adding the settings.json file suggested by @dalonsoa, but I've made
a few changes:

• Removed workbench.tree.ident and files.autosave settings as I think those
  aren't specific to this repo (users might want different settings)
• Remove options relating to line rewrapping (black does this already)
• Remove pytest settings: this should be done in a project-wide config file (e.g.
  setup.cfg)
• Add --no-cov to pytest args otherwise breakpoints won't work (see Debugger doesn't stop at breakpoints with pytest if pytest-cov is used microsoft/vscode-python#693)

Closes #27.

[davidorme]

Just to note that my plan is not to use the *.ipynb format for Jupyter notebooks. See:
https://github.com/ImperialCollegeLondon/virtual_rainforest/blob/develop/docs/source/development/jupyter_notebooks.md

I don't know if that changes the settings.

[alexdewar]

Overview of VS code settings: https://code.visualstudio.com/docs/getstarted/settings

[dalonsoa]

The testing options are for VSCode. Just setup.cfg or pyproject.toml is not enough.

[dalonsoa]

This should be here, otherwise VSCode testing does not know what to use for tests.

[alexdewar]

It still is set to true! See below

[dalonsoa]

omg

[jaideep777]

Submitting a sample review.

[alexdewar]

The testing options are for VSCode. Just setup.cfg or pyproject.toml is not enough.

So I think we can drop the pytest arguments -s tests because if the test directory is set appropriately in e.g. setup.cfg then I think VS code will detect it (and so the test tab will work properly) and if it's only set in settings.json then VS code's test tab will work, but confusingly, it won't work when you run pytest from the command line (or when the CI system runs it).

[dalonsoa]

Ok, we can leave it like that and change it if it does not work

[alexdewar]

It looks like pylint isn't in the poetry dev dependencies btw. Do we want to enable it or not?

I suggest we either don't use this linter or add it to the dependencies.

@dalonsoa @davidorme

[dalonsoa]

If we want to use it - and it seems we want, right @davidorme - it should be in the dependency list, yes.

[alexdewar]

Just to note that my plan is not to use the *.ipynb format for Jupyter notebooks. See: https://github.com/ImperialCollegeLondon/virtual_rainforest/blob/develop/docs/source/development/jupyter_notebooks.md

I don't know if that changes the settings.

We could remove the setting if it's not needed. It shouldn't break things though!

I leave that decision to the VR dev team. Would you like me to remove it or no? 😄

[dalonsoa]

Keeping aside adding pylint to the dependency list, it looks good to me

[dalonsoa]

If we want to use it - and it seems we want, right @davidorme - it should be in the dependency list, yes.

[dalonsoa]

omg