ค้นหาเว็บไซต์

รับการกำหนดค่า Git ด้วย PowerShell


เมื่อไม่กี่สัปดาห์ที่ผ่านมา ฉันกำลังสอนหลักสูตรพื้นฐาน PowerShell ในช่วงปลายสัปดาห์เราจะเริ่มสร้างสคริปต์และฟังก์ชันง่ายๆ คืนหนึ่งหลังเลิกเรียน ฉันคิดที่จะยกตัวอย่างให้พวกเขาอีกตัวอย่างหนึ่ง และฉันกำลังทำโปรเจ็กต์โดยใช้ git เมื่อถึงจุดหนึ่ง ฉันกำลังดูการกำหนดค่า git ของฉัน เมื่อฉันพบว่าเอาต์พุตเป็นข้อความที่มีโครงสร้างซึ่งสามารถเปลี่ยนเป็นเอาต์พุต PowerShell ได้อย่างง่ายดาย ซึ่งก็คือออบเจ็กต์ ดังนั้นฉันจึงใช้ฟังก์ชันด่วนเพื่อแปลงเอาต์พุตข้อความจาก git เป็นฟังก์ชัน PowerShell แบบดั้งเดิมที่เขียนวัตถุลงในไปป์ไลน์

ตอนนี้ ฉันตระหนักได้ว่ามีโมดูลและเครื่องมือ PowerShell มากมายสำหรับการทำงานกับ git และฉันก็สามารถคิดค้นวงล้อนี้ขึ้นมาใหม่ได้ แต่มันตรงตามความต้องการในการสอนของฉัน และหลังจากขัดเกลาอีกสักหน่อย ฉันจึงคิดว่าจะแชร์มัน

#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

การทำงานเริ่มต้นคือการแสดงการกำหนดค่า git ทั่วโลกของคุณ แต่คุณสามารถระบุขอบเขตที่แตกต่างกันได้ คุณยังสามารถระบุเส้นทางไปยังไฟล์ gitconfig ได้ เนื่องจากออบเจ็กต์ถูกเขียนลงในไปป์ไลน์ คุณจึงสามารถระบุส่วนต่างๆ ของการกำหนดค่า git ของคุณได้อย่างง่ายดาย

เมื่อคุณมีคำสั่ง PowerShell แล้ว ทุกสิ่งก็เป็นไปได้

หากคุณเป็นผู้ใช้ git ฉันหวังว่าคุณจะหยิบสำเนาของฟังก์ชันนี้มาและแจ้งให้เราทราบว่าคุณคิดอย่างไร

บทความที่เกี่ยวข้อง