PowerShell ile Git Yapılandırmasını Alın


Birkaç hafta önce PowerShell'in temelleri dersini veriyordum. Haftanın sonuna doğru basit komut dosyaları ve işlevler oluşturmaya başlıyoruz. Bir gece dersten sonra onlara başka bir örnek vermeyi düşünüyordum ve git'i kullanarak bir proje üzerinde çalışıyordum. Bir noktada git yapılandırmama bakıyordum ve çıktının kolayca PowerShell çıktısına, yani nesnelere dönüştürülebilecek yapılandırılmış metin olduğunu fark ettim. Bu yüzden metin çıktısını git'den nesneleri ardışık düzene yazan geleneksel bir PowerShell işlevine dönüştürmek için hızlı bir işlev geliştirdim.

Şimdi, git ile çalışmaya yönelik çok sayıda PowerShell modülü ve aracının bulunduğunu fark ettim ve tekerleği yeniden icat ediyor olabilirim. Ancak öğretme ihtiyaçlarımı karşıladı ve biraz daha geliştirdikten sonra paylaşacağımı düşündüm.

#requires -version 5.0

Function Get-GitConfig {

<#
.SYNOPSIS
    Get git configuration settings
.DESCRIPTION
    Git stores configurations settings in a simple text file format. Fortunately, this file is structured and predictable. This command will process git configuration information into PowerShell friendly output.
.PARAMETER Scope
    Possible values are Global,Local or System
.PARAMETER Path
    Enter the path to a .gitconfig file. You can use shell paths like ~\.gitconfig
.EXAMPLE
PS C:\> 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 
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 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
    [pscustomobject]
.NOTES
    The command assumes you have git installed. Otherwise, why would you be using this?

    Last updated: 11 May, 2018
.LINK
    git
#>

    [CmdletBinding(DefaultParameterSetName = "default")]
    [OutputType([PSCustomObject])]
    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]@{
                    Scope    = $scope
                    Category = $sub[0]
                    Name     = $sub[1]
                    Setting  = $split[1]
                }
            } #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

#add an optional alias
Set-Alias -Name gcc -Value Get-GitConfig

Varsayılan davranış genel git yapılandırmanızı göstermektir. Ancak farklı kapsamlar belirtebilirsiniz. Gitconfig dosyasının yolunu da belirtebilirsiniz. İşlem hattına bir nesne yazıldığı için git yapılandırmanızın farklı bölümlerini kolayca tanımlayabilirsiniz.

Bir PowerShell komutunuz olduğunda her türlü şey mümkündür.

Eğer bir git kullanıcısıysanız, fonksiyonun bir kopyasını alacağınızı ve ne düşündüğünüzü bana bildireceğinizi umuyorum.

İlgili makaleler