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

fix(cli): Remove boxen from default error output #9568

Merged
merged 1 commit into from
Nov 21, 2023

Conversation

Josh-Walker-GM
Copy link
Collaborator

Problem
There are too many cases where using boxen for the default error output causes readability issues.

Change

  1. Remove boxen and simply draw a few straight lines coloured with chalk. This should avoid the readability issues.

Example
image

Context
The reason this exists in the first place was to try and centralise the error output. There were so many places in the CLI code where errors are output in various different styles which is not necessarily the best experience.

@Josh-Walker-GM Josh-Walker-GM added the release:fix This PR is a fix label Nov 21, 2023
@Josh-Walker-GM Josh-Walker-GM added this to the next-release-patch milestone Nov 21, 2023
@Josh-Walker-GM Josh-Walker-GM self-assigned this Nov 21, 2023
@Tobbe
Copy link
Member

Tobbe commented Nov 21, 2023

Much more forgiving for resizing the terminal! 👍

Initial:
image

Wider:
image

More narrow:
image

@Josh-Walker-GM Josh-Walker-GM merged commit a426e32 into main Nov 21, 2023
33 of 37 checks passed
@Josh-Walker-GM Josh-Walker-GM deleted the jgmw-cli/remove-error-boxen branch November 21, 2023 16:33
jtoar pushed a commit that referenced this pull request Nov 29, 2023
**Problem**
There are too many cases where using boxen for the default error output
causes readability issues.

**Change**
1. Remove boxen and simply draw a few straight lines coloured with
chalk. This should avoid the readability issues.

**Example**
<img width="1155" alt="image"
src="https://github.com/redwoodjs/redwood/assets/56300765/db01fdad-76e2-4a1a-a23e-da83d032e36e">

**Context**
The reason this exists in the first place was to try and centralise the
error output. There were so many places in the CLI code where errors are
output in various different styles which is not necessarily the best
experience.
@jtoar jtoar modified the milestones: next-release-patch, v6.4.1 Nov 29, 2023
jtoar pushed a commit that referenced this pull request Nov 29, 2023
**Problem**
There are too many cases where using boxen for the default error output
causes readability issues.

**Change**
1. Remove boxen and simply draw a few straight lines coloured with
chalk. This should avoid the readability issues.

**Example**
<img width="1155" alt="image"
src="https://github.com/redwoodjs/redwood/assets/56300765/db01fdad-76e2-4a1a-a23e-da83d032e36e">

**Context**
The reason this exists in the first place was to try and centralise the
error output. There were so many places in the CLI code where errors are
output in various different styles which is not necessarily the best
experience.
@jtoar jtoar modified the milestones: v6.4.1, next-release-patch Nov 29, 2023
jtoar pushed a commit that referenced this pull request Nov 29, 2023
**Problem**
There are too many cases where using boxen for the default error output
causes readability issues.

**Change**
1. Remove boxen and simply draw a few straight lines coloured with
chalk. This should avoid the readability issues.

**Example**
<img width="1155" alt="image"
src="https://github.com/redwoodjs/redwood/assets/56300765/db01fdad-76e2-4a1a-a23e-da83d032e36e">

**Context**
The reason this exists in the first place was to try and centralise the
error output. There were so many places in the CLI code where errors are
output in various different styles which is not necessarily the best
experience.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:fix This PR is a fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants