Skip to content

chore: add cspell config and fix spelling errors#196

Merged
HeyItsGilbert merged 5 commits into
mainfrom
worktree-imperative-munching-pudding
Jun 14, 2026
Merged

chore: add cspell config and fix spelling errors#196
HeyItsGilbert merged 5 commits into
mainfrom
worktree-imperative-munching-pudding

Conversation

@HeyItsGilbert

@HeyItsGilbert HeyItsGilbert commented Jun 14, 2026

Copy link
Copy Markdown
Member

Summary

  • Add cspell.json with the powershell dictionary and a global word list for terms used across 3+ files (PS types, module names, project identifiers)
  • Fix 13 genuine typos in comments and doc blocks (seleced, RIPEM160, Wilcards, Extentions, aribtrary, verion x2, ingore, clonging, intepreted, retreieving/internl, Credenials, propertly)
  • Add file-scoped # cspell:ignore (or <!-- cspell:ignore --> for markdown) comments to 38 files for terms that only appear in 1-2 files, keeping the global config lean

Test plan

  • Run cspell . -- should report 0 issues across 155 files
  • Confirm cspell.json schema validates (VS Code cspell extension or cspell --show-config)
  • Smoke-check that typo fixes in doc blocks haven't changed any runtime behaviour

Generated with Claude Code

- Add cspell.json with schema, powershell dictionary, and words that
  appear in 3+ files kept in global config
- Add file-scoped cspell:ignore comments to 38 files for words that
  only appear in 1-2 files
- Fix 13 actual typos: seleced, RIPEM160, Wilcards, Extentions,
  aribtrary, verion (x2), ingore, clonging, intepreted, retreieving,
  internl, Credenials, propertly

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 14, 2026 02:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 introduces repository-wide spellchecking support (via cspell.json) and applies a broad set of spelling corrections and cspell ignore annotations across scripts, tests, and documentation.

Changes:

  • Add cspell.json (PowerShell dictionary + shared word list) to enable consistent spellchecking across the repo.
  • Add file-scoped cspell:ignore / cspell:disable-next-line annotations to keep cspell noise low without bloating the global dictionary.
  • Fix typos and some casing in comments/doc blocks (and a small number of code identifiers/types).

Reviewed changes

Copilot reviewed 67 out of 67 changed files in this pull request and generated 13 comments.

