🪲 [Fix]: Fix argument completers for Context:ID and ContextVault:Name (#96)

MariusStorhaug · web-flow · commit 1f4cf7cdfc70 · 2025-06-21T23:37:03.000+02:00
## Description This pull request refactors the argument completer functionality for context vaults and context IDs. It consolidates and simplifies the completers by replacing inline completers with centralized script blocks and registering them dynamically. The changes improve maintainability and reduce redundancy across multiple files. ### Refactoring Argument Completers: * **Centralized Context Vault Name Completer**: Created a reusable `$contextVaultNameCompleter` script block and registered it for relevant commands and parameters (`Vault` and `Name`). This replaces inline completers for context vault names across various functions. * **Centralized Context ID Completer**: Refactored the context ID completer into a `$contextIDCompleter` script block and registered it dynamically for commands using the `ID` parameter. The file `Complete-ContextID.ps1` was renamed to `completers.ps1` and updated accordingly. ### Removal of Inline Completers: * **Context Vault Name Completers**: Removed inline `Complete-ContextVaultName` argument completers from functions such as `Get-Context`, `Set-Context`, `Remove-ContextVault`, and others. These are now handled by the centralized completer. * **Context ID Completers**: Removed inline `Complete-ContextID` argument completers from functions like `Get-Context`, `Remove-Context`, and `Rename-Context`. These are now managed by the centralized completer. ### Code Cleanup: * **Removed Obsolete Completer Functions**: Deleted the `Complete-ContextVaultName` function as its functionality is now encapsulated in the `$contextVaultNameCompleter` script block. ## Type of change  - [ ] 📖 [Docs] - [x] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
diff --git a/src/functions/private/Completers/Complete-ContextVaultName.ps1 b/src/functions/private/Completers/Complete-ContextVaultName.ps1
diff --git a/src/functions/public/Get-Context.ps1 b/src/functions/public/Get-Context.ps1
@@ -95,13 +95,11 @@ function Get-Context {
             ValueFromPipeline,
             ValueFromPipelineByPropertyName
         )]
-        [ArgumentCompleter({ Complete-ContextID @args })]
         [SupportsWildcards()]
         [string[]] $ID = '*',
 
         # The name of the vault to store the context in.
         [Parameter()]
-        [ArgumentCompleter({ Complete-ContextVaultName @args })]
         [SupportsWildcards()]
         [string[]] $Vault = '*'
     )
diff --git a/src/functions/public/Get-ContextInfo.ps1 b/src/functions/public/Get-ContextInfo.ps1
@@ -65,13 +65,11 @@
     param(
         # The name of the context to retrieve from the vault. Supports wildcards.
         [Parameter()]
-        [ArgumentCompleter({ Complete-ContextID @args })]
         [SupportsWildcards()]
         [string[]] $ID = '*',
 
         # The name of the vault to retrieve context info from. Supports wildcards.
         [Parameter()]
-        [ArgumentCompleter({ Complete-ContextVaultName @args })]
         [string[]] $Vault = '*'
     )
 
diff --git a/src/functions/public/Remove-Context.ps1 b/src/functions/public/Remove-Context.ps1
@@ -82,13 +82,11 @@
             ValueFromPipeline,
             ValueFromPipelineByPropertyName
         )]
-        [ArgumentCompleter({ Complete-ContextID @args })]
         [SupportsWildcards()]
         [string[]] $ID,
 
         # The name of the vault to remove contexts from.
         [Parameter()]
-        [ArgumentCompleter({ Complete-ContextVaultName @args })]
         [string] $Vault
     )
 
diff --git a/src/functions/public/Rename-Context.ps1 b/src/functions/public/Rename-Context.ps1
@@ -47,7 +47,6 @@
             ValueFromPipeline,
             ValueFromPipelineByPropertyName
         )]
-        [ArgumentCompleter({ Complete-ContextID @args })]
         [string] $ID,
 
         # The new ID of the context.
@@ -60,7 +59,6 @@
 
         # The name of the vault containing the context.
         [Parameter()]
-        [ArgumentCompleter({ Complete-ContextVaultName @args })]
         [string] $Vault,
 
         # Pass the context through the pipeline.
