Polish a few things in documentation

Add (and document) -recurse option for views
Add an example one-line view in the readme
Add an explicit license

Author: Jaykul

ErrorView.psd1

@@ -5,37 +5,36 @@
     CompanyName          = 'PoshCode'
 
     ModuleToProcess      = 'ErrorView.psm1'
-    ModuleVersion        = '0.0.1'
+    ModuleVersion        = '0.0.2'
 
     Copyright            = '(c) Joel Bennett. All rights reserved.'
 
-    FunctionsToExport    = 'Format-Error', 'Write-NativeCommandError', 'ConvertTo-CategoryErrorView', 'ConvertTo-NormalErrorView', 'ConvertTo-SimpleErrorView'
+    FunctionsToExport    = 'Format-Error', 'Set-ErrorView', 'Write-NativeCommandError', 'ConvertTo-CategoryErrorView', 'ConvertTo-NormalErrorView', 'ConvertTo-SimpleErrorView', 'ConvertTo-FullErrorView'
 
     CmdletsToExport      = @()
     VariablesToExport    = @()
     AliasesToExport      = @("fe")
 
-PrivateData = @{
-    PSData = @{
-        # Tags applied to this module. These help with module discovery in online galleries.
-        # Tags = @()
+    PrivateData = @{
+        PSData = @{
+            # Tags applied to this module. These help with module discovery in online galleries.
+            Tags = @("ErrorView")
 
-        # A URL to the license for this module.
-        # LicenseUri = ''
+            # A URL to the license for this module.
+            LicenseUri = "http://opensource.org/licenses/MIT"
 
-        # A URL to the main website for this project.
-        # ProjectUri = ''
+            # A URL to the main website for this project.
+            ProjectUri = 'https://github.com/poshcode/errorview'
 
-        # A URL to an icon representing this module.
-        # IconUri = ''
+            # A URL to an icon representing this module.
+            # IconUri = ''
 
-        # ReleaseNotes of this module
-        ReleaseNotes = 'This module exists for testing ideas for ErrorViews'
+            # ReleaseNotes of this module
+            ReleaseNotes = 'I wrote this module to enhace ErrorViews for Windows PowerShell (without waiting for PS7+)'
 
-    } # End of PSData hashtable
+        } # End of PSData hashtable
 
-} # End of PrivateData hashtable
+    } # End of PrivateData hashtable
 
-# HelpInfoURI = ''
 }
 

ErrorView.psm1