Show a summary per file
File Description
Tests/WindowsRSAT.Type.Tests.ps1 Add file-scoped cspell ignore header.
Tests/Test-VersionEquality.Tests.ps1 Add file-scoped cspell ignore header.
Tests/Task.Type.Tests.ps1 Add file-scoped cspell ignore header.
Tests/PSModuleGallery.Type.Tests.ps1 Add cspell ignore header + minor test code formatting/casing fixes.
Tests/PSGalleryNuget.Type.Tests.ps1 Add file-scoped cspell ignore header.
Tests/PSDepend.Tests.ps1 Add cspell ignores + small test expression tweak.
Tests/Package.Type.Tests.ps1 Add file-scoped cspell ignore header.
Tests/Nuget.Type.Tests.ps1 Add file-scoped cspell ignore header.
Tests/MetaFixers.psm1 Fix typo in variable name (Extensions).
Tests/Manifest.tests.ps1 Add file-scoped cspell ignore header.
Tests/Help.tests.ps1 Add file-scoped cspell ignore header.
Tests/GitHub.Type.Tests.ps1 Add file-scoped cspell ignore header.
Tests/Git.Type.Tests.ps1 Add file-scoped cspell ignore header + minor spelling/casing tweaks.
Tests/FileDownload.Type.Tests.ps1 Add file-scoped cspell ignore header.
Tests/DependFiles/git.depend.psd1 Add file-scoped cspell ignore header.
Tests/Chocolatey.Type.Tests.ps1 Add file-scoped cspell ignore header.
static/README.md Add markdown cspell ignore comment.
README.md Add markdown cspell ignore comment.
PSDepend/Public/Test-Dependency.ps1 Casing tweaks for attributes/types.
PSDepend/Public/Invoke-PSDepend.ps1 Add cspell ignore + casing tweaks (and function declaration touched).
PSDepend/Public/Invoke-DependencyScript.ps1 Casing tweaks + minor comment spelling/formatting cleanup.
PSDepend/Public/Install-Dependency.ps1 Casing tweaks (and function declaration touched).
PSDepend/Public/Import-Dependency.ps1 Casing tweaks (and function declaration touched).
PSDepend/Public/Get-PSDependType.ps1 Doc typo fixes + casing tweaks (and function declaration touched).
PSDepend/Public/Get-PSDependScript.ps1 Casing tweaks for attributes.
PSDepend/Public/Get-Dependency.ps1 Add cspell ignore + doc typo fixes + minor casing fixes.
PSDepend/PSDependScripts/WindowsRSAT.ps1 Add cspell ignore + casing tweaks for attributes/types.
PSDepend/PSDependScripts/Task.ps1 Add cspell ignore + casing tweaks for attributes/types.
PSDepend/PSDependScripts/PSResourceGet.ps1 Casing tweak for PSObject.
PSDepend/PSDependScripts/PSGalleryNuget.ps1 Casing tweaks for attributes/types.
PSDepend/PSDependScripts/PSGalleryModule.ps1 Casing tweaks for attributes/types.
PSDepend/PSDependScripts/Package.ps1 Add cspell ignore + casing tweaks for attributes/types.
PSDepend/PSDependScripts/Nuget.ps1 Add cspell ignore + casing tweaks for attributes/types.
PSDepend/PSDependScripts/Npm.ps1 Fix doc typo + casing tweaks for attributes/types.
PSDepend/PSDependScripts/Noop.ps1 Casing tweaks for attributes/types.
PSDepend/PSDependScripts/GitHub.ps1 Add cspell ignore + casing/formatting tweaks.
PSDepend/PSDependScripts/Git.ps1 Add cspell ignore + spelling fix + update to -PassThru.
PSDepend/PSDependScripts/FileSystem.ps1 Add cspell ignore + casing tweaks for attributes/types.
PSDepend/PSDependScripts/FileDownload.ps1 Add cspell ignore + casing tweaks for attributes + helper function attribute casing.
PSDepend/PSDependScripts/DotnetSdk.ps1 Doc typos fixed + casing tweak for PSObject.
PSDepend/PSDependScripts/Command.ps1 Doc typo fixed + casing tweaks for attributes/types.
PSDepend/PSDependScripts/Chocolatey.ps1 Add cspell ignore + formatting cleanup in control flow blocks.
PSDepend/Private/Validate-DependencyParameters.ps1 Casing tweak for [CmdletBinding()].
PSDepend/Private/Sort-WithCustomList.ps1 Function declaration line touched (plus casing/formatting normalization).
PSDepend/Private/Sort-PSDependency.ps1 Casing tweak for [CmdletBinding()].
PSDepend/Private/SemanticVersion.ps1 Add cspell ignore + doc typos (“SemVer”).
PSDepend/Private/Invoke-ExternalCommand.ps1 Rename parameter to PassThru + casing tweak for [CmdletBinding()].
PSDepend/Private/Install-NodeModule.ps1 Function declaration line touched + casing tweak for [CmdletBinding()].
PSDepend/Private/Import-PSDependModule.ps1 Casing tweak for [CmdletBinding()].
PSDepend/Private/Get-WebFile.ps1 Add cspell ignore + function declaration line touched.
PSDepend/Private/Get-TaggedDependency.ps1 Function declaration line touched.
PSDepend/Private/Get-PropertyOrder.ps1 Fix doc/casing for parameter names/types + casing tweaks.
PSDepend/Private/Get-ProjectDetail.ps1 Add cspell ignore + casing tweaks + inner helper function declaration touched.
PSDepend/Private/Get-ParameterName.ps1 Add cspell ignore + casing tweaks + function declaration line touched.
PSDepend/Private/Get-Parameter.ps1 Add cspell ignore + doc typo fix (“Wildcards”).
PSDepend/Private/Get-NodeModule.ps1 Function declaration line touched + casing tweak for [CmdletBinding()].
PSDepend/Private/Get-Hash.ps1 Add cspell ignore + doc typos fixed (“selected”, “RIPEMD160”).
PSDepend/Private/Find-NugetPackage.ps1 Casing tweak for [PSCredential].
PSDepend/Private/Bootstrap-Nuget.ps1 Casing tweak for [CmdletBinding()].
PSDepend/Private/Add-ToPsModulePathIfRequired.ps1 Casing tweaks for [CmdletBinding()] and [PSObject].
PSDepend/Private/Add-ObjectDetail.ps1 Add cspell ignore + doc typo fix (“PassThru”) + casing tweaks.
PSDepend/en-US/about_PSDepend.help.txt Add cspell ignore + whitespace/casing tweaks + doc typo fixes.
Examples/ModuleDependencies.md Add markdown cspell ignore + example code formatting change.
docs/PSDependScripts-ReviewerChecklist.md Update documented parameter contract casing ([PSObject[]]).
docs/en-US/Invoke-PSDepend.md Add markdown cspell ignore comment.
cspell.json Add cspell configuration (schema + words list + PowerShell dictionary).
CHANGELOG.md Add markdown cspell ignore comment.

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

