Skip to content

docs: add PSScriptAnalyzer local dev instructions to README #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RomuDeuxfois merged 2 commits into from
Mar 20, 2026
+16 −0
Merged

docs: add PSScriptAnalyzer local dev instructions to README #148

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adfdd95
Initial plan
Copilot Mar 20, 2026
8427c20
docs: add PSScriptAnalyzer local dev section to README
Copilot Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,22 @@ Audit is included in CI to block new vulnerabilities.

---

### PSScriptAnalyzer (Windows installer scripts)

The PowerShell installer scripts under `installer/windows/` are linted with [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer).

Run the linter locally (requires PowerShell 5.1+ or PowerShell 7+):

```powershell
.\installer\windows\Run-Lint.ps1
```

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`.

PSScriptAnalyzer runs in CI — the pipeline will fail if any issues are reported.

---

## 🧪 Tests in CI

All tests are run automatically in the CI pipeline using:
Expand Down