fix(scripts): standardize PowerShell requirements header block #385
+55
−16
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
…soft#286) Add standardized header block to all 13 production PowerShell scripts: - #Requires -Version 7.0 (before param block) - Set-StrictMode -Version Latest (after param block) - $ErrorActionPreference = 'Stop' (after Set-StrictMode) Files modified: - scripts/linting/*.ps1 (6 files) - scripts/security/*.ps1 (3 files) - scripts/extension/*.ps1 (2 files) - scripts/lib/Get-VerifiedDownload.ps1 - scripts/dev-tools/Generate-PrReference.ps1 Removed duplicate $ErrorActionPreference assignments from script bodies. Fixes microsoft#286
katriendg
requested changes
Feb 2, 2026
Contributor
katriendg
left a comment
katriendg
left a comment
There was a problem hiding this comment.
Thanks for your PR!
It is looking very good, though there is a bit of a difference between some versions.
For consistency, let's always position the #Requires block before <# .SYNOPSIS #> block (when there is one).
Example
# file header stuff here
#Requires -Version 7.0
<#
.SYNOPSIS
....
Already correct:
The files to change:
INCONSISTENT - #Requires AFTER synopsis (9 files need correction):**
-
❌ scripts/linting/Invoke-YamlLint.ps1
<# .SYNOPSIS #>at line 4, #Requires at line 33- Should move #Requires to line 4 (before synopsis)
-
❌ scripts/extension/Package-Extension.ps1
<# .SYNOPSIS #>at line 5, #Requires at line 58- Should move #Requires to line 4 (before synopsis)
-
❌ scripts/extension/Prepare-Extension.ps1
<# .SYNOPSIS #>at line 5, #Requires at line 45- Should move #Requires to line 4 (before synopsis)
-
❌ scripts/lib/Get-VerifiedDownload.ps1
<# .SYNOPSIS #>at line 4, #Requires at line 39- Should move #Requires to line 4 (before synopsis)
-
❌ scripts/linting/Link-Lang-Check.ps1
<# .SYNOPSIS #>at line 4, #Requires at line 49- Should move #Requires to line 3 (before synopsis)
-
❌ scripts/security/Test-DependencyPinning.ps1
<# .SYNOPSIS #>at line 4, #Requires at line 85- Should move #Requires to line 4 (before synopsis)
-
❌ scripts/security/Test-SHAStaleness.ps1
<# .SYNOPSIS #>at line 4, #Requires at line 51- Should move #Requires to line 4 (before synopsis)
-
❌ scripts/security/Update-ActionSHAPinning.ps1
<# .SYNOPSIS #>at line 5, #Requires at line 34- Should move #Requires to line 4 (before synopsis)
-
❌ scripts/dev-tools/Generate-PrReference.ps1
<# .SYNOPSIS #>at line 4, #Requires at line 20- Should move #Requires to line 4 (before synopsis)
Standardizes header order across all PowerShell scripts: 1. Shebang (if present) 2. Copyright header 3. #Requires statements 4. Synopsis block Files updated: - scripts/linting/Invoke-YamlLint.ps1 - scripts/extension/Package-Extension.ps1 - scripts/extension/Prepare-Extension.ps1 - scripts/lib/Get-VerifiedDownload.ps1 - scripts/linting/Link-Lang-Check.ps1 - scripts/security/Test-DependencyPinning.ps1 - scripts/security/Test-SHAStaleness.ps1 - scripts/security/Update-ActionSHAPinning.ps1 - scripts/dev-tools/Generate-PrReference.ps1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Add standardized requirements header block to all 13 production PowerShell scripts for consistent error handling, PowerShell version requirements, and strict mode enforcement.
Changes
#Requires -Version 7.0before param() blockSet-StrictMode -Version Latestafter param() block$ErrorActionPreference = 'Stop'after Set-StrictMode$ErrorActionPreferenceassignments from script bodiesFiles Modified (13 total)
scripts/linting/*.ps1(6 files)scripts/security/*.ps1(3 files)scripts/extension/*.ps1(2 files)scripts/lib/Get-VerifiedDownload.ps1scripts/dev-tools/Generate-PrReference.ps1Validation
Fixes #286