A suggestion to enhance the experience of windows users in Powershell.

[abgox]

• If the user is using PowerShell on windows, here is the experience of using only argc-completions.

  

• Unfortunately, the menu don't work when the display area is small, Neither is PowerShell's built-in menu.

  

• I've written a PSCompletions module that provides a more powerful completion menu.

• Now it can work with argc-completions.

  

• argc-completions + PSCompletions , it should be the better completion experience for users of PowerShell in Windows right now.

• I think the guide can be given in the README.

[YuniqueUnic]

@abgox Hello, can you write a simple tutorial that how to integrate the argc-completions with powershell/pwsh? I follow those steps to try to integrate argc-completions with pwsh, but failed even through the PSCompletions Module.

git clone https://github.com/sigoden/argc-completions.git
  cd argc-completions
  ./scripts/download-tools.sh
  ./scripts/setup-shell.sh powershell

my $PROFILE content as below.

// $PROFILE
oh-my-posh init pwsh --config "$env:POSH_THEMES_PATH\peru.omp.json" | Invoke-Expression

# Aliases
Set-Alias -Name ai -Value aichat

Import-Module PSReadLine

Set-PSReadLineOption -PredictionSource History
$OutputEncoding = [console]::InputEncoding = [console]::OutputEncoding = New-Object System.Text.UTF8Encoding 

# Import Terminal-Icons to offer Icon
Import-Module Terminal-Icons


# Config argc-completions
$env:ARGC_COMPLETIONS_ROOT = 'Y:\projs\others\argc-completions'
$env:ARGC_COMPLETIONS_PATH = ($env:ARGC_COMPLETIONS_ROOT + '\completions\windows;' + $env:ARGC_COMPLETIONS_ROOT + '\completions')
$env:PATH = $env:ARGC_COMPLETIONS_ROOT + '\bin' + [IO.Path]::PathSeparator + $env:PATH
# To add completions for only the specified command, modify next line e.g. $argc_scripts = @("cargo", "git")
# $argc_scripts = ((Get-ChildItem -File -Path ($env:ARGC_COMPLETIONS_ROOT + '\completions\windows'), ($env:ARGC_COMPLETIONS_ROOT + '\completions')) | ForEach-Object { $_.BaseName })
$paths = @("$env:ARGC_COMPLETIONS_ROOT\completions\windows", "$env:ARGC_COMPLETIONS_ROOT\completions")
$argc_scripts = Get-ChildItem -Path $paths | Where-Object { -not $_.PSIsContainer } | ForEach-Object { $_.BaseName }

# Import PSCompletions
# Import-Module PSCompletions
$PSCompletions.argc_completions($argc_scripts) 

[abgox]

• Now it can work with argc-completions.

@YuniqueUnic Here's a tutorial.

$argc_scripts = Get-ChildItem -Path $paths | Where-Object { -not $_.PSIsContainer } | ForEach-Object { $_.BaseName }

• On this line, try removing | Where-Object { -not $_.PSIsContainer }.

[abgox]

@YuniqueUnic For you, $PROFILE should be like this.

oh-my-posh init pwsh --config "$env:POSH_THEMES_PATH\peru.omp.json" | Invoke-Expression

# Aliases
Set-Alias -Name ai -Value aichat

Import-Module PSReadLine

# Import PSCompletions
# It needs to be imported before modifying the encoding.
Import-Module PSCompletions

Set-PSReadLineOption -PredictionSource History
$OutputEncoding = [console]::InputEncoding = [console]::OutputEncoding = New-Object System.Text.UTF8Encoding

# Import Terminal-Icons to offer Icon
Import-Module Terminal-Icons


# Config argc-completions
$env:ARGC_COMPLETIONS_ROOT = 'Y:\projs\others\argc-completions'
$env:ARGC_COMPLETIONS_PATH = ($env:ARGC_COMPLETIONS_ROOT + '\completions\windows;' + $env:ARGC_COMPLETIONS_ROOT + '\completions')
$env:PATH = $env:ARGC_COMPLETIONS_ROOT + '\bin' + [IO.Path]::PathSeparator + $env:PATH
# To add completions for only the specified command, modify next line e.g. $argc_scripts = @("cargo", "git")
$argc_scripts = $env:ARGC_COMPLETIONS_PATH -split [System.IO.Path]::PathSeparator | Get-ChildItem -File | ForEach-Object { $_.BaseName }

