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

Deprecation/Migration messaging #681

Closed
JacobMGEvans opened this issue Mar 23, 2022 · 2 comments
Closed

Deprecation/Migration messaging #681

JacobMGEvans opened this issue Mar 23, 2022 · 2 comments
Assignees
Labels
discussion This issue is being used to discuss a topic rather than track a feature or bug. polish Small improvements to the experience

Comments

@JacobMGEvans
Copy link
Contributor

During a migration of a fairly complex project there was a large amount of messaging to read through that was all the same color with no distinction of importance or priority.

This can provide priority implications, colorizing or emoji:

  1. High/Breaking (🚨, 🚫, 🔴 , or red text would indicate high priority).
  2. Deprecation/non-blocking should fix (📜, 🧹 , ⚒️ , 🛠️, 🟠 or orange/burnt orange text)
  3. Warning/behavior may be needed for old projects, but not Wrangler2 convention/best practice (⚠️, 🟡, 🦺 or dark/mild yellow text)
@JacobMGEvans JacobMGEvans added discussion This issue is being used to discuss a topic rather than track a feature or bug. polish Small improvements to the experience labels Mar 23, 2022
@JacobMGEvans JacobMGEvans self-assigned this Mar 23, 2022
@lauragift21
Copy link
Contributor

lauragift21 commented Mar 25, 2022

I like the idea of showing emojis or highlighting important information with colors. There's been an instance where it took a few looking over the output to understand what it is.

An example from a recent migration:

 ⛅️ wrangler 0.0.23
--------------------
Processing wrangler.toml configuration:
  - DEPRECATION: "type":
    DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.
  - DEPRECATION: "zone_id":
    This is unnecessary since we can deduce this from routes directly.
  - Unexpected fields found in site field: "entry-point"
Processing wrangler.toml configuration:
  - DEPRECATION: "site.entry-point":
    The `site.entry-point` config field is no longer used.
    The entry-point should be specified via the command line or the `main` config field.

In order to improve the DX going through these messages I think we can highly benefit from making it clear and intuitive with emojis, colors or text highlighting.

@JacobMGEvans
Copy link
Contributor Author

@petebacondarwin made a huge leap in message layout, formatting and communication with #848

Closing this issue, if future improvements are to be made a new issue can be made.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion This issue is being used to discuss a topic rather than track a feature or bug. polish Small improvements to the experience
Projects
None yet
Development

No branches or pull requests

2 participants