@@ -7,10 +7,29 @@ param(
 Update-FormatData -PrependPath $PSScriptRoot\ErrorView.ps1xml
 
 function Format-Error {
+    <#
+        .SYNOPSIS
+            Formats an error for the screen using a custom error view
+        .DESCRIPTION
+            Temporarily switches the error view and outputs the errors
+        .EXAMPLE
+            Format-Error
+
+            Shows the Normal error view for the most recent error
+        .EXAMPLE
+            $error[0..4] | Format-Error Full
+
+            Shows the full error view (like using | Format-List * -Force) for the most recent 5 errors
+        .EXAMPLE
+            $error[3] | Format-Error Full -Recurse
+
+            Shows the full error view of the specific error, recursing into the inner exceptions (if that's supported by the view)
+    #>
     [CmdletBinding()]
     [Alias("fe")]
     [OutputType([System.Management.Automation.ErrorRecord])]
     param(
+        # The name of the ErrorView you want to use (there must a matching ConvertTo-${View}ErrorView function)
         [Parameter(Position=0, ValueFromPipelineByPropertyName)]
         [ArgumentCompleter({
             param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
@@ -20,21 +39,56 @@ function Format-Error {
         })]
         $View = "Normal",
 
+        # Error records (e.g. from $Error). Defaults to the most recent error: $Error[0]
         [Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
-        [System.Management.Automation.ErrorRecord]$InputObject
+        [Alias("ErrorRecord")]
+        [System.Management.Automation.ErrorRecord]$InputObject = $(
+            $e = $global:Error[0]
+            if ($e -is ([System.Management.Automation.ErrorRecord])) { $e }
+            elseif ($e.ErrorRecord -is ([System.Management.Automation.ErrorRecord])) { $e.ErrorRecord }
+            elseif ($global:Error.Count -eq 0) { Write-Warning "The global `$Error collection is empty" }
+        ),
 
+        # Allows ErrorView functions to recurse to InnerException
+        [switch]$Recurse
     )
     begin {
+        $ErrorActionPreference = "Continue"
         $View, $global:ErrorView = $ErrorView, $View
+        [bool]$Recurse, [bool]$global:ErrorViewRecurse = [bool]$global:ErrorViewRecurse, $Recurse
     }
     process {
         $InputObject
     }
     end {
+        [bool]$global:ErrorViewRecurse = $Recurse
         $global:ErrorView = $View
     }
 }
 
+function Set-ErrorView {
+    <#
+        .SYNOPSIS
+            A helper function to provide tab-completion for error view names
+    #>
+    [CmdletBinding()]
+    [Alias("fe")]
+    [OutputType([System.Management.Automation.ErrorRecord])]
+    param(
+        # The name of the ErrorView you want to use (there must a matching ConvertTo-${View}ErrorView function)
+        [Parameter(Position = 0, ValueFromPipelineByPropertyName)]
+        [ArgumentCompleter( {
+                param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
+                [System.Management.Automation.CompletionResult[]]((
+                        Get-Command ConvertTo-*ErrorView -ListImported -ParameterName InputObject -ParameterType [System.Management.Automation.ErrorRecord]
+                    ).Name -replace "ConvertTo-(.*)ErrorView", '$1' -like "*$($wordToComplete)*")
+            })]
+        $View = "Normal"
+    )
+    $global:ErrorView = $View
+}
+
+
 function Write-NativeCommandError {
     [CmdletBinding()]
     param(
@@ -207,3 +261,25 @@ function ConvertTo-NormalErrorView {
         }
     }
 }
+
+function ConvertTo-FullErrorView {
+    [CmdletBinding()]
+    param(
+        [System.Management.Automation.ErrorRecord]
+        $InputObject
+    )
+
+    $Detail = $InputObject | Format-List * -Force | Out-String
+
+    # NOTE: ErrorViewRecurse is normally false, and only set temporarily by Format-Error -Recurse
+    if ($ErrorViewRecurse) {
+        $Count = 1
+        $Exception = $InputObject.Exception
+        while ($Exception = $Exception.InnerException) {
+            $Detail += "`nINNER EXCEPTION $($Count): $($Exception.GetType().FullName)`n`n"
+            $Detail += $Exception | Format-List * -Force | Out-String
+            $Count++
+        }
+    }
+    $Detail
+}

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Joel Bennett
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

ReadMe.md

@@ -7,7 +7,60 @@ This is a _very_ simple module. It exports one important command: `Format-Error`
 * `ConvertTo-CategoryErrorView`
 * `ConvertTo-NormalErrorView`
 * `ConvertTo-SimpleErrorView`
+* `ConvertTo-FullErrorView`
 
-But more importantly, _when it's imported_, it allows you to override PowerShell's error formatting by setting the global `$ErrorView` variable to something like "SingleLine" and writing a function `ConvertTo-SingleLineErrorView` (i.e. `ConvertTo-<name>ErrorView`), and of course, it provides a "Simple" error view on top of PowerShell's existing "Normal" and "Category" views.
+### Install it from PSGallery
 
-![Some Examples of Formatted Errors](Resources/screenshot.png "Make sure you try Format-Error!")
+```powershell
+Install-Module ErrorView
+```
+
+_When it's imported_, it sets PowerShell's global `$ErrorView` variable to "Simple" and provides an implementation as `ConvertTo-SimpleErrorView`.  **More importantly**, it allows you to write your own ErrorView! For example you could write a function or script `ConvertTo-SingleLineErrorView` and then set the preference variable `$ErrorView = "SingleLine"`, or even set it as you import the ErrorView module:
+
+```powershell
+Import-Module ErrorView -Args SingleLine
+```
+
+NOTE: by default, there is no "SingleLine" view in the ErrorView module. The default after importing the module is the "Simple" error view, which is currently a 2-line view.
+
+![Some Examples of Formatted Errors](Resources/screenshot.png "Make sure you try Format-Error!")
+
+### Format-Error
+
+The `Format-Error` command lets you change the view temporarily to look at more details of errors, and even has a -Recurse switch to let error views show details of inner exceptions. If you have set your view to Simple (which is the default after importing the module), you can see the Normal view for the previous error by just running `Format-Error`. To see more than one error, you can look at the previous 5 errors like: `$error[0..4] | Format-Error`
+
+### Custom Error Views
+
+As stated above, the ErrorView module allows you to write your own formats. Here's an example, and a few pointers:
+
+```powershell
+function ConvertTo-SingleLineErrorView {
+    param( [System.Management.Automation.ErrorRecord]$InputObject )
+    -join @(
+        $originInfo = &{ Set-StrictMode -Version 1; $InputObject.OriginInfo }
+        if (($null -ne $originInfo) -and ($null -ne $originInfo.PSComputerName)) {
+            "[" + $originInfo.PSComputerName + "]: "
+        }
+
+        $errorDetails = &{ Set-StrictMode -Version 1; $InputObject.ErrorDetails }
+        if (($null -ne $errorDetails) -and ($null -ne $errorDetails.Message) -and ($InputObject.FullyQualifiedErrorId -ne "NativeCommandErrorMessage")) {
+            $errorDetails.Message
+        } else {
+            $InputObject.Exception.Message
+        }
+
+        if ($ErrorViewRecurse) {
+            $Prefix = "`n         Exception: "
+            $Exception = &{ Set-StrictMode -Version 1; $InputObject.Exception }
+            do {
+                $Prefix + $Exception.GetType().FullName
+                $Prefix = "`n    InnerException: "
+            } while ($Exception = $Exception.InnerException)
+        }
+    )
+}
+```
+
+1. The function **must** use the `ConvertTo` verb and "ErrorView" noun, with _your view name as the prefix_.
+2. The function **must** have an `InputObject` parameter of type `System.Management.Automation.ErrorRecord`
+3. There is a new global variable: `$ErrorViewRecurse` which is set by `Format-Error -Recurse`