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

Add CustomTableHeaderLabel formatting to differentiate table header labels that are not property names #17346

Merged
merged 16 commits into from Oct 3, 2022

Conversation

SteveL-MSFT
Copy link
Member

@SteveL-MSFT SteveL-MSFT commented May 14, 2022

PR Summary

Add $PSStyle.Formatting.CustomTableHeaderLabel to enable differentiation in Format-Table output where a table header label isn't an actual property name. Usually these are either abbreviated, calculated, or has units added. Users can get confused because they expect it to be a property name and can't use dot-notation to access it. The default format is the same color as the table header but use italics.

Since decoration is absolute and not relative (additive), to make this work correctly for each table header which IS a property member we need to wrap it with the normal decoration. This results in extra characters being emitted.

PR Context

Brought up in https://twitter.com/JustinWGrote/status/1524882725781377024

PR Checklist

ghost
ghost approved these changes May 15, 2022
@SteveL-MSFT

This comment was marked as outdated.

@SteveL-MSFT SteveL-MSFT changed the title Add CustomTableHeader formatting to differentiate table header labels that are not property names Add CustomTableHeaderLabel formatting to differentiate table header labels that are not property names May 15, 2022
@SteveL-MSFT SteveL-MSFT changed the title Add CustomTableHeaderLabel formatting to differentiate table header labels that are not property names Add CustomTableHeaderLabel formatting to differentiate table header labels that are not property names May 16, 2022
@msftbot msftbot bot added the Review - Needed The PR is being reviewed label May 25, 2022
@msftbot
Copy link

msftbot bot commented May 25, 2022

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@SteveL-MSFT
Copy link
Member Author

SteveL-MSFT commented Sep 19, 2022

Made a change based on @JamesWTruher feedback where the style includes a background color. So the change keeps the whitespace separation between columns.

image

I would not expect most users to set a background color or use inverse, but it keeps the column separation now.

@msftbot msftbot bot removed the Review - Needed The PR is being reviewed label Sep 19, 2022
Copy link
Member

@JamesWTruher JamesWTruher left a comment

Choose a reason for hiding this comment

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

i think this is fine

Copy link
Contributor

@dkaszews dkaszews left a comment

Choose a reason for hiding this comment

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

Please provide example screenshots before and after change

@msftbot msftbot bot added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Sep 20, 2022
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Sep 21, 2022
Copy link
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.

Left a comment to block merging the PR for now.
Will update once finish reviewing the rest. [Update] No more comments.

@pull-request-quantifier
Copy link

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


Quantification details

Label      : Small
Size       : +67 -32
Percentile : 39.6%

Total files changed: 10

Change summary by file extension:
.json : +2 -0
.cs : +39 -22
.ps1 : +26 -10

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.

Copy link
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 merged commit d5ed53e into PowerShell:master Oct 3, 2022
39 checks passed
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned TravisEz13 Oct 3, 2022
@SteveL-MSFT SteveL-MSFT deleted the table-header branch October 4, 2022 02:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants