Skip to content

Fix spelling and user-facing messages#276

Open
SamErde wants to merge 1 commit intomainfrom
samerde/fix-spelling-messages
Open

Fix spelling and user-facing messages#276
SamErde wants to merge 1 commit intomainfrom
samerde/fix-spelling-messages

Conversation

@SamErde
Copy link
Copy Markdown
Collaborator

@SamErde SamErde commented May 6, 2026

Summary

Fixes confirmed spelling, grammar, and user-facing message issues identified in the repository audit.

Changes

Typo / capitalization fixes

  • Powershell -> PowerShell throughout source, docs, XML help, .editorconfig, and generated monolithic script
  • CCOMMAND(S) -> COMMAND(S) in Private/Invoke-Remediation.ps1 (and generated script)
  • direclty -> directly in Private/Write-HostColorized.ps1 (and generated script)
  • an high-level -> a high-level in Public/Invoke-Locksmith.ps1 (and generated script)
  • to the purposes -> for the purposes in Tests/Invoke-TSS.ps1
  • chose -> choose in README.md and Docs/index.md

User-facing message improvements

  • Replaced vague Ope! Something broke. with an actionable error message in both CSV export catch blocks (Modes 2 and 3) that includes the file path and the actual exception message.

Scope

  • No behavior changes - all edits are in comments, string literals, and documentation.
  • No new tests added.
  • No general Write-Host remediation.
  • Generated root Invoke-Locksmith.ps1 updated to maintain parity with source per repository convention.

Validation

  • PSScriptAnalyzer run on all changed .ps1 files - no new errors or warnings introduced.

- Fix 'Powershell' -> 'PowerShell' in source, docs, XML, config, and generated script
- Fix 'CCOMMAND' -> 'COMMAND' in Invoke-Remediation.ps1 and generated script
- Fix 'direclty' -> 'directly' in Write-HostColorized.ps1 and generated script
- Fix 'an high-level' -> 'a high-level' in Invoke-Locksmith.ps1 and generated script
- Fix 'to the purposes' -> 'for the purposes' in Tests/Invoke-TSS.ps1
- Fix 'chose' -> 'choose' in README.md and Docs/index.md
- Replace vague 'Ope! Something broke.' with actionable error messages in
  Invoke-Locksmith.ps1 (source and generated) that include the file path and
  exception message

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@SamErde SamErde marked this pull request as ready for review May 6, 2026 09:25
Copilot AI review requested due to automatic review settings May 6, 2026 09:25
@SamErde SamErde marked this pull request as draft May 6, 2026 09:27
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR cleans up spelling/capitalization across user-facing documentation, help content, and comments, and improves the CSV export failure messages to include actionable context (output path + exception message).

Changes:

  • Standardized “PowerShell” capitalization and corrected several typos/grammar issues across docs, help XML, and scripts.
  • Replaced the vague CSV export catch message with a more actionable one that includes the target file path and exception message.
  • Updated the monolithic Invoke-Locksmith.ps1 to keep it in sync with the module sources.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
Tests/Invoke-TSS.ps1 Fixes grammar in synopsis header comment (“for the purposes”).
README.md Fixes “chose” → “choose” and corrects markdown paragraph formatting.
Public/Invoke-Locksmith.ps1 Standardizes “PowerShell” and improves CSV export catch messages.
Private/Write-HostColorized.ps1 Fixes typo in an internal comment (“directly”).
Private/Invoke-Remediation.ps1 Fixes typo in a user-facing prompt (“COMMAND(S)”).
Private/Find-ESC15.ps1 Standardizes “PowerShell” capitalization in remediation comment text.
Invoke-Locksmith.ps1 Mirrors the same spelling/message improvements in the monolithic script.
en-US/Locksmith-help.xml Standardizes “PowerShell” in help text for Invoke-Locksmith.
Docs/Invoke-Locksmith.md Standardizes “PowerShell” in generated docs content.
Docs/index.md Fixes “chose” → “choose” in docs index.
CONTRIBUTING.md Standardizes “PowerShell” capitalization in contribution guidance.
.editorconfig Fixes comment capitalization (“PowerShell files”).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread Public/Invoke-Locksmith.ps1
Comment thread Public/Invoke-Locksmith.ps1
Comment thread Invoke-Locksmith.ps1
Comment thread Invoke-Locksmith.ps1
@SamErde SamErde marked this pull request as ready for review May 6, 2026 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants