着色求助输出：如何使用正则判处选择以连字符（ - ）开头的精确字符串，并以字母结尾

Question

我目前正在尝试为PowerShell的Get-Help cmdlet输出上色。我成功地涂上了显示我试图使用Get-Help上的CMDLET名称的输出。我还设法为显示手动页面的所有标题的输出进行了着色。但是，我无法始终看到手动页面上显示的选项的输出，如下所示：

#!/usr/bin/env powershell

$GREEN = "$([char]0x1b)[92m"
$RED = "$([char]0x1b)[91m"
$CYAN = "$([char]0x1b)[96m"
$BLUE = "$([char]0x1b)[94m" 
$YELLOW = "$([char]0x1b)[93m" 
$PURPLE = "$([char]0x1b)[95m" 
$RESET = "$([char]0x1b)[0m"

 
Get-Help @args > man_text.txt
$WORD = $args[0]

cat man_text.txt | `
    % {$_ `
         -creplace "^[A-Z \d\W]+$", "$GREEN`$0$RESET" `
         -creplace "\b$WORD\b", "$YELLOW`$0$RESET" `
         -replace "-[a-z]*\b", "$CYAN`$0$RESET" `
    }

换句话说，我需要匹配以“ a”的字符串的正则态度 - ”并以字母结尾。

如果有人可以帮助我，我真的很感激。提前致谢。

Answer 1

这是您可以将其放入$ profile文件中，以自动化着Get-Help的输出。它解决了使用REGEX \ b- \ w+（请参阅 REGEX101演示）。

# Overrides the original Get-Help command to colorize its output.

Function Get-Help {
    [CmdletBinding(DefaultParameterSetName='AllUsersView', HelpUri='https://go.microsoft.com/fwlink/?LinkID=2096483')]
    param(
        [Parameter(Position=0, ValueFromPipelineByPropertyName=$true)]
        [ValidateNotNullOrEmpty()]
        [string] ${Name},

        [string] ${Path},

        [ValidateSet('Alias','Cmdlet','Provider','General','FAQ','Glossary','HelpFile','ScriptCommand','Function','Filter','ExternalScript','All','DefaultHelp','DscResource','Class','Configuration')]
        [string[]] ${Category},

        [Parameter(ParameterSetName='DetailedView', Mandatory=$true)]
        [switch] ${Detailed},

        [Parameter(ParameterSetName='AllUsersView')]
        [switch] ${Full},

        [Parameter(ParameterSetName='Examples', Mandatory=$true)]
        [switch] ${Examples},

        [Parameter(ParameterSetName='Parameters', Mandatory=$true)]
        [string[]] ${Parameter},

        [string[]] ${Component},

        [string[]] ${Functionality},

        [string[]] ${Role},

        [Parameter(ParameterSetName='Online', Mandatory=$true)]
        [switch] ${Online},

        [Parameter(ParameterSetName='ShowWindow', Mandatory=$true)]
        [switch] ${ShowWindow}
    )

    process {
        # Call the original Get-Help command by its fully qualified path.
        $help = Microsoft.PowerShell.Core\Get-Help @PSBoundParameters

        # Define the styles for colorization.
        $style = @{
            SECTION = $PSStyle.Formatting.FormatAccent
            COMMAND = $PSStyle.Foreground.BrightYellow
            PARAM   = $PSStyle.Foreground.FromRgb(64,200,230)
        }

        # Escape the command name for use in RegEx
        $commandNameEscaped = [regex]::Escape( $help.Name )

        # Define a RegEx for doing the formatting. The names of the RegEx groups have to match the keys of the $style hashtable.
        $regEx = @(
            "(?m)(?<=^[ \t]*)(?<SECTION>[A-Z][A-Z \t\d\W]+$)"
            "(?<COMMAND>\b$commandNameEscaped\b)"
            "(?<PARAM>\B-\w+)"
        ) -join '|'

        # Format the help object
        $help | Out-String | ForEach-Object {
            [regex]::Replace( $_, $regEx, {  
                # Get the RegEx group that has matched.
                $matchGroup = $args.Groups.Where{ $_.Success }[ 1 ]
                # Use the RegEx group name to select associated style for colorizing the match.
                $style[ $matchGroup.Name ] + $matchGroup.Value + $PSStyle.Reset
            })
        }
    }
}

输出：

备注：

• 通过定义具有与现有命令相同名称的函数，我们有效地覆盖了它。
• 我们可以通过指定其完全合格的名称来调用原始命令，并使用模块前缀（例如Microsoft.powershell.core \ get-help）来调用原始命令。要获取模块前缀，请键入（get-command thecommand）.modulename。
• 使用自动$ PSSTYLE变量作为获取ANSI逃生代码的方便方式。
• 当我们使用- ？参数调用命令时，这甚至可以工作，因为此调用get-help内部。
• Regex101 的演示和解释完整模式的解释。
• 需要 PS 7.2+