YAML Formatting VSCode Settings

[callumforrester]

Different people may have different default YAML formatters configured in their user settings. These may even fight each other in multi-author PRs and similar. We should decide on one and put it in the repo settings.

Acceptance Critera

• .vscode/settings.json includes a default YAML formatter
• Recommended extension settings includes the extension used if applicable

[coretl]

We have

python-copier-template/.vscode/settings.json

Line 4 in 3f7684c

"editor.formatOnSave": true,

and

python-copier-template/.devcontainer/devcontainer.json

Line 23 in 3f7684c

"redhat.vscode-yaml",

which on my vscode seems to format to 2 space indent.

It's a shame there isn't an associated pre-commit hook for the vscode yaml plugin...

[callumforrester]

Hmm, can we move the devcontainer line to the vscode settings so it works outside a devcontainer as well?

[coretl]

This line?

python-copier-template/.devcontainer/devcontainer.json

Line 23 in 3f7684c

"redhat.vscode-yaml",

At the moment the only "outside the devcontainer" recommendation is:

python-copier-template/.vscode/extensions.json

Line 3 in 3f7684c

"ms-vscode-remote.remote-containers",

We could duplicate the devcontainer.json section into extensions.json and then you would be prompted to install some extensions outside the devcontainer as well as inside. Do we want that?

[callumforrester]

From offline discussion: The impetus for this issue was two developers with two different YAML formatting plugins that disagreed with each other. As the two worked on the same PR together the YAML would change back and forth with each push. It probably does make sense, given that we have that following in setting.json:

"[python]": {
    "editor.defaultFormatter": "charliermarsh.ruff",
},

which basically says "whatever you have installed, use ruff", to do the same for the RedHat YAML plugin.

However, there needs to be a discussion about just how opinionated we are willing to get about using devcontainers.