创建更多 Git PowerShell 工具

我最近关于使用 PowerShell 创建 git 调整工具的文章引起了极大的兴趣。你们中的许多人都足够精明，意识到我所描述的旅程与目的地一样重要。考虑到这一点，我决定重新审视我去年写的另一个与 PowerShell 和 git 相关的项目。我创建了一个 PowerShell 函数来编写 git 配置的对象版本。该函数最初是一个脚本，只不过是像 git config -global -list 这样的命令的一个花哨的包装器。除了管道中没有处理文本之外，我还有对象。不管怎样，根据我在上一篇文章中学到的一些东西和我使用的一些技术，我决定重新审视代码并更新它。

添加自定义类型

PowerShell功能的本质是运行git config命令并将结构化数据解析为对象。上一个函数将通用自定义对象写入管道。但我决定利用可以用对象定义类型名的技术。

foreach ($line in $data) {
    $split = $line.split("=")
    #split the first element again to get the category and name
    $sub = $split[0].split(".")
    [PSCustomObject]@{
        PSTypeName   = 'gitConfig'
        Scope        = $scope
        Category     = $sub[0]
        Name         = $sub[1]
        Setting      = $split[1]
        Username     = $env:username
        Computername = $env:COMPUTERNAME
    }
} #foreach line

git 配置中的每一行都将转换为“gitConfig”类型的自定义对象。当我这样做时，我决定添加用户名和计算机名的附加参数。尽管目的是在本地运行命令，但如果数据被序列化或保存到文件中，那么了解其来源可能会有所帮助。当您构建自己的 PowerShell 工具时，您始终需要考虑如何使用结果，甚至在哪里使用它们。

扩展 gitConfig 类型

所以现在我有一个具有自己的类型名称的自定义对象。默认情况下我会获取所有属性。但我真的不想那样。默认情况下，我不需要查看用户名和计算机名属性。正如我上次所做的那样，解决方案是使用 Update-TypeData 定义默认属性集。

Update-TypeData -TypeName 'gitConfig' -DefaultDisplayPropertySet 'Scope', 'Category', 'Name', 'Setting' -force

如果我需要的话，附加属性就在那里。

由于我创建的自定义对象更像 PowerShell，因此它可能会失去一些“git 特性”。例如，在自定义对象中，我使用类别和设置等属性名称。但在 git 世界中，配置文件的这些部分可能更可能被称为“部分”和“值”。为了使结果对 git 更友好，我可以做的一件事是为类别和设置创建别名属性。

Update-TypeData -TypeName 'gitConfig' -MemberType AliasProperty -MemberName 'Value' -Value 'Setting' -force
Update-TypeData -TypeName 'gitConfig' -MemberType AliasProperty -MemberName 'Section' -Value 'Category' -force

即使默认显示也不会使用别名，尽管它当然可以，如果用户知道别名存在，他们就可以使用它们。

我还添加了一个自定义类型扩展来显示 git 版本。

Update-TypeData -TypeName 'gitConfig' -MemberType ScriptProperty -MemberName gitVersion -value {git --version} -force

Get-Member 显示所有这些属性。

PowerShell 代码

我已在 GitHub 上发布了该版本的脚本。

Get-GitConfig.ps1:

#requires -version 5.1

