Skip to content

Fix the word wrapping in formatting to handle escape sequences properly#17316

Merged
daxian-dbw merged 7 commits into
PowerShell:masterfrom
daxian-dbw:word
May 16, 2022
Merged

Fix the word wrapping in formatting to handle escape sequences properly#17316
daxian-dbw merged 7 commits into
PowerShell:masterfrom
daxian-dbw:word

Conversation

@daxian-dbw
Copy link
Copy Markdown
Member

@daxian-dbw daxian-dbw commented May 11, 2022

PR Summary

Fix #17261
Fix the word wrapping in formatting to handle escape sequences properly.
The changes are mainly in 3 utility methods to take into account possible escape sequences when manipulate strings:

  • SplitLines: split a multi-line string. Make sure the escape sequences are kept for all lines after the splitting.
  • GetWords: split a single-line string into words. Make sure all escape sequences are kept for each word, so the decoration to the individual words is the same as they are in the string.
  • GenerateLinesWithWordWrap. When splitting a word across multiple lines, make sure all escape sequences are kept in the same order for all individual sub-strings, so the decoration to the sub-strings is the same as they are in the original string.

Here are some examples to demonstrate the fix:

Multi-line string in list view

$m = [pscustomobject] @{ b = "`e[33mPowerShell is a task automation and configuration management program from Microsoft.`nIt consists of a command-line shell and the associated scripting language" }
$m | Format-List

image

Multi-line string in list view with word wrapping

$PSStyle.OutputRendering = 'Ansi'
$m = [pscustomobject] @{ b = "`e[33mPowerShell is a task `e[31mautomation and configuration`e[33m management program from Microsoft.`nIt consists of a command-line shell and the associated scripting language" }
$m | Format-List | Out-String -Width 45

image

Long word across multiple lines

$PSStyle.OutputRendering = 'Ansi'
$m = [pscustomobject] @{ b = "`e[33mC:\repos\PowerShell\src\`e[31mpowershell-win-core`e[33m\bin\Debug\net7.0\win7-x64\publish\pwsh.exe"; vv = "Hello world" }
$m | Format-List | Out-String -Width 40

image

PR Checklist

@ghost ghost assigned anmenaga May 11, 2022
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned anmenaga May 11, 2022
@daxian-dbw daxian-dbw marked this pull request as draft May 11, 2022 20:00
@daxian-dbw daxian-dbw added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label May 11, 2022
@daxian-dbw daxian-dbw marked this pull request as ready for review May 11, 2022 22:07
iSazonov
iSazonov reviewed May 12, 2022
View reviewed changes
Comment thread src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs
Comment thread src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs Outdated
Comment thread src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs
Comment thread src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs
Comment thread src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs
Comment thread src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

pull-request-quantifier-deprecated Bot commented May 12, 2022

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

Quantification details 

Label      : Large
Size       : +165 -73
Percentile : 63.8%

Total files changed: 8

Change summary by file extension:
.StyleCop : +1 -0
.cs : +134 -72
.json : +1 -1
.ps1 : +29 -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 detetcted.
  • 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.

iSazonov
iSazonov reviewed May 13, 2022
View reviewed changes
Comment thread src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs
SeeminglyScience
SeeminglyScience approved these changes May 16, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@SeeminglyScience SeeminglyScience left a comment

Choose a reason for hiding this comment

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

LGTM! Very well done ♥

@daxian-dbw daxian-dbw merged commit c40066d into PowerShell:master May 16, 2022
@daxian-dbw daxian-dbw deleted the word branch May 16, 2022 23:10
@ghost
Copy link
Copy Markdown

ghost commented May 23, 2022

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

Handy links:

@ghost ghost mentioned this pull request May 23, 2022
Closed
5 tasks
@daxian-dbw daxian-dbw mentioned this pull request Mar 22, 2024
Closed
5 tasks
@daxian-dbw daxian-dbw mentioned this pull request Nov 11, 2025
Merged
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov left review comments

@SeeminglyScience SeeminglyScience SeeminglyScience approved these changes

@PaulHigin PaulHigin Awaiting requested review from PaulHigin

Assignees

@daxian-dbw daxian-dbw

Labels

CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Large

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Word wrapping code in formatting doesn't take into account escape sequences in strings

4 participants

@daxian-dbw @iSazonov @SeeminglyScience @anmenaga