diff --git a/src/functions/public/Set-Context.ps1 b/src/functions/public/Set-Context.ps1
@@ -66,7 +66,6 @@ function Set-Context {
 
         # The name of the vault to store the context in.
         [Parameter(Mandatory)]
-        [ArgumentCompleter({ Complete-ContextVaultName @args })]
         [string] $Vault,
 
         # Pass the context through the pipeline.
diff --git a/src/functions/public/Vault/Get-ContextVault.ps1 b/src/functions/public/Vault/Get-ContextVault.ps1
@@ -32,7 +32,6 @@
     param(
         # The name of the vault to retrieve. Supports wildcards.
         [Parameter()]
-        [ArgumentCompleter({ Complete-ContextVaultName @args })]
         [SupportsWildcards()]
         [string[]] $Name = '*'
     )
diff --git a/src/functions/public/Vault/Remove-ContextVault.ps1 b/src/functions/public/Vault/Remove-ContextVault.ps1
@@ -19,7 +19,6 @@
     param(
         # The name of the vault to remove.
         [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName, ParameterSetName = 'By Name')]
-        [ArgumentCompleter({ Complete-ContextVaultName @args })]
         [SupportsWildcards()]
         [string[]] $Name,
 
diff --git a/src/functions/public/Vault/Reset-ContextVault.ps1 b/src/functions/public/Vault/Reset-ContextVault.ps1
@@ -23,7 +23,6 @@
     param(
         # The name of the vault to reset.
         [Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName, ParameterSetName = 'By Name')]
-        [ArgumentCompleter({ Complete-ContextVaultName @args })]
         [SupportsWildcards()]
         [string[]] $Name = '*',
 
diff --git a/src/functions/public/Vault/Set-ContextVault.ps1 b/src/functions/public/Vault/Set-ContextVault.ps1
@@ -24,7 +24,6 @@ function Set-ContextVault {
     param(
         # The name of the vault to create or update.
         [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)]
-        [ArgumentCompleter({ Complete-ContextVaultName @args })]
         [string[]] $Name,
 
         # Pass the context through the pipeline.
diff --git a/src/functions/public/Vault/completers.ps1 b/src/functions/public/Vault/completers.ps1
@@ -0,0 +1,13 @@
+﻿$contextVaultNameCompleter = {
+    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
+    $null = $commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter
+    $vaults = Get-ContextVault -ErrorAction SilentlyContinue -Verbose:$false -Debug:$false
+    $vaults | Where-Object { $_.Name -like "$wordToComplete*" } | ForEach-Object {
+        [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Name)
+    }
+}
+
+$contextVaultFunctions = ($script:PSModuleInfo.FunctionsToExport | Where-Object { $_ -like '*ContextVault*' })
+
+Register-ArgumentCompleter -CommandName $script:PSModuleInfo.FunctionsToExport -ParameterName 'Vault' -ScriptBlock $contextVaultNameCompleter
+Register-ArgumentCompleter -CommandName $contextVaultFunctions -ParameterName 'Name' -ScriptBlock $contextVaultNameCompleter
diff --git a/src/functions/public/completers.ps1 b/src/functions/public/completers.ps1
@@ -1,22 +1,6 @@
-﻿function Complete-ContextID {
-    <#
-        .SYNOPSIS
-        Completion function for Context ID parameter.
-
-        .DESCRIPTION
-        Provides tab completion for Context IDs, optionally filtered by vault.
-    #>
-    [CmdletBinding()]
-    param(
-        $commandName,
-        $parameterName,
-        $wordToComplete,
-        $commandAst,
-        $fakeBoundParameter
-    )
-
+﻿$contextIDCompleter = {
+    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
     $null = $commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter
-
     $vault = $fakeBoundParameter['Vault']
     $contextInfos = if ($vault) {
         Get-ContextInfo -Vault $vault -ErrorAction SilentlyContinue -Verbose:$false -Debug:$false
@@ -27,3 +11,5 @@
         [System.Management.Automation.CompletionResult]::new($_.ID, $_.ID, 'ParameterValue', $_.ID)
     }
 }
+
+Register-ArgumentCompleter -CommandName $script:PSModuleInfo.FunctionsToExport -ParameterName 'ID' -ScriptBlock $contextIDCompleter

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@`
`32`	`32`	`param(`
`33`	`33`	`# The name of the vault to retrieve. Supports wildcards.`
`34`	`34`	`[Parameter()]`
`35`		`- [ArgumentCompleter({ Complete-ContextVaultName @args })]`
`36`	`35`	`[SupportsWildcards()]`
`37`	`36`	`[string[]] $Name = '*'`
`38`	`37`	`)`