Skip to content

Error view #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 22 commits into from
Closed
Changes from 2 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
5fd9c69
Added RFC Error View
theJasonHelmick Jul 31, 2019
3dd0560
update RFC error view
theJasonHelmick Jul 31, 2019
a7d6a75
Added shorter reference code
theJasonHelmick Jul 31, 2019
6faa7dc
update alternate view
theJasonHelmick Jul 31, 2019
c454366
updated comment due date on Error-View
theJasonHelmick Aug 7, 2019
fb60588
Update 1-Draft/RFC00XX-Update-Error-View.md
theJasonHelmick Aug 26, 2019
f4edfcd
review update for view name -simpleview
theJasonHelmick Aug 26, 2019
a6329e7
update to view name
theJasonHelmick Aug 26, 2019
0641bb2
fix unresolved merge conflict
theJasonHelmick Sep 3, 2019
8dabf42
Removed incorrect parameter -Oldest
theJasonHelmick Sep 3, 2019
5cf273d
Errorview update to remove unneeded parameters
theJasonHelmick Sep 23, 2019
07af6d2
Changed view name from Concise to SimpleView
theJasonHelmick Sep 24, 2019
da03165
Added WriteErrorLine clarification
theJasonHelmick Sep 24, 2019
8cdd56a
Added example showing Inner exception
theJasonHelmick Sep 24, 2019
6de0c3e
updated normal and detailed view
theJasonHelmick Sep 24, 2019
697327c
added image of new error view
theJasonHelmick Sep 25, 2019
d6f6af4
Added image of errorview and adjusted carets
theJasonHelmick Sep 25, 2019
889cad4
Spelling correction
theJasonHelmick Sep 25, 2019
9439d35
Updated graphic display of error messages
theJasonHelmick Sep 25, 2019
51ec0f2
graphic update
theJasonHelmick Sep 25, 2019
1f272cd
edits to Overview
theJasonHelmick Sep 25, 2019
a58d4e8
update $errorview to enum
theJasonHelmick Sep 26, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions 1-Draft/RFC00XX-Update-Error-View.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,13 @@ containing the error will be displayed. A cmdlet will provide the full error de
## Motivation

The on-screen experience, when receiving an error message,
<<<<<<< HEAD
is controlled through the views NormalView (the default) and CategoryView. These are user selectable though the preference variable $ErrorView.
The addition of a “SimpleView” as default that contains only specific error
=======
is controlled through the views NormalView (the default) and CategoryView. These are user selectable through the existing preference variable `$ErrorView`.
The addition of a “ConciseView” as default that contains only specific error
>>>>>>> fb60588b64b9e95e6d8adeda37150f75ef51a95a
information producing a single line on screen and in logs will improve customer success.

Comprehensive error information is available to the customer through
Expand All @@ -29,21 +34,28 @@ a cmdlet “Resolve-ErrorRecord” will simplify the process of getting detailed

## Specification

The proposal is to add a new single-line default error message view called ConciseView
The proposal is to add a new single-line default error message view called SimpleView
and add a new cmdlet (Resolve-ErrorRecord) to provide detailed error information.

__Key Design Considerations__

1. To reduce confusion and improve debugging success,
error messages by default should produce a single line of text, including the word “ERROR:” to make consistent with Verbose and Warning messages. This is added to $errorView as view named "ConciseView".
error messages, by default using WriteErrorLine, should produce a single line of text, including the word “ERROR:” to make consistent with Verbose and Warning messages. This is added to $errorView as view named "SimpleView". Conditionally, positional information will be added if from a script.

- $ErrorView should contain these views

+ NormalView
+ CategoryView
+ ConciseView
+ SimpleView

- Error Message syntax for ConciseView
- From Interactive: Error Message syntax for SimpleView

```powershell
ERROR: <Exception Message>
ERROR: Cannot find path ‘C:\blah’ because it does not exist:
```

- From Script: Error Message syntax for SimpleView

```powershell
ERROR: <Exception Message>: <Positional Info>
Expand Down