Function Get-GitConfig {

  Get-GitConfig

Scope  Category  Name         Setting
-----  --------  ----         -------
global filter    lfs          git-lfs clean -- %f
global filter    lfs          git-lfs smudge -- %f
global filter    lfs          true
global user      name         Art Deco
global user      email        [email protected]
global gui       recentrepo   C:/Scripts/Gen2Tools
global gui       recentrepo   C:/Scripts/PSVirtualBox
global gui       recentrepo   C:/Scripts/FormatFunctions
global core      editor       powershell_ise.exe
global core      autocrlf     true
global core      excludesfile ~/.gitignore
global push      default      simple
global color     ui           true
global alias     logd         log --oneline --graph --decorate
global alias     last         log -1 HEAD
global alias     pushdev      !git checkout master && git merge dev && git push && git checkout dev
global alias     st           status
global alias     fp           !git fetch && git pull
global merge     tool         kdiff3
global mergetool kdiff3       'C:/Program Files/KDiff3/kdiff3.exe' $BASE $LOCAL $REMOTE -o $MERGED

Getting global configuration settings

.EXAMPLE
PS C:\> Get-GitConfig -scope system | where category -eq 'filter'

Scope  Category Name Setting
-----  -------- ---- -------
system filter   lfs  git-lfs clean -- %f
system filter   lfs  git-lfs smudge -- %f
system filter   lfs  git-lfs filter-process
system filter   lfs  true

Get system configuration and only git filters.
.EXAMPLE
PS S:\PSScriptTools> Get-GitConfig local

Scope Category Name                    Setting
----- -------- ----                    -------
local core     repositoryformatversion 0
local core     filemode                false
local core     bare                    false
local core     logallrefupdates        true
local core     symlinks                false
local core     ignorecase              true
local remote   origin                  https://github.com/jdhitsolutions/PSScriptTools.git
local remote   origin                  +refs/heads/*:refs/remotes/origin/*
local branch   master                  origin
local branch   master                  refs/heads/master

Get the git configuration from a local repository.

.EXAMPLE
PS C:\> Get-GitConfig -path ~\.gitconfig | format-table -groupby category -property Name,Setting

Get settings from a configuration file and present in a grouped, formatted table.

.INPUTS
    none
.OUTPUTS
    [gitConfig]
.NOTES
    The command assumes you have git installed. Otherwise, why would you be using this?

    Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

    Last updated: 1 February, 2019
.LINK
    git
#>

    [CmdletBinding(DefaultParameterSetName = "default")]
    [OutputType("gitConfig")]
    [Alias("ggc")]

    Param (
        [Parameter(Position = 0, ParameterSetName = "default")]
        [ValidateSet("Global", "System", "Local")]
        [string[]]$Scope = "Global",
        [Parameter(ParameterSetName = "file")]
        #the path to a .gitconfig file which must be specified if scope if File
        [ValidateScript( {Test-Path $_})]
        [Alias("config")]
        [string]$Path
    )

    Begin {
        Write-Verbose "Starting $($myinvocation.MyCommand)"
        if ($path) {
            #convert path value to a complete file system path
            $Path = Convert-Path -Path $path
        }

        #internal helper function
        function _process {
            [cmdletbinding()]
            Param(
                [scriptblock]$scriptblock,
                [string]$Scope
            )

            Write-Verbose "Invoking $($scriptblock.tostring())"
            #invoke the scriptblock and save the text output
            $data = Invoke-Command -scriptblock $scriptblock

            #split each line of the config on the = sign
            #and add to the hashtable
            foreach ($line in $data) {
                $split = $line.split("=")
                #split the first element again to get the category and name
                $sub = $split[0].split(".")
                [PSCustomObject]@{
                    PSTypeName   = 'gitConfig'
                    Scope        = $scope
                    Category     = $sub[0]
                    Name         = $sub[1]
                    Setting      = $split[1]
                    Username     = $env:username
                    Computername = $env:COMPUTERNAME
                }
            } #foreach line
        } # _process
    } #begin

    Process {

        if ($PSCmdlet.ParameterSetName -eq 'file') {
            Write-Verbose "Getting config from $path"
            $get = [scriptblock]::Create("git config --file $path --list")
            #call the helper function
            _process -scriptblock $get -scope "File"
        }
        else {
            foreach ($item in $Scope) {
                Write-Verbose "Getting $item config"
                #the git command is case sensitive so make the scope lower case
                $item = $item.tolower()

                #create a scriptblock to run git config
                $get = [scriptblock]::Create("git config --$item --list")

                #call the helper function
                _process -scriptblock $get -Scope $item
            } #foreach scope
        } #else
    } #process

    End {
        Write-Verbose "Ending $($myinvocation.MyCommand)"
    } #end

} #end Get-GitConfig

#define a default set of properties to the custom gitConfig type
Update-TypeData -TypeName 'gitConfig' -DefaultDisplayPropertySet 'Scope', 'Category', 'Name', 'Setting' -force
#define some alias properties that might be more 'git-like'
Update-TypeData -TypeName 'gitConfig' -MemberType AliasProperty -MemberName 'Value' -Value 'Setting' -force
Update-TypeData -TypeName 'gitConfig' -MemberType AliasProperty -MemberName 'Section' -Value 'Category' -force
#add a custom property
Update-TypeData -TypeName 'gitConfig' -MemberType ScriptProperty -MemberName gitVersion -value {git --version} -force

如果您查看参数声明之前，您可以看到我正在使用自定义类型名称定义输出类型。如果您将其括在大括号中，如 [gitConfig] PowerShell 可能会尝试查找注册类型并抱怨。使用字符串。无论如何，这都是出于文档目的。我还定义了一个别名，ggc，作为函数的一部分。这样我就不必包含运行 Set-Alias 或 New-Alias 的代码。

我想指出的另一项是内部和私有“助手”功能的使用。该函数不使用标准的动词-名词名称，因为它不向用户公开。这是可以根据参数集调用的代码块。我不想要的是两份代码块。这不仅使代码变得更加笨拙，我还必须将代码维护在适当的位置。使用私有函数进行模块化简化了过程，如果我正在构建 Pester 测试，也会更容易测试。

以 PowerShell 方式获取 Git 配置

一旦我获得了 ps1 文件，我就有了一个新命令，可以让我以多种方式查看我的 git 配置。

我意识到您仍然可以使用 git 命令行工具来显示许多相同的信息。但是当我将其转换为 PowerShell 时，我可以围绕它构建其他工具，如下所示：

#dot source the required function
. C:\scripts\Get-Gitconfig.ps1

$data = Get-GitConfig -Scope Global,System
$frags = @("<H1>Git Configuration</H1>")
$frags+= $data[0] | Select-object "Computername","Username"| ConvertTo-Html -Fragment

$data | Group-Object -Property Scope | ForEach-Object {
 $frags += "<H2>$($_.name.toupper())</H2>"
 $frags+= $_.group | Sort-Object Category | 
 Select-Object -Property Category,Name,Setting | ConvertTo-Html -Fragment
}

$head = @"
<Title> git Configuration</Title>
<style>
body { background-color:#FFFFFF;
       font-family:Monospace;
       font-size:10pt; }
td, th { border:0px solid black; 
         border-collapse:collapse;
         white-space:pre;
         font-size:12pt; }
th { color:white;
     background-color:black; }
table, tr, td, th { padding: 0px; margin: 0px ;white-space:pre; }
tr:nth-child(odd) {background-color: lightgray}
table { margin-left:10px; }
h2 {
 font-family:Tahoma;
}
</style>

"@

ConvertTo-Html -Body $frags -Head $head -PostContent "<h4>$($data[0].gitversion)</h4>"| Out-File mygit.html -Encoding ascii

这将创建我的 git 配置的 html 报告。如果您安装了 git，您也应该能够运行它。

我希望这次旅程能提供丰富的信息。尽管最好的学习方法是实践。我希望您能抓住我的代码，打开脚本编辑器，看看它们是如何工作的。让他们旋转一下。调整它们看看会发生什么。玩得开心。这就是你学习的方式。