chore: ✨ update configuration and documentation

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

Author: HeyItsGilbert

.vscode/settings.json

@@ -16,5 +16,6 @@
         "**/*.code-search": true,
         "**/.ruby-lsp": true,
         "Output/**": true
-    }
-}
+    },
+    "snyk.advanced.autoSelectOrganization": true
+}

PSDepend/Public/Get-Dependency.ps1

@@ -147,7 +147,7 @@ function Get-Dependency {
         [hashtable]$Credentials
     )
 
-    # Helper to pick from global psdependoptions, or return a default
+    # Helper to pick from global PSDependOptions, or return a default
     function Get-GlobalOption {
         param(
             $Options = $PSDependOptions,
@@ -159,12 +159,10 @@ function Get-Dependency {
         $Output = $Default
         if ($Prefer) {
             $Output = $Prefer
-        }
-        else {
+        } else {
             try {
                 $Output = $Options[$Name]
-            }
-            catch {
+            } catch {
                 $Output = $Default
             }
         }
@@ -262,7 +260,7 @@ function Get-Dependency {
             elseif ( $DependencyHash -is [string] -and
                 $Dependency -notmatch '/' -and
                 (-not $DependencyType -or
-                    $DependencyType -eq 'PSGalleryModule')) {
+                $DependencyType -eq 'PSGalleryModule')) {
                 [PSCustomObject]@{
                     PSTypeName      = 'PSDepend.Dependency'
                     DependencyFile  = $DependencyFile
@@ -288,7 +286,7 @@ function Get-Dependency {
                 $Dependency -match '/' -and
                 $Dependency.split('/').count -eq 2 -and
                 (-not $DependencyType -or
-                    $DependencyType -eq 'GitHub')) {
+                $DependencyType -eq 'GitHub')) {
                 [PSCustomObject]@{
                     PSTypeName      = 'PSDepend.Dependency'
                     DependencyFile  = $DependencyFile
@@ -312,7 +310,7 @@ function Get-Dependency {
             elseif ($DependencyHash -is [string] -and
                 $Dependency -match '/' -and
                 (-not $DependencyType -or
-                    $DependencyType -eq 'Git')) {
+                $DependencyType -eq 'Git')) {
                 [PSCustomObject]@{
                     PSTypeName      = 'PSDepend.Dependency'
                     DependencyFile  = $DependencyFile
@@ -331,8 +329,7 @@ function Get-Dependency {
                     PSDependOptions = $PSDependOptions
                     Raw             = $null
                 }
-            }
-            else {
+            } else {
                 # Parse dependency hash format
                 # Default type is module, unless it's in a git-style format
                 if (-not $DependencyHash.DependencyType) {
@@ -343,10 +340,10 @@ function Get-Dependency {
                     elseif (
                         # Ugly right? Watch out for split called on hashtable...
                         ($Dependency -match '/' -and -not $Dependency.Name -and
-                            ($Dependency -is [string] -and $Dependency.split('/').count -eq 2)
+                        ($Dependency -is [string] -and $Dependency.split('/').count -eq 2)
                         ) -or
                         ($DependencyHash.Name -match '/' -and
-                            ($DependencyHash -is [string] -and $DependencyHash.split('/').count -eq 2)
+                        ($DependencyHash -is [string] -and $DependencyHash.split('/').count -eq 2)
                         )
                     ) {
                         $DependencyType = 'GitHub'
@@ -357,13 +354,11 @@ function Get-Dependency {
                         $DependencyHash.Name -match '/'
                     ) {
                         $DependencyType = 'Git'
-                    }
-                    else {
+                    } else {
                         # finally, psgallerymodule
                         $DependencyType = 'PSGalleryModule'
                     }
-                }
-                else {
+                } else {
                     $DependencyType = $DependencyHash.DependencyType
                 }
 
@@ -403,8 +398,7 @@ function Get-Dependency {
 
             if ($Credentials.ContainsKey($Name)) {
                 $credential = $Credentials[$Name]
-            }
-            else {
+            } else {
                 Write-Warning "No credential found for the specified name $Name. Was the dependency misconfigured?"
             }
         }
@@ -419,8 +413,7 @@ function Get-Dependency {
 
             if (Test-Path $DependencyPath -PathType Container) {
                 $DependencyFiles = @( Resolve-DependScripts -Path $DependencyPath -Recurse $Recurse )
-            }
-            else {
+            } else {
                 $DependencyFiles = @( $DependencyPath )
             }
             $DependencyFiles = $DependencyFiles | Select-Object -Unique
@@ -434,8 +427,7 @@ function Get-Dependency {
                 Parse-Dependency -ParamSet $PSCmdlet.ParameterSetName
             }
         }
-    }
-    elseif ($PSCmdlet.ParameterSetName -eq 'Hashtable') {
+    } elseif ($PSCmdlet.ParameterSetName -eq 'Hashtable') {
         $DependencyFile = 'Hashtable'
         $ParsedDependencies = foreach ($InputDependency in $InputObject) {
             $Dependencies = $InputDependency.Clone()

PSDepend/en-US/about_PSDepend.help.txt

@@ -1,6 +1,5 @@
 TOPIC
     about_PSDepend
-# cspell:ignore projectx
 
 SHORT DESCRIPTION
     PSDepend is a module to simplify dependency handling

README.md

@@ -1,7 +1,5 @@
 [![CI](https://github.com/PowerShellOrg/PSDepend/actions/workflows/ci.yml/badge.svg)](https://github.com/PowerShellOrg/PSDepend/actions/workflows/ci.yml)
 
-<!-- cspell:ignore psdepen -->
-
 # PSDepend
 
 PSDepend is a PowerShell dependency handler. Define your dependencies in a simple `.psd1` file and let `Invoke-PSDepend` install them — similar to `pip install -r requirements.txt` or `bundle install`.

cspell.json

@@ -8,27 +8,29 @@
     ],
     "words": [
         "BHPS",
-        "Creds",
-        "Flaticon",
         "RSAT",
+        "choco",
+        "psake",
+        "nuget",
+        "PSDepend"
+    ],
+    "ignoreWords": [
+        "Creds",
         "ContainsKey",
         "Padgett",
         "PSGALLERY",
         "TARGETDIR",
         "addtopath",
         "buildhelpers",
-        "choco",
         "dotnetsdk",
         "gitbook",
         "islatest",
-        "nuget",
         "packagesource",
         "proga",
         "psdependoptions",
         "psdeploy",
         "psgallerymodule",
         "psgallerynuget",
-        "psake",
         "psresourceget",
         "providername",
         "ramblingcookiemonster",
@@ -37,6 +39,5 @@
         "validatescript",
         "whatif"
     ],
-    "ignoreWords": [],
     "import": []
 }