Skip to content

Fix legacy $ErrorView types to use $host.PrivateData colors#17705

Merged
daxian-dbw merged 1 commit intoPowerShell:masterfrom
SteveL-MSFT:error-normalview
Jul 19, 2022
Merged

Fix legacy $ErrorView types to use $host.PrivateData colors#17705
daxian-dbw merged 1 commit intoPowerShell:masterfrom
SteveL-MSFT:error-normalview

Conversation

@SteveL-MSFT
Copy link
Copy Markdown
Member

@SteveL-MSFT SteveL-MSFT commented Jul 18, 2022

PR Summary

The change to add ConciseView for $ErrorView inadvertently removed the coloring for legacy views. The fix is when ConciseView isn't used, then get the foreground and background colors from the legacy location and set it before outputting the error.

PR Context

Fix #16665

PR Checklist

@pull-request-quantifier-deprecated
Copy link
Copy Markdown

This PR has 5 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +5 -0
Percentile : 2%

Total files changed: 1

Change summary by file extension:
.cs : +5 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@ghost ghost assigned TravisEz13 Jul 18, 2022
Copy link
Copy Markdown
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@daxian-dbw daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 19, 2022
@daxian-dbw daxian-dbw merged commit 1437d85 into PowerShell:master Jul 19, 2022
@SteveL-MSFT SteveL-MSFT deleted the error-normalview branch July 21, 2022 17:11
@adityapatwardhan
Copy link
Copy Markdown
Member

/backport to release/v7.2.6

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 2, 2022

Started backporting to release/v7.2.6: https://github.com/PowerShell/PowerShell/actions/runs/2784906265

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@ghost
Copy link
Copy Markdown

ghost commented Aug 11, 2022

🎉v7.2.6 has been released which incorporates this pull request.:tada:

Handy links:

@ghost
Copy link
Copy Markdown

ghost commented Aug 11, 2022

🎉v7.3.0-preview.7 has been released which incorporates this pull request.:tada:

Handy links:

@loxia01
Copy link
Copy Markdown

loxia01 commented Aug 12, 2022

Tested this fix in v7.2.6 today for $ErrorView = 'NormalView', and while it is working another small bug seems to have been introduced. When an error occurs, not only the error message takes the red color, but also the prompt path text (see screenshot).

capture

@iSazonov
Copy link
Copy Markdown
Collaborator

@loxia01 Please open new issue.

@daxian-dbw
Copy link
Copy Markdown
Member

@loxia01 Thanks for the report. I have opened the issue #17885

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Backport-7.2.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

$ErrorView = 'NormalView' is not colorizing errors

6 participants