dsccommunity / dsccommunity/NetworkingDsc
chore: Add VS Code recommended extensions, settings, and build tasks
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 235
- Forks
- 93
- PR merge metrics
- No merged PRs in 30d
Description
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.testFilePathcoveringtests/Unit/**/*.Tests.ps1andtests/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
powershelldictionary 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.AnalyzerRulesand./output/RequiredModules/Indented.ScriptAnalyzerRules; remove the SqlServerDsc-specific custom rule path- Full DSC Community
IncludeRuleslist Ruleshashtable for whitespace, brace, and alignment rules
Acceptance 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 rules
References
- SqlServerDsc
.vscode/folder: https://github.com/dsccommunity/SqlServerDsc/tree/main/.vscode
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the referenced SqlServerDsc .vscode files with NetworkingDsc's build.yaml and tests/Unit/DSCResources/ paths. Create extensions.json, tasks.json, settings.json, and analyzersettings.psd1 with the listed PowerShell, Pester, analyzer, and workspace settings. Done means all acceptance criteria pass and the configuration contains no SQL Server-specific terms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, vscode
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100