Pipe script updates

CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.1.2:
+* New Inline Language support
+  * Batch support (Fixes #198)
+  * Bash Support  (Fixes #194)
+* Core Inline Transpiler : Adding -LinePattern (fixes #197)
+* New-PipeScript: Writing help (Fixes #195) and functions (fixes #196)
+* AST Type Improvements:
+  * Adding [AST].Transpile() (Fixes #192)
+  * Considering a pipeline in a hashtable to be assigned (Fixes #193)
+  * [ScriptBlock]/[AST]:  Adding .Transpilers (Fixes #185)
+  * [CommandAst].ResolvedCommand:  Checking transpilers first (Fixes #186)
+* Improvements:
+  * new keyword property bag improvements (Fixes #191)
+  * Use-PipeScript:  Defaulting to core transpiler (Fixes #188)
+  * Core Transpiler:  Allowing -ScriptBlock to be provided postionally (Fixes #189)
+  * Adding Hashtable formatter (Fixes #187)
+  * HTTP Protocol: Enabling Splatting (Fixes #183)
+  * Requiring Inline Transpilers accept [Management.Automation.CommandInfo] from the Pipeline (Fixes #184)
+---
+
 ## 0.1.1:
 * New Keywords:
   * await (Fixes #181)

Formatting/Hashtable.format.ps1

@@ -0,0 +1,3 @@
+Write-FormatView -TypeName Hashtable -Name Hashtable -Action {
+    $_ | Format-Hashtable -Depth $FormatEnumerationLimit
+}

Get-PipeScript.ps1

@@ -1,4 +1,4 @@
-#region Piecemeal [ 0.3.3 ] : Easy Extensible Plugins for PowerShell
+#region Piecemeal [ 0.3.4 ] : Easy Extensible Plugins for PowerShell
 # Install-Module Piecemeal -Scope CurrentUser 
 # Import-Module Piecemeal -Force 
 # Install-Piecemeal -ExtensionNoun 'PipeScript' -ExtensionPattern '\.psx\.ps1{0,1}$','\.ps1{0,1}\.(?<ext>[^.]+$)','\.ps1{0,1}$' -ExtensionTypeName 'PipeScript' -OutputPath '.\Get-PipeScript.ps1'
@@ -230,7 +230,7 @@ function Get-PipeScript
                 }
 
             $extCmd.PSObject.Methods.Add([psscriptmethod]::new('GetExtendedCommands', {
-
+                param([Management.Automation.CommandInfo[]]$CommandList)
                 $extendedCommandNames = @(
                     foreach ($attr in $this.ScriptBlock.Attributes) {
                         if ($attr -isnot [Management.Automation.CmdletAttribute]) { continue }
@@ -244,13 +244,16 @@ function Get-PipeScript
                     $this | Add-Member NoteProperty ExtensionCommands @() -Force
                     return    
                 }
-                $allLoadedCmds = $ExecutionContext.SessionState.InvokeCommand.GetCommands('*','All', $true)
+                if (-not $CommandList) {
+                    $commandList = $ExecutionContext.SessionState.InvokeCommand.GetCommands('*','Function,Alias,Cmdlet', $true)
+                }
                 $extends = @{}
-                foreach ($loadedCmd in $allLoadedCmds) {
+                :nextCommand foreach ($loadedCmd in $commandList) {
                     foreach ($extensionCommandName in $extendedCommandNames) {
                         if ($extensionCommandName -and $loadedCmd.Name -match $extensionCommandName) {
                             $loadedCmd
                             $extends[$loadedCmd.Name] = $loadedCmd
+                            continue nextCommand
                         }
                     }
                 }
@@ -263,7 +266,12 @@ function Get-PipeScript
                 $this | Add-Member NoteProperty ExtensionCommands $extends.Values -Force
             }))
 
-            $null = $extCmd.GetExtendedCommands()
+            if (-not $script:AllCommands) {
+                $script:AllCommands = $ExecutionContext.SessionState.InvokeCommand.GetCommands('*','Function,Alias,Cmdlet', $true)
+            }
+
+
+            $null = $extCmd.GetExtendedCommands($script:AllCommands)
 
             $inheritanceLevel = [ComponentModel.InheritanceLevel]::Inherited
 
@@ -824,9 +832,8 @@ function Get-PipeScript
                     return $allDynamicParameters
                 }
             }
-        }
-        #endregion Define Inner Functions
-
+        }        
+        #endregion Define Inner Functions        
 
         $extensionFullRegex =
             [Regex]::New($(
@@ -847,7 +854,8 @@ function Get-PipeScript
         $getCmd    = $ExecutionContext.SessionState.InvokeCommand.GetCommand
 
         if ($Force) {
-            $script:PipeScripts = $null
+            $script:PipeScripts  = $null
+            $script:AllCommands = @()
         }
         if (-not $script:PipeScripts)
         {
@@ -917,5 +925,5 @@ function Get-PipeScript
         }
     }
 }
-#endregion Piecemeal [ 0.3.3 ] : Easy Extensible Plugins for PowerShell
+#endregion Piecemeal [ 0.3.4 ] : Easy Extensible Plugins for PowerShell
 

Get-Transpiler.ps1

@@ -1,4 +1,4 @@
-#region Piecemeal [ 0.3.3 ] : Easy Extensible Plugins for PowerShell
+#region Piecemeal [ 0.3.4 ] : Easy Extensible Plugins for PowerShell
 # Install-Module Piecemeal -Scope CurrentUser 
 # Import-Module Piecemeal -Force 
 # Install-Piecemeal -ExtensionNoun 'Transpiler' -ExtensionPattern '\.psx\.ps1$' -ExtensionTypeName 'PipeScript.Transpiler' -OutputPath '.\Get-Transpiler.ps1'
@@ -230,7 +230,7 @@ function Get-Transpiler
                 }
 
             $extCmd.PSObject.Methods.Add([psscriptmethod]::new('GetExtendedCommands', {
-
+                param([Management.Automation.CommandInfo[]]$CommandList)
                 $extendedCommandNames = @(
                     foreach ($attr in $this.ScriptBlock.Attributes) {
                         if ($attr -isnot [Management.Automation.CmdletAttribute]) { continue }
@@ -244,13 +244,16 @@ function Get-Transpiler
                     $this | Add-Member NoteProperty ExtensionCommands @() -Force
                     return    
                 }
-                $allLoadedCmds = $ExecutionContext.SessionState.InvokeCommand.GetCommands('*','All', $true)
+                if (-not $CommandList) {
+                    $commandList = $ExecutionContext.SessionState.InvokeCommand.GetCommands('*','Function,Alias,Cmdlet', $true)
+                }
                 $extends = @{}
-                foreach ($loadedCmd in $allLoadedCmds) {
+                :nextCommand foreach ($loadedCmd in $commandList) {
                     foreach ($extensionCommandName in $extendedCommandNames) {
                         if ($extensionCommandName -and $loadedCmd.Name -match $extensionCommandName) {
                             $loadedCmd
                             $extends[$loadedCmd.Name] = $loadedCmd
+                            continue nextCommand
                         }
                     }
                 }
@@ -263,7 +266,12 @@ function Get-Transpiler
                 $this | Add-Member NoteProperty ExtensionCommands $extends.Values -Force
             }))
 
-            $null = $extCmd.GetExtendedCommands()
+            if (-not $script:AllCommands) {
+                $script:AllCommands = $ExecutionContext.SessionState.InvokeCommand.GetCommands('*','Function,Alias,Cmdlet', $true)
+            }
+
+
+            $null = $extCmd.GetExtendedCommands($script:AllCommands)
 
             $inheritanceLevel = [ComponentModel.InheritanceLevel]::Inherited
 
@@ -824,9 +832,8 @@ function Get-Transpiler
                     return $allDynamicParameters
                 }
             }
-        }
-        #endregion Define Inner Functions
-
+        }        
+        #endregion Define Inner Functions        
 
         $extensionFullRegex =
             [Regex]::New($(
@@ -847,7 +854,8 @@ function Get-Transpiler
         $getCmd    = $ExecutionContext.SessionState.InvokeCommand.GetCommand
 
         if ($Force) {
-            $script:Transpilers = $null
+            $script:Transpilers  = $null
+            $script:AllCommands = @()
         }
         if (-not $script:Transpilers)
         {
@@ -917,5 +925,5 @@ function Get-Transpiler
         }
     }
 }
-#endregion Piecemeal [ 0.3.3 ] : Easy Extensible Plugins for PowerShell
+#endregion Piecemeal [ 0.3.4 ] : Easy Extensible Plugins for PowerShell
 

New-PipeScript.ps1

@@ -152,7 +152,28 @@ HTTP Accept indicates what content types the web request will accept as a respon
     #>
     [Alias('WeakType', 'WeakParameters', 'WeaklyTypedParameters', 'WeakProperties', 'WeaklyTypedProperties')]
     [switch]
-    $WeaklyTyped
+    $WeaklyTyped,
+    # The name of the function to create.
+    [string]
+    $FunctionName,
+    # The type of the function to create.  This will be ignored if -FunctionName is not passed.
+    [string]
+    $FunctionType = 'function',
+    # A description of the script's functionality.  If provided with -Synopsis, will generate help.
+    [string]
+    $Description,
+    # A short synopsis of the script's functionality.  If provided with -Description, will generate help.
+    [string]
+    $Synopsis,
+    # A list of examples to use in help.  Will be ignored if -Synopsis and -Description are not passed.
+    [string[]]
+    $Example,
+    # A list of links to use in help.  Will be ignored if -Synopsis and -Description are not passed.
+    [string[]]
+    $Link,
+    # A list of attributes to declare on the scriptblock.
+    [string[]]
+    $Attribute
     )
     begin {
         $ParametersToCreate    = [Ordered]@{}
@@ -177,6 +198,36 @@ HTTP Accept indicates what content types the web request will accept as a respon
         }
     }
     process {
+        if ($Synopsis -and $Description) {
+            function indentHelpLine {
+                            foreach ($line in $args -split '(?>\r\n|\n)') {
+                                (' ' * 4) + $line.Trim()
+                            }
+
+            }
+            $helpHeader = @(
+                "<#"
+                ".Synopsis"
+                indentHelpLine $Synopsis
+                ".Description"
+                indentHelpLine $Description
+
+                foreach ($helpExample in $Example) {
+                    ".Example"
+                    indentHelpLine $helpExample
+                }
+                foreach ($helplink in $Link) {
+                    ".Link"
+                    indentHelpLine $link
+                } 
+                "#>"
+            ) -join [Environment]::Newline
+            $allHeaders += $helpHeader
+        }
+
+        if ($Attribute) {
+            $allHeaders += $Attribute
+        }
         if ($parameter) {
             # The -Parameter can be a dictionary of parameters.
             if ($Parameter -is [Collections.IDictionary]) {
@@ -252,6 +303,7 @@ HTTP Accept indicates what content types the web request will accept as a respon
                         $parameter
                     }
             }
+            # If the -Parameter was provided via reflection
             elseif ($parameter -is [Reflection.PropertyInfo] -or
                 $parameter -as [Reflection.PropertyInfo[]] -or
                 $parameter -is [Reflection.ParameterInfo] -or
@@ -324,15 +376,21 @@ HTTP Accept indicates what content types the web request will accept as a respon
             # accumulate them.
             $allEndBlocks += $end
         }
+        # If -AutoParameter was passed
         if ($AutoParameter) {
+            # Find all of the variable expressions within -Begin, -Process, and -End
             $variableDefinitions = $Begin, $Process, $End |
                 Where-Object { $_ } |
                 Search-PipeScript -AstType VariableExpressionAST |
                 Select-Object -ExpandProperty Result
             foreach ($var in $variableDefinitions) {
+                # Then, see where those variables were assigned
                 $assigned = $var.GetAssignments()
+                # (if they were assigned, keep moving)
                 if ($assigned) { continue }
+                # If there were not assigned
                 $varName = $var.VariablePath.userPath.ToString()
+                # add it to the list of parameters to create.
                 $ParametersToCreate[$varName] = @(
                     @(
                     "[Parameter(ValueFromPipelineByPropertyName)]"
@@ -359,7 +417,7 @@ HTTP Accept indicates what content types the web request will accept as a respon
             $newParamBlock = $parameterScriptBlocks | Join-PipeScript
         }
         # Create the script block by combining together the provided parts.
-        $createdScriptBlock = [scriptblock]::Create("
+        $createdScriptBlock = [scriptblock]::Create("$(if ($functionName) { "$functionType $FunctionName {"})
 $($allHeaders -join [Environment]::Newline)
 $newParamBlock
 $(if ($allDynamicParameters) {
@@ -376,9 +434,17 @@ $(if ($allEndBlocks -and -not $allBeginBlocks -and -not $allProcessBlocks) {
 } elseif ($allEndBlocks) {
     @(@("end {") + $allEndBlocks + '}') -join [Environment]::Newline
 })
+$(if ($FunctionName) { '}'}) 
 ")
-        # return the created script block.
-        return $createdScriptBlock
+        # If we have a -FunctionName and the -FunctionType is not a built-in function type
+        if ($CreatedScriptBlock -and 
+            $functionName -and $FunctionType -notin 'function', 'filter') {
+            # return the transpiled script.
+            return $createdScriptBlock.Transpile()
+        } else {
+            # otherwise, return the created script.
+            return $createdScriptBlock
+        }
     }
 }