Summary
The repository has no .vscode/ folder. Add the standard VS Code workspace configuration files used across DSC Community modules (aligned with SqlServerDsc) to provide a consistent developer experience for all contributors.
Files to create
.vscode/extensions.json
Recommended extensions for contributors:
{
"recommendations": [
"davidanson.vscode-markdownlint",
"pspester.pester-test",
"ms-vscode.powershell",
"streetsidesoftware.code-spell-checker"
]
}
.vscode/tasks.json
Comprehensive tasks aligned to the build.yaml workflow. All tasks should use ./build.ps1 and target pwsh on Linux/macOS and powershell.exe on Windows.
Tasks to include:
| Label |
Build group |
Command |
noop |
— |
./build.ps1 -Tasks noop |
build |
build (default) |
./build.ps1 -AutoRestore -Tasks build |
test |
test (default) |
./build.ps1 -Tasks noop; Invoke-Pester -Path './tests/Unit' -Output Detailed |
test-with-coverage |
test |
Unit tests with code coverage enabled |
hqrmtest |
— |
./build.ps1 -AutoRestore -Tasks hqrmtest -CodeCoverageThreshold 0 |
Each task should include a problemMatcher for Pester failures, appropriate presentation settings, and correct shell configuration per platform.
Use SqlServerDsc tasks.json as the reference and adapt test task paths to tests/Unit/DSCResources/.
.vscode/settings.json
Based on SqlServerDsc settings.json, adapted for NetworkingDsc:
- PowerShell code formatting (
openBraceOnSameLine: false, preset: Custom, etc.)
- PSScriptAnalyzer path:
.vscode/analyzersettings.psd1
- Pester:
pester.testFilePath covering tests/Unit/**/*.Tests.ps1 and tests/QA/*.Tests.ps1; pester.pesterModulePath: ./output/RequiredModules/Pester; pester.runTestsInNewProcess: true
github.copilot.chat.codeGeneration.useInstructionFiles: true
- Editor:
files.trimTrailingWhitespace, files.insertFinalNewline, files.trimFinalNewlines
- cSpell with
powershell dictionary and NetworkingDsc-relevant words (no SQL Server terms)
- Terminal profiles defaulting to
pwsh
.vscode/analyzersettings.psd1
Based on SqlServerDsc analyzersettings.psd1:
CustomRulePath: ./output/RequiredModules/DscResource.AnalyzerRules and ./output/RequiredModules/Indented.ScriptAnalyzerRules; remove the SqlServerDsc-specific custom rule path
- Full DSC Community
IncludeRules list
Rules hashtable for whitespace, brace, and alignment rules
Acceptance criteria
References
Summary
The repository has no
.vscode/folder. Add the standard VS Code workspace configuration files used across DSC Community modules (aligned with SqlServerDsc) to provide a consistent developer experience for all contributors.Files to create
.vscode/extensions.jsonRecommended extensions for contributors:
{ "recommendations": [ "davidanson.vscode-markdownlint", "pspester.pester-test", "ms-vscode.powershell", "streetsidesoftware.code-spell-checker" ] }.vscode/tasks.jsonComprehensive tasks aligned to the
build.yamlworkflow. All tasks should use./build.ps1and targetpwshon Linux/macOS andpowershell.exeon Windows.Tasks to include:
noop./build.ps1 -Tasks noopbuild./build.ps1 -AutoRestore -Tasks buildtest./build.ps1 -Tasks noop; Invoke-Pester -Path './tests/Unit' -Output Detailedtest-with-coveragehqrmtest./build.ps1 -AutoRestore -Tasks hqrmtest -CodeCoverageThreshold 0Each task should include a
problemMatcherfor Pester failures, appropriatepresentationsettings, and correct shell configuration per platform.Use SqlServerDsc
tasks.jsonas the reference and adapt test task paths totests/Unit/DSCResources/..vscode/settings.jsonBased on SqlServerDsc
settings.json, adapted for NetworkingDsc:openBraceOnSameLine: false,preset: Custom, etc.).vscode/analyzersettings.psd1pester.testFilePathcoveringtests/Unit/**/*.Tests.ps1andtests/QA/*.Tests.ps1;pester.pesterModulePath: ./output/RequiredModules/Pester;pester.runTestsInNewProcess: truegithub.copilot.chat.codeGeneration.useInstructionFiles: truefiles.trimTrailingWhitespace,files.insertFinalNewline,files.trimFinalNewlinespowershelldictionary and NetworkingDsc-relevant words (no SQL Server terms)pwsh.vscode/analyzersettings.psd1Based on SqlServerDsc
analyzersettings.psd1:CustomRulePath:./output/RequiredModules/DscResource.AnalyzerRulesand./output/RequiredModules/Indented.ScriptAnalyzerRules; remove the SqlServerDsc-specific custom rule pathIncludeRuleslistRuleshashtable for whitespace, brace, and alignment rulesAcceptance criteria
.vscode/extensions.jsoncreated with the four recommended extensions.vscode/tasks.jsoncreated withnoop,build,test,test-with-coverage, andhqrmtesttasks.vscode/tasks.jsontest task paths reflecttests/Unit/DSCResources/.vscode/settings.jsoncreated with no SQL Server–specific words or patterns.vscode/analyzersettings.psd1created with DSC Community analyzer rulesReferences
.vscode/folder: https://github.com/dsccommunity/SqlServerDsc/tree/main/.vscode