refactor(tools): replace @colors/colors with smaller and faster ansis #4195
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- replace @colors/colors with ansis - add color preview for selectors used in CSS - fix ESLint errors in tools code
webdiscus
commented
Jan 1, 2025
| @@ -5,7 +5,7 @@ const css = require("css"); | |||
| const wcagContrast = require("wcag-contrast"); | |||
| const Table = require('cli-table'); | |||
| const csscolors = require('css-color-names'); | |||
| require("@colors/colors"); | |||
There was a problem hiding this comment.
require("@colors/colors") <= extends the String.prototype, that is the bad practice.
webdiscus
commented
Jan 1, 2025
| @@ -5,7 +5,7 @@ const css = require("css"); | |||
| const wcagContrast = require("wcag-contrast"); | |||
| const Table = require('cli-table'); | |||
| const csscolors = require('css-color-names'); | |||
| require("@colors/colors"); | |||
| const { cyan, green, yellow, magentaBright, hex } = require('ansis'); | |||
There was a problem hiding this comment.
ansis supports the named import that allow to write shorter and cleaner code
webdiscus
commented
Jan 1, 2025
| const doesNotSupport = has_rules.map(x => x[1]).includes(false); | ||
| const skipped = has_rules.find(x => x[2]); | ||
| if (doesNotSupport || skipped) { | ||
| console.log(group.name.yellow); |
There was a problem hiding this comment.
group.name is the string that prototype was extended with the yellow function.
This is unreadable and is very bad practice.
webdiscus
commented
Jan 1, 2025
| if (doesNotSupport) { | ||
| console.log(`- Theme does not fully support.`.brightMagenta); | ||
| console.log(magentaBright`- Theme does not fully support.`); |
There was a problem hiding this comment.
with ansis you can use the template string syntax very well,
this is clear and readable code unlike using extended String.prototype by @colors/colors
webdiscus
commented
Jan 1, 2025
| }); | ||
| console.log(); | ||
| } | ||
| } | ||
|
|
||
| const round2 = (x) => Math.round(x*100)/100; | ||
| const round2 = (x) => Math.round(x * 100) / 100; |
webdiscus
commented
Jan 1, 2025
|
|
||
| class CSSRule { | ||
| constructor(rule, body) { | ||
| this.rule = rule; | ||
| if (rule.declarations) { | ||
| this.bg = rule.declarations.find(x => x.property == "background-color")?.value; | ||
| this.bg = rule.declarations.find(x => x.property === "background-color")?.value; |
webdiscus
commented
Jan 1, 2025
| get background() { | ||
| return this.bg | ||
| return this.bg; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR replaces @colors/colors used in CLI tools with smaller and faster ansis.
Benefits of
ansis@colors/colors- 41.5 kB,ansis- 7 kB, see Compare the size of packages@colors/colors, see BenchmarksString.prototypePackages that already use
ansisfacebook/stylex, nestjs/nest, sequelize/core, oclif/core, salesforcecli/cli and thousands others
Changes
The changes in CLI tools:
@colors/colorswithansisChecklist
CHANGES.mdTest
This PR does not require unit/integration tests, but you can do the
manual test.Clone and install the forked repository:
1) Run CheckTheme tools in CLI
For example, we want to check the
vs2015style:In console output will be displayed color text and NEW added preview of colors used in CSS selectors:
2) Run CheckAutoDetect tools in CLI
In console output will be displayed color text: