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

dep: replace colors with chalk #10612

Merged
merged 1 commit into from
Jan 13, 2022
Merged

dep: replace colors with chalk #10612

merged 1 commit into from
Jan 13, 2022

Conversation

vince-fugnitto
Copy link
Member

What it does

The pull-request updates the problematic colors.js dependency with chalk. In addition, the migration guide was also updated to include a note about the possibility of using resolutions in order not to pull the problematic dependency version (which may be pulled transitively through electron-rebuild for example).

How to test

  1. confirm that the build is successful
  2. confirm that starting the example applications is successful
  3. confirm that the downloading plugins script works, and that output is correctly colored (success, skip, errors)

Review checklist

Reminder for reviewers

Signed-off-by: vince-fugnitto [email protected]

@vince-fugnitto vince-fugnitto added quality issues related to code and application quality dependencies pull requests that update a dependency file labels Jan 10, 2022
Copy link
Member

@msujew msujew left a comment

Choose a reason for hiding this comment

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

I can confirm that the application starts correctly and that the download:plugins command works as expected (with colors and everything).

With the changes in place, no direct references to the colors package exist anymore in the repo 👍

doc/Migration.md Outdated

```json
"resolutions": {
"**/colors": "1.4.0"
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can be more generic and not assume the version needed, so long as it's not the newest one? e.g.:
"**/colors": "<=1.4.0"

Copy link
Member Author

Choose a reason for hiding this comment

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

I confirmed that <=1.4.0 works correctly when building a downstream application, and adjusted the migration documentation.

The commit replaces the `colors.js` dependency with `chalk` due to a
recent deliberate breakage by the author. The `chalk` dependency is a
well maintained alternative by the open-source community.

The change also includes a migration guide update so that downstream
applications can include a resolution in their products if necessary.

Signed-off-by: vince-fugnitto <[email protected]>
Copy link
Contributor

@marcdumais-work marcdumais-work left a comment

Choose a reason for hiding this comment

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

LGTM, thanks Vince!

@vince-fugnitto vince-fugnitto merged commit 911474d into master Jan 13, 2022
@vince-fugnitto vince-fugnitto deleted the vf/chalk branch January 13, 2022 20:33
@github-actions github-actions bot added this to the 1.22.0 milestone Jan 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies pull requests that update a dependency file quality issues related to code and application quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants