feat: add migration guide for chalk to util styletext codemod #8430
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
👋 Codeowner Review RequestThe following codeowners have been identified for the changed files: Team reviewers: @nodejs/nodejs-website Please review the changes when you have a chance. Thank you! 🙏 |
There was a problem hiding this comment.
Pull request overview
This PR adds a migration guide for developers transitioning from the Chalk library to Node.js's native util.styleText functionality. The guide documents a new codemod that automates this migration process.
- Introduces comprehensive documentation for the
chalk-to-util-styletextcodemod - Documents compatible and non-compatible features between Chalk and Node.js util.styleText
- Provides practical before/after code examples demonstrating the migration
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8430 +/- ##
==========================================
+ Coverage 74.70% 75.02% +0.31%
==========================================
Files 102 103 +1
Lines 8956 9041 +85
Branches 305 311 +6
==========================================
+ Hits 6691 6783 +92
+ Misses 2263 2256 -7
Partials 2 2 ☔ View full report in Codecov by Sentry. |
AugustinMauroy
left a comment
AugustinMauroy
left a comment
There was a problem hiding this comment.
Okay nice ! but few things:
- you have to add you as authors on blog https://github.com/nodejs/nodejs.org/blob/main/apps/site/authors.json
- a mention of when styleText became stable and if you are on app verify that you are on the right version (on prod). And if you are using it on package the user have to check their nodejs version support and reming them that changing node.js version support is a major bump on their package
- last but no least a paragraph to thanks the maintainer. because without npm ecosystem node can't exist.
bmuenzenmeyer
left a comment
bmuenzenmeyer
left a comment
There was a problem hiding this comment.
Love to see this! nice work!
richiemccoll
force-pushed
the
feat/chalk-styletext-blog
branch
from
3bff17e to
e5c3580
Compare
|
|
||
| ## `chalk-to-util-styletext` | ||
|
|
||
| This codemod aims to help you reduce external dependencies by transforming chalk method calls to use the native Node.js styling functionality. It will also handle automatic removal of the `chalk` package from the package.json. |
There was a problem hiding this comment.
| This codemod aims to help you reduce external dependencies by transforming chalk method calls to use the native Node.js styling functionality. It will also handle automatic removal of the `chalk` package from the package.json. | |
| This codemod aims to help you reduce external dependencies by transforming chalk method calls to use the native Node.js styling functionality. It will also handle automatic removal of the [`chalk`](https://github.com/chalk/chalk) package from the package.json. |
|
|
||
| - Node.js v20.12.0 or later (for util.styleText) | ||
| - `util.styleText` became stable in Node.js v22.13.0 (and v23.5.0) | ||
|
|
There was a problem hiding this comment.
| > **Friend reminder** | |
| > If your package supports a version earlier than 22, this creates a breaking change, which means you must bump the major version of your package. | |
|
|
||
| const boldBlue = text => styleText(['blue', 'bold'], text); | ||
| console.log(boldBlue('Info')); | ||
| ``` |
There was a problem hiding this comment.
| ``` | |
| ``` | |
| ## Recognition | |
| We would like to thank the maintainers of `chalk` for their support of the package over time and for its contributions to the ecosystem. | |
| ``` |
4 participants
Description
This PR addresses the comment here by adding a new Codemod migration guide for the new recipe:
chalk-to-util-styletext.Check List
pnpm formatto ensure the code follows the style guide.pnpm testto check if all tests are passing.pnpm buildto check if the website builds without errors.