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

cli: add a wrap function which considers colored text #3304

Merged
merged 2 commits into from
Sep 18, 2024

Conversation

renanrodrigo
Copy link
Member

@renanrodrigo renanrodrigo commented Sep 13, 2024

Why is this needed?

This PR solves all of our problems because with this we are able to wrap text even if there are color codes in it, using the full space on screen. This is mostly useful for tables/blocks.

This is based on #3294 and should land after that.

Test Steps

unit tests added for the functionality


  • (un)check this to re-run the checklist action

Copy link

github-actions bot commented Sep 13, 2024

PR Checklist

How to use this checklist

How to use this checklist

PR Author

For each section, check a box when it is true.
Uncheck a box if it becomes un-true.
Then check the box at the bottom of the PR description to re-run the action that creates this checklist.
The action that creates and updates this comment will retain your edits.
The action will fail if the checklist is not completed.

PR Reviewer

Check that the PR checklist action did not fail.
Double check that the author filled out the checklist accurately.
If you disagree with a checklist item, start a conversation.
For example, the author may say they don't think integration tests are necessary, but you may disagree.

Bug References

None.

Confirm

  • I've properly referenced all bugs that this PR fixes
How to properly reference fixed bugs
  • If this PR is related to a Jira item, include an SC-1234 reference in the PR title
  • If this PR is fixes a GitHub issue, include a Fixes: #1234 reference in the commit that fixes the issue
  • If this PR is fixes a Launchpad bug, include a LP: #12345678 reference in the commit that fixes the issue

Test Updates

Unit Tests

  • I have updated or added any unit tests accordingly
  • No unit test changes are necessary for this change

Integration Tests

  • I have updated or added any integration tests accordingly
  • No integration test changes are necessary for this change

Documentation

  • Changes here need to be documented and I have referenced the docs PR in the description
  • No documentation updates are necessary for this change

Does this PR require review from someone outside the core ubuntu-pro-client team?

  • Yes, and I have requested those reviews via GitHub
  • No

@renanrodrigo renanrodrigo force-pushed the color-wrap branch 2 times, most recently from 9a5f018 to 95390ea Compare September 15, 2024 19:11
@renanrodrigo renanrodrigo mentioned this pull request Sep 15, 2024
1 task
Copy link
Collaborator

@orndorffgrant orndorffgrant left a comment

Choose a reason for hiding this comment

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

pre-emptive approval for after cli config pr merged

Cannot rely on textwrap because of colors: the length of colored strings
will be bigger than the actual space these take on screen.
We add a function to get the length without the colors, and a wrap_text
function which relies on that.

Signed-off-by: Renan Rodrigo <[email protected]>
@renanrodrigo renanrodrigo merged commit 0d8cd5b into next-v35 Sep 18, 2024
15 checks passed
@renanrodrigo renanrodrigo deleted the color-wrap branch September 18, 2024 03:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants