Fix PSScriptAnalyzer warnings and remove unused parameter #18
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…eter Co-authored-by: AprilDeFeu <[email protected]>
Copilot
AI
changed the title
[WIP] Fix PowerShell test issues and incorporate feedback
Fix PSScriptAnalyzer warnings and remove unused parameter
Nov 16, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR addresses PSScriptAnalyzer warnings identified in PR #15 by making three key improvements to the PowerShell system maintenance script: renaming a function to avoid naming conflicts, adding proper cmdlet binding attributes, and removing an unused parameter.
- Renamed
Write-LogtoWrite-MaintenanceLogto prevent conflicts with PowerShell Core 6.1+ built-in cmdlets - Added
[CmdletBinding(SupportsShouldProcess)]attribute toInvoke-Stepfunction to properly support-WhatIfand-Confirmparameters - Removed the unused
DestructiveModeparameter and its associated documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| PowerShell/system-administration/maintenance/system-maintenance.ps1 | Updated function name from Write-Log to Write-MaintenanceLog (12 occurrences), added [CmdletBinding(SupportsShouldProcess)] to Invoke-Step, removed DestructiveMode parameter and related documentation |
| tests/unit/PowerShell/system-maintenance.Tests.ps1 | Removed test case for the deleted DestructiveMode parameter |
PowerShell/system-administration/maintenance/system-maintenance.ps1
Outdated
Show resolved
Hide resolved
…e.ps1 Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addressed Codacy/PSScriptAnalyzer feedback on PR #15 identifying code quality issues and an unused parameter.
Changes
Write-Log→Write-MaintenanceLog: Avoids conflict with built-in cmdlet in PowerShell Core 6.1+[CmdletBinding(SupportsShouldProcess)]toInvoke-Step: Function calls ShouldProcess and requires attributeDestructiveModeparameter: Parameter was declared but never referenced in script logicImpact
All PSScriptAnalyzer warnings resolved. Script behavior unchanged—destructive operations continue to use
ShouldProcesswith-WhatIfand-Confirmsupport as before.💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.