$PSCompletions.argc_completions($argc_scripts)

[YuniqueUnic]

@abgox Thanks a lot. It works properly now.

[abgox]

$OutputEncoding = [console]::InputEncoding = [console]::OutputEncoding = New-Object System.Text.UTF8Encoding

@YuniqueUnic Since you're changing the encoding, it's best to put Import-Module PSCompletions before this line.

[l-t-k]

Thanks! @sigoden @abgox for the amazing work! Loving the setup of the combination of these plugins so far.

One thing, I can't get to work yet: aliases.

For example, chezmoi is aliased to ch in my powershell profile. I can't add it using psc add chezmoi as chezmoi isn't part of PSCompletions but it is included with argc. How can I get completion to work on ch?

Probably needless to say, but I am on the exact same setup as described in this issue.

[abgox]

• The logic of how they work is that argc-completions passes the completion data to PowerShell, and then PSCompeltions gets the completion data from PowerShell and displays the completion menu.
• Therefore, you should modify the argc-completions to allow ch to trigger the completion.
• Take chezmoi for example:
  • You can make a copy of argc-completions\completions\chezmoi.sh and change it to ch.sh.

[l-t-k]

@abgox are you sure that copying chezmoi.sh to ch.sh is enough? I not able to make it work. Already reloaded my shell.

One of the things I can imagine is that the argc checks on the path if a certain tool is present, otherwise it won't show any completions any way. That makes sense, because chezmoi is available on the path, but ch is not. Same goes for other completions in argc that are not installed on my machine: the completions don't work (as expected).

[abgox]

• I have not carefully studied the logic of argc.
• I just tried it with gh as an example.
  • Even if the command gh does not exist, I can trigger the completion by gh.
  • When I copy gh.sh and name it g.sh, it can also trigger normally through g.

---

• After installing chezmoi, using chezmoi can trigger the completion normally.
• In chezmoi.sh, the completions are dynamically generated by the chezmoi program.
• How to get ch to trigger as well, which may require help from @sigoden.

[CallMeLaNN]

Finally I managed to make alias works after digging into how argc and PSCompletions works.
I tried many ways but knowing the machanism, only one works, that is to duplicate the argc completion.

are you sure that copying chezmoi.sh to ch.sh is enough?

@l-t-k Nope, one more thing after copy, you have to change the ${argc__args[0]} to chezmoi hard coded because that how it will be linked, otherwise the argc__args[0] refer to your own ch. argc keep different ways of generating completion for different commands. This is applicable for some only. So you need this to make it work:

1. Copy chezmoi.sh to ch.sh
2. Call to chezmoi command specifically by replacing dynamic ${argc__args[0]} in the ch.sh
3. Register PowerShell alias as usual so you can run it.

the argc checks on the path if a certain tool is present

It doesn't, just like @abgox said and it loads all argc supported commands. For this reason, I modify it to include just what I need to reduce load time.

 # argc-completions
 # To add completions for only the specified command, modify next line e.g. $argc_scripts = @("cargo", "git")
-$argc_scripts = $env:ARGC_COMPLETIONS_PATH -split [System.IO.Path]::PathSeparator | Get-ChildItem -File | ForEach-Object { $_.BaseName }
+$argc_scripts = @("git", "chezmoi", ...) # selected argc commands
+$argc_scripts += 'cz' # additional alias
 $PSCompletions.argc_completions($argc_scripts)

+New-Alias -Name ch -Value "chezmoi"

[CallMeLaNN]

I notice aliases in zsh is just work as intended #17 but not in PowerShell, with or without PSCompletions. that give me an idea.

Instead of adding .sh workaround into the completions folder, we can support alias at the PS script level to include aliases, during Register-ArgumentCompleter. Now I can declare any New-Alias without extra work.

The PS script from both argc and PSCompletes, @sigoden/argc/src/completions/argc.ps1 and @abgox/PSCompletions/module/PSCompletions/core/init.ps1 can be updated to handle that:

