X Tutup
The Wayback Machine - https://web.archive.org/web/20221103180235/https://github.com/PowerShell/PowerShell/pull/17987
Skip to content
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

Jump to bottom

Fix error formatting to use color defined in $PSStyle.Formatting #17987

Merged
merged 3 commits into from Aug 31, 2022
Merged

Fix error formatting to use color defined in $PSStyle.Formatting #17987

merged 3 commits into from Aug 31, 2022

Conversation

daxian-dbw
Copy link
Member

@daxian-dbw daxian-dbw commented Aug 29, 2022 •
edited

PR Summary

Fix #17885, and supersede #17904
Also fix the short-term goal as described in #17886 (comment)

  1. Make error formatting use colors defined in $PSStyle.Formatting, when the host supports virtual terminal.
  2. Make $PSStyle a constant variable, so it cannot be removed.
  3. Make error views other than ConciseView to use correct color and reset the color properly when the host supports virtual terminal.

Note that, when the host doesn't support virtual terminal, the error formatting will continue to use color settings in $Host.PrivateData to keep consistent with the legacy behavior.

PR Checklist

@daxian-dbw daxian-dbw requested a review from SteveL-MSFT Aug 29, 2022
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned anmenaga Aug 29, 2022
@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 Aug 29, 2022
@daxian-dbw daxian-dbw mentioned this pull request Aug 29, 2022
Closed
22 tasks
@pull-request-quantifier
Copy link

pull-request-quantifier bot commented Aug 30, 2022

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

Quantification details 

Label      : Medium
Size       : +55 -66
Percentile : 44.2%

Total files changed: 3

Change summary by file extension:
.cs : +52 -64
.ps1 : +3 -2

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? 👍  👌  👎 (Email)
Customize PullRequestQuantifier for this repository.

@daxian-dbw daxian-dbw merged commit 647f40b into PowerShell:master Aug 31, 2022
39 checks passed
@daxian-dbw daxian-dbw deleted the error branch Aug 31, 2022
@daxian-dbw
Copy link
Member Author

daxian-dbw commented Aug 31, 2022

Mark the PR with backport-7.2-considered because #17885 is a regression to 7.2 due to the backported PR #17705

@simonsabin simonsabin mentioned this pull request Sep 12, 2022
Open
5 tasks
@adityapatwardhan
Copy link
Member

adityapatwardhan commented Sep 12, 2022

/backport to release/v7.3.0-rc.1

@github-actions
Copy link
Contributor

github-actions bot commented Sep 12, 2022

@adityapatwardhan backporting to release/v7.3.0-rc.1 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Fix error formatting to use color defined in '$PSStyle.Formatting'
Using index info to reconstruct a base tree...
M	src/System.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs
Falling back to patching base and 3-way merge...
Auto-merging src/System.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs
CONFLICT (content): Merge conflict in src/System.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Fix error formatting to use color defined in '$PSStyle.Formatting'
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

adityapatwardhan pushed a commit to adityapatwardhan/PowerShell that referenced this pull request Sep 14, 2022
@daxian-dbw @adityapatwardhan
Fix error formatting to use color defined in $PSStyle.Formatting (P…
434aafe 
…owerShell#17987)
@adityapatwardhan adityapatwardhan mentioned this pull request Sep 14, 2022
Merged
22 tasks
@msftbot
Copy link

msftbot bot commented Sep 20, 2022

🎉v7.3.0-preview.8 has been released which incorporates this pull request.🎉

Handy links:

@msftbot msftbot bot mentioned this pull request Sep 20, 2022
Closed
5 tasks
@adityapatwardhan
Copy link
Member

adityapatwardhan commented Sep 27, 2022

/backport to release/v7.2.7

@github-actions
Copy link
Contributor

github-actions bot commented Sep 27, 2022

@adityapatwardhan backporting to release/v7.2.7 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Fix error formatting to use color defined in '$PSStyle.Formatting'
Using index info to reconstruct a base tree...
M	src/System.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs
M	src/System.Management.Automation/engine/InitialSessionState.cs
Falling back to patching base and 3-way merge...
Auto-merging src/System.Management.Automation/engine/InitialSessionState.cs
CONFLICT (content): Merge conflict in src/System.Management.Automation/engine/InitialSessionState.cs
Auto-merging src/System.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs
CONFLICT (content): Merge conflict in src/System.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Fix error formatting to use color defined in '$PSStyle.Formatting'
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
TravisEz13 pushed a commit to TravisEz13/PowerShell that referenced this pull request Oct 13, 2022
@daxian-dbw @TravisEz13
Fix error formatting to use color defined in $PSStyle.Formatting (P…
0505844 
…owerShell#17987)
@TravisEz13 TravisEz13 mentioned this pull request Oct 13, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SteveL-MSFT SteveL-MSFT

Assignees

@daxian-dbw daxian-dbw

Labels
Backport-7.2.x-Done Backport-7.3.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Medium
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

$ErrorView = 'NormalView' leaves the console in Error color after rendering an ErrorRecord
5 participants
@daxian-dbw @adityapatwardhan @SteveL-MSFT @TravisEz13 @anmenaga
X Tutup