Format-Splat

0.1.0

Format-Splat.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 Write-Verbose 'Importing from [C:\MyProjects\Format-Splat\Format-Splat\private]'
Write-Verbose 'Importing from [C:\MyProjects\Format-Splat\Format-Splat\public]'
# .\Format-Splat\public\Format-Splat.ps1
function Format-Splat
{
    <#
    .DESCRIPTION
    formats a function call into a splatted call

    .EXAMPLE
    $text = 'Copy-Item -Path $path -Destination c:\temp -Force'

    PS> Format-Splat $text

    $item = @{
        Path = $path
        Destination = 'c:\temp'
        Force = $true
    }
    Copy-Item @item


    #>
    [OutPutType('System.String')]
    [Cmdletbinding()]
    param
    (
        # The text to format into an appropriate splat command
        [parameter(
            Mandatory,
            Position = 0,
            ValueFromPipeline
        )]
        [string]
        $InputObject
    )

    $script = [scriptblock]::Create($InputObject)
    $ast = $script.ast

    $command = $ast | Select-AST -Type CommandAst

    $parameters = [ordered]@{}
    $currentParameter = $null
    $function = ''
    $parent = $null
    $other = @()

    $mode = 'function'
    foreach ($token in $command.CommandElements)
    {
        if ($null -ne $parent -and $parent -ne $token.Parent)
        {
            continue
        }

        switch ($mode)
        {
            'function'
            {
                if ($token -is [System.Management.Automation.Language.StringConstantExpressionAst])
                {
                    $function = $token.Value
                    $mode = 'parameter'
                    $parent = $token.Parent
                }
            }
            'value'
            {
                if ($token -is [System.Management.Automation.Language.StringConstantExpressionAst])
                {
                    $parameters[$currentParameter] = "'{0}'" -f $token.Value
                }
                elseif (-not($token -is [System.Management.Automation.Language.CommandParameterAst]))
                {
                    $parameters[$currentParameter] = $token.Extent
                }
                $currentParameter = $null
                $mode = 'parameter'
            }
            'parameter'
            {
                if ($token -is [System.Management.Automation.Language.CommandParameterAst])
                {
                    $currentParameter = $token.ParameterName
                    $parameters[$currentParameter] = '$true'
                    $mode = 'value'
                }
                else
                {
                    $other += $token.Extent
                }
            }
        }
    }

    if ($parameters.count -lt 1)
    {
        return $InputObject
    }

    $output = @()
    $splatName = $function -split '-' | Select-Object -Last 1
    $splatName = $splatName.substring(0, 1).tolower() + $splatName.substring(1)

    $output += '${0} = @{{' -f $splatName
    foreach ($node in $parameters.GetEnumerator())
    {
        $paramName = $node.Name.substring(0, 1).toUpper() + $node.Name.substring(1)
        $output += ' {0} = {1}' -f $paramName, $Node.Value
    }
    $output += '}'
    if ($other.count -gt 0)
    {
        $output += '{0} {1} @{2}' -f $function, ($other -join ' '), $splatName
    }
    else
    {
        $output += '{0} @{1}' -f $function, $splatName
    }

    $output | Out-String -Width 1000
}

# .\Format-Splat\public\Format-VSCodeSplat.ps1
function Format-VSCodeSplat
{
    <#
    .DESCRIPTION
    Takes the selected function with parameters and creates the needed splat call

    .EXAMPLE
    Copy-Item -Path $path -Destination c:\temp -Force

    $item = @{
        Path = $path
        Destination = 'c:\temp'
        Force = $true
    }
    Copy-Item @item

    #>
    [Cmdletbinding()]
    param
    (
        # VSCode context
        [Microsoft.PowerShell.EditorServices.Extensions.EditorContext]
        $context
    )

    try 
    {
        if ($null -ne $context)
        {
            $text = $context.CurrentFile.GetText($context.SelectedRange) | Out-String
            $output = Format-Splat -InputObject $text
            if ($output)
            {
                $context.CurrentFile.InsertText($output, $context.SelectedRange)
            }
        }
    }
    catch 
    {
        $pseditor.window.ShowWarningMessage($PSitem.ToString())
    }
}

if ($psEditor)
{
    $EditorCommand = @{
        Name           = 'Invoke-VSSplat'
        DisplayName    = 'Refactor: splat parameters for cmdlet'
        Function       = 'Format-VSCodeSplat'
        SuppressOutput = $true
    }
    Register-EditorCommand  @EditorCommand
}









Write-Verbose 'Importing from [C:\MyProjects\Format-Splat\Format-Splat\classes]'