1. Include all aliases for all commands in $argc_scripts back into $argc_scripts. Get-Alias -Definition do the trick.
2. Whenever the completion happened, change the alias to actual command. So argc doesn't need to know or have another .sh completion for aliases

Concern: PSCompletions treat ch and chezmoi differently, so the sorting based on history/usage is different.

PS: both project is awesome. PSCompletions have sorting and argc best tools for CLI. I just notice and I'll use argc-completions on my zsh too. Thanks.

---

For now, this is my bare minimum mokey patch of $PSCompletions.argc_completions. profile.ps1:

# define alias before calling the `argc_completions`.
New-Alias -Name cz -Value "chezmoi"
New-Alias -Name ch -Value "chezmoi"
New-Alias -Name po -Value "podman"

# argc-completions
# To add completions for only the specified command, modify next line e.g. $argc_scripts = @("cargo", "git")
# $argc_scripts = $env:ARGC_COMPLETIONS_PATH -split [System.IO.Path]::PathSeparator | Get-ChildItem -File | ForEach-Object { $_.BaseName }
# Instead of registering all available argc-completions supported commands above, only register what we need to reduce PowerShell load time.
$argc_scripts = @("git", "chezmoi", "podman", "kubectl", "ssh")

#argc --argc-completions powershell $argc_scripts | Out-String | Invoke-Expression
$PSCompletions.argc_completions($argc_scripts)

Click to expand the patch

Add to the top. We don't need this patch if it can be merged.

using namespace System.Management.Automation 

function Add-AliasesIntoArgc {
   param(
       [string[]]$argc_scripts
   )

   $aliases = $argc_scripts | ForEach-Object { Get-Alias -Definition $_ -ErrorAction SilentlyContinue } | Select-Object -ExpandProperty Name
   $argc_scripts += $aliases

   return $argc_scripts
}

function Resolve-AliasInWords {
   param(
       [Parameter(Mandatory=$true)]
       [string[]] $words
   )
   $alias = Get-Alias -Name $words[0] -ErrorAction SilentlyContinue
   if ($alias) {
       $words[0] = $alias.Definition
   }
   return $words
}

# Monkey patch argc_completions to support command alias
# Added 2 lines to call the functions above from the original code.
$PSCompletions.PSObject.Members.Remove('argc_completions')
$PSCompletions.PSObject.Members.Add(
   [PSScriptMethod]::new(
       'argc_completions',
       {
           param(
               [array]$completions # The list of completions.
           )

           $completions = Add-AliasesIntoArgc $completions

           foreach ($_ in $completions) {
               Register-ArgumentCompleter -Native -CommandName $_ -ScriptBlock {
                   param($wordToComplete, $commandAst, $cursorPosition)
                   $words = @(
                       foreach ($_ in $commandAst.CommandElements.Where({ $_.Extent.StartOffset -lt $cursorPosition })) {
                           $word = $_.ToString()
                           if ($word.Length -gt 2) {
                               if (($word.StartsWith('"') -and $word.EndsWith('"')) -or ($word.StartsWith("'") -and $word.EndsWith("'"))) {
                                   $word = $word.Substring(1, $word.Length - 2)
                               }
                           }
                           $word
                       }
                   )

                   $words = @(Resolve-AliasInWords -Words $words)

                   $emptyS = ''
                   if ($PSVersionTable.PSVersion.Major -eq 5) {
                       $emptyS = '""'
                   }
                   $lastElemIndex = -1
                   if ($words.Count -lt $commandAst.CommandElements.Count) {
                       $lastElemIndex = $words.Count - 1
                   }
                   if ($commandAst.CommandElements[$lastElemIndex].Extent.EndOffset -lt $cursorPosition) {
                       $words += $emptyS
                   }

                   foreach ($_ in @((argc --argc-compgen powershell $emptyS $words) -split "`n")) {
                       $parts = ($_ -split "`t")
                       if ($PSCompletions.config.enable_tip_when_enhance) {
                           $tip = if ($parts[3] -eq '') { ' ' }else { $parts[3] }
                           [CompletionResult]::new($parts[0], $parts[0], 'ParameterValue', $tip)
                       }
                       else {
                           [CompletionResult]::new($parts[0], $parts[0], 'ParameterValue', ' ')
                       }
                   }
               }
           }
       }
   )
)