Expected requirements for contribution should be included in VSCode settings to make it easier

[jeremyciak]

Requirements like line length and other similar settings that can be added to the settings.json file under the .vscode folder should be so that contributors automatically benefit from those settings.

[jeremyciak]

"files.defaultLanguage": "powershell",
"[powershell]": {
  "editor.rulers": [ 120 ]
},
"[markdown]": {
  "editor.rulers": [ 120 ]
}

[johlju]

We could also add a extensions.json that suggest adding the extension markdownlint that is used for validating markdown in HQRM tests.

[dan-hughes]

@johlju, I can pick this up.

Looking at the style guide is the line limit 120 or 80 chars?

Also is there anything else that needs adding as this is pretty old...

[johlju]

The style guidelines can be found at dsccommunity.org. We removed the hard line length limit a while back. We today also have a dsccommunity Plaster template in the Sampler project that have most of these settings already I think 🤔 This repo should have gotten those settings when the template was used on this template.

Maybe this issue could just be closed if it already fixed?

[dan-hughes]

Looks like it matches. The only thing that might be beneficial is any recommended extensions? e.g.

• VScode Powershell
• Markdown Lint
• YAML
• CSpell (maybe?)

[johlju]

That sounds good. In SqlServerDsc these are used. YAML could be a good addition.

The Pester Test Adapter in the link below is a test I did in SqlServerDsc as it requires Pester 5 tests and specific settings, so that should not be a default in other repos until that extension becomes more stable I think 🤔

https://github.com/dsccommunity/SqlServerDsc/blob/main/.vscode/extensions.json

[dan-hughes]

Shall I also add into the Sampler template?

[johlju]

Yes please, if you have time. Ping me in a PR there and I can review.

[dan-hughes]

Done.

Same extensions.json for both.