Comment thread PSDepend/Public/Invoke-PSDepend.ps1 Outdated
Comment thread PSDepend/Public/Install-Dependency.ps1 Outdated
Comment thread PSDepend/Public/Import-Dependency.ps1 Outdated
Comment thread PSDepend/Public/Get-PSDependType.ps1 Outdated
Comment thread PSDepend/Private/Sort-WithCustomList.ps1 Outdated
Comment thread PSDepend/Private/Get-NodeModule.ps1 Outdated
Comment thread PSDepend/Private/Get-ParameterName.ps1 Outdated
Comment thread PSDepend/Private/Get-ProjectDetail.ps1 Outdated
Comment thread Examples/ModuleDependencies.md Outdated
Comment thread README.md Outdated
@github-actions

github-actions Bot commented Jun 14, 2026

Copy link
Copy Markdown

Test Results

    3 files     66 suites   1m 22s ⏱️
  979 tests   925 ✅ 54 💤 0 ❌
1 311 runs  1 247 ✅ 64 💤 0 ❌

Results for commit ddd0864.

♻️ This comment has been updated with latest results.

* Updated function names to follow proper casing conventions.
* Fixed `TrimEnd` usage in scripts and tests for consistency.
* Removed unnecessary `trimend` entries from `cspell.json`.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

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

Comment thread PSDepend/Private/Get-ProjectDetail.ps1 Outdated
Comment thread cspell.json Outdated
Comment thread README.md Outdated
Comment thread PSDepend/en-US/about_PSDepend.help.txt Outdated
HeyItsGilbert and others added 3 commits June 13, 2026 20:51
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Gilbert Sanchez <me@gilbertsanchez.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Gilbert Sanchez <me@gilbertsanchez.com>
* Added `"snyk.advanced.autoSelectOrganization": true` to `.vscode/settings.json`.
* Improved comments in `Get-Dependency.ps1` for clarity.
* Removed unnecessary cspell ignore comments from `about_PSDepend.help.txt` and `README.md`.
* Updated `cspell.json` to include new words and removed obsolete entries.
@HeyItsGilbert

Copy link
Copy Markdown
Member Author

Confirmed that test results numbers match prior to the change. This should hopefully result in less cspell warnings in future PR's.

@HeyItsGilbert HeyItsGilbert merged commit 16113c8 into main Jun 14, 2026
7 checks passed
@HeyItsGilbert HeyItsGilbert deleted the worktree-imperative-munching-pudding branch June 14, 2026 03: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