Skip to content

Commit d945423

Browse files
committed
Add ReadMe
1 parent b9ced29 commit d945423

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

ReadMe.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# PowerShell ErrorView
2+
3+
## A module to help customize your view of Errors in PowerShell
4+
5+
This is a _very_ simple module. It exports one important command: `Format-Error` and a handful of formatting commands:
6+
7+
* `ConvertTo-CategoryErrorView`
8+
* `ConvertTo-NormalErrorView`
9+
* `ConvertTo-SimpleErrorView`
10+
11+
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.
12+
13+
![Some Examples of Formatted Errors](Resources/screenshot.png "Make sure you try Format-Error!")

Resources/screenshot.png

77.8 KB
Loading

0 commit comments

Comments
 (0)