tips.ps1
. $PSScriptRoot\Command.ps1 . $PSScriptRoot\Alias.ps1 $script:AliasTipsHashFile = [System.IO.Path]::Combine("$HOME", '.alias-tips-hash') function script:SeperateCommand { param( [Parameter(Mandatory)][string]$Line ) if ($Line -match "(?<cmd>.*)(?<sep>;|(\|\|)|(&&))(?<rest>.*)") { if ($AliasTipsDebug) { Write-Host "Splitting line into $($matches['cmd']), $($matches['sep']), and $($matches['rest'])" } $LeftHalf = Find-Alias($matches['cmd']) $RightHalf = SeperateCommand $($matches['rest']) # If the left half isn't found restore the left half if (-not $LeftHalf) { $LeftHalf = $matches['cmd'] | Format-CleanCommand } # If the right half isn't found restore the right half if (-not $RightHalf) { $RightHalf = $matches['rest'] | Format-CleanCommand } $CompleteAlias = $($LeftHalf + "$(If ($matches['sep'] -eq ';') {''} else {' '})$($matches['sep']) " + $RightHalf) | Format-CleanCommand # only return the alias if it is different from the line if ($CompleteAlias -ne $($Line | Format-CleanCommand)) { return $CompleteAlias } } else { return Find-Alias($Line) } } function PSConsoleHostReadLine { ## Get the execution status of the last accepted user input. ## This needs to be done as the first thing because any script run will flush $?. $lastRunStatus = $? ($Line = [Microsoft.PowerShell.PSConsoleReadLine]::ReadLine($host.Runspace, $ExecutionContext, $lastRunStatus)) # split line into multiple commands if possible $alias = SeperateCommand $Line if ($alias -and -not $AliasTipsThreadJob -and $AliasTipsHash.Length -gt 0) { # Only react to non-blank lines. $tip = "Alias tip: $alias" $host.UI.SupportsVirtualTerminal ? "`e[033m$tip`e[m" : $tip | Out-Host } } $script:AliasTipsHash = if (Test-Path $AliasTipsHashFile) { ConvertFrom-StringData -StringData $([System.IO.File]::ReadAllText($AliasTipsHashFile)) -Delimiter "|" } else { @{} } if ($AliasTipsDebug) { Write-Host $AliasTipsHash.Count } # Attempts to find an alias function Find-Alias { param( [Parameter(Mandatory)][string]$Command ) if ($AliasTipsHash.Count -eq 0) { $AliasTipsHash = ConvertFrom-StringData -StringData $([System.IO.File]::ReadAllText($AliasTipsHashFile)) -Delimiter "|" } # If we can find the alias quickly, do so $Alias = $AliasTipsHash[$Command.Trim()] if ($Alias) { return $Alias } # TODO check if it is an alias, expand it back out to check if there is a better alias $Regex = Get-CommandMatcher $Command if ($Regex -eq "") { return "" } $SimpleSubRegex ="$([Regex]::Escape($($Command | Format-CleanCommand).Split(" ")[0]))[^`$`n]*\`$" $Aliases = @("") if ($AliasTipsDebug) { Write-Host "`n$Regex`n`n$SimpleSubRegex`n" } # Create a new AliasHash with evaluated expression $AliasTipsHashEvaluated = $AliasTipsHash.Clone() $AliasTipsHash.GetEnumerator() | ForEach-Object { if ($_.key -match $Regex) { $Aliases += $_.key } # Substitute commands using ExecutionContext if possible # Check if we have anything that has a $(...) if ($_.key -match $SimpleSubRegex) { $NewKey = Format-CommandAST($_.value) if ($NewKey -and $($NewKey -replace '\$args','') -match $Regex) { $Aliases += $($NewKey -replace '\$args','').Trim() $AliasTipsHashEvaluated[$NewKey] = $_.value } } } Clear-AliasTipsInternalASTResults if ($AliasTipsDebug) { Write-Host $($Aliases -Join ",") } # Use the longest candiate $AliasCandidate = ($Aliases | Sort-Object -Descending -Property Length)[0] $Alias = "" if ($AliasCandidate) { $Remaining = "$($Command)" $CleanAlias = "$($AliasCandidate)" | Format-CleanCommand $AttemptSplit = $CleanAlias -split " " $AttemptSplit | ForEach-Object { [Regex]$Pattern = [Regex]::Escape("$_") $Remaining = $Pattern.replace($Remaining, "", 1) } if (-not $Remaining) { $Alias = ($AliasTipsHashEvaluated[$AliasCandidate]) | Format-CleanCommand } if ($AliasTipsHashEvaluated[$AliasCandidate + ' $args']) { # TODO: Sometimes superflous args aren't at the end... Fix this. $Alias = ($AliasTipsHashEvaluated[$AliasCandidate + ' $args'] + $Remaining) | Format-CleanCommand } if ($Alias -ne $Command) { return $Alias } } } function Find-AliasTips { $CommandsPattern = Get-CommandsPattern $global:AliasTipsProxyFunctionRegex = $CommandsPattern | Get-ProxyFunctionRegex $global:AliasTipsProxyFunctionRegexNoArgs = $CommandsPattern | Get-ProxyFunctionRegexNoArgs $AliasTipsHash = Get-AliasHash $Value = $($AliasTipsHash.GetEnumerator() | ForEach-Object { if ($_.Key.Length -ne 0) { # Replaces \ with \\ "$($_.Key -replace "\\", "\\")|$($_.Value -replace "\\", "\\")" } }) Write-Host $UsedKeys Set-Content -Path $AliasTipsHashFile -Value $Value } function Start-FindAliasTips { <# .SYNOPSIS This is a async way of generating the .alias-tips-hash. However, it lacks the context environment of the PROFILE. TODO add a fix, so it will load the profile. #> if (-not $script:AliasTipsThreadJob) { $ArgsToThreadJob = @( $(Get-Item -Path Function:\Get-AliasHash | Select-Object -ExpandProperty 'Definition'), $(Get-Item -Path Function:\GetProxyFunctionRegex | Select-Object -ExpandProperty 'Definition'), $(Get-Item -Path Function:\GetProxyFunctionRegexNoArgs | Select-Object -ExpandProperty 'Definition'), $(Get-Item -Path Function:\Format-CleanCommand | Select-Object -ExpandProperty 'Definition'), $AliasTipsHashFile ) Start-ThreadJob -Name 'Find-AliasTips' -StreamingHost $Host { param( [Parameter(Mandatory, Position=0)][string]$GetAliasHash, [Parameter(Mandatory, Position=1)][string]$GetProxyFunctionRegex, [Parameter(Mandatory, Position=2)][string]$GetProxyFunctionRegexNoArgs, [Parameter(Mandatory, Position=3)][string]$FormatCleanCommand, [Parameter(Mandatory, Position=4)][string]$AliasTipsHashFile ) function Format-CleanCommand { param( [Parameter(Mandatory, Position=0, ValueFromPipeline = $true)][string]${Command} ) return $(Invoke-Command -ScriptBlock ([scriptblock]::Create($FormatCleanCommand)) -ArgumentList @($Command)) } $global:AliasTipsHash = Invoke-Command -ScriptBlock ([scriptblock]::Create($GetAliasHash)) $global:AliasTipsProxyFunctionRegex = Invoke-Command -ScriptBlock ([scriptblock]::Create($GetProxyFunctionRegex)) $global:AliasTipsProxyFunctionRegexNoArgs = Invoke-Command -ScriptBlock ([scriptblock]::Create($GetProxyFunctionRegexNoArgs)) $Value = $($AliasTipsHash.GetEnumerator() | ForEach-Object { if ($_.Key.Length -ne 0) { # Replaces \ with \\ "$($_.Key -replace "\\", "\\")|$($_.Value -replace "\\", "\\")" } }) Set-Content -Path $AliasTipsHashFile -Value $Value } -ThrottleLimit 1 -ArgumentList $ArgsToThreadJob -InitializationScript $AliasTipsStringScriptBlockThreadJob } } if ($AliasTipsLoadAliasOnImport) { if ($AliasTipsSynchronousLoad) { Find-AliasTips } else { Start-FindAliasTips } } |