Skip to content

Commit 9e84208

Browse files
docs: add PSScriptAnalyzer local dev instructions to README (#148)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: RomuDeuxfois <53513584+RomuDeuxfois@users.noreply.github.com>
1 parent 45f6ff2 commit 9e84208

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,22 @@ Audit is included in CI to block new vulnerabilities.
116116

117117
---
118118

119+
### PSScriptAnalyzer (Windows installer scripts)
120+
121+
The PowerShell installer scripts under `installer/windows/` are linted with [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer).
122+
123+
Run the linter locally (requires PowerShell 5.1+ or PowerShell 7+):
124+
125+
```powershell
126+
.\installer\windows\Run-Lint.ps1
127+
```
128+
129+
The script will automatically install `PSScriptAnalyzer` from the PowerShell Gallery if it is not already present, then analyze every `.ps1` file in `installer/windows/` using the settings defined in `installer/windows/PSScriptAnalyzerSettings.psd1`.
130+
131+
PSScriptAnalyzer runs in CI — the pipeline will fail if any issues are reported.
132+
133+
---
134+
119135
## 🧪 Tests in CI
120136

121137
All tests are run automatically in the CI pipeline using:

0 commit comments

Comments
 (0)