Export styles from `ansi-styles` by LitoMore · Pull Request #567 · chalk/chalk

LitoMore · 2022-10-05T15:49:45Z

ansi-styles adds some extra keys to styles:

chalk/source/vendor/ansi-styles/index.js

Lines 98 to 103 in 92c55db

    
           styles.color.ansi = wrapAnsi16(); 
        
           styles.color.ansi256 = wrapAnsi256(); 
        
           styles.color.ansi16m = wrapAnsi16m(); 
        
           styles.bgColor.ansi = wrapAnsi16(ANSI_BACKGROUND_OFFSET); 
        
           styles.bgColor.ansi256 = wrapAnsi256(ANSI_BACKGROUND_OFFSET); 
        
           styles.bgColor.ansi16m = wrapAnsi16m(ANSI_BACKGROUND_OFFSET);

We should filter them out.

Or we could process those style names in ansi-sytle, see chalk/ansi-styles#82. I marked that PR as a draft to discuss how we can improve on this.

My thoughts are:

~~Option 1:~~
~~Filter style names in Chalk~~

Option 2:
Apply chalk/ansi-styles#82, then export style names from ansi-styles in Chalk

~~Option 3:~~
~~Apply chalk/ansi-styles#82 change but in favor of modify the vendor/ansi-styles directly, then export styles names~~

What do you think?

For the exposed style names, we'd better add some tests to ensure its outputs are correct.

sindresorhus · 2022-10-09T15:59:12Z

I would go with option 2.

Option 3 is not entirely clear to me.

LitoMore · 2022-10-09T16:03:50Z

Option 3 is not entirely clear to me.

I mean change the code directly in https://github.com/chalk/chalk/blob/main/source/vendor/ansi-styles/index.js. But I don't think it's a good solution.

sindresorhus · 2022-10-09T16:18:40Z

I mean change the code directly in https://github.com/chalk/chalk/blob/main/source/vendor/ansi-styles/index.js. But I don't think it's a good solution.

No, we shouldn't do that. The vendor stuff is meant to be kept in sync with the source.

LitoMore · 2022-10-09T16:27:53Z

Of course. I marked the chalk/ansi-styles#82 as ready, please review.

I will sync those changes to this project.

codecov · 2022-10-09T16:39:11Z

Codecov Report

Merging #567 (5a3245c) into main (92c55db) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #567   +/-   ##
=======================================
  Coverage   99.60%   99.61%           
=======================================
  Files           8        8           
  Lines         509      517    +8     
=======================================
+ Hits          507      515    +8     
  Misses          2        2

Impacted Files	Coverage Δ
source/index.js	`99.11% <100.00%> (+0.03%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

sindresorhus · 2022-10-11T08:55:08Z

Can you change the exports to use the Name suffix like ansi-styles? We already shipped the current names, so we need to preserve those using an alias with a @deprecated doc comment.

LitoMore · 2022-10-11T14:50:43Z

@sindresorhus Done. This failing CI doesn't seem to be related to the code.

Qix- · 2022-10-11T15:41:06Z

https://github.com/chalk/chalk/blob/main/.github/workflows/main.yml#L25

Not sure the goal here with this check but seems like codecov is completely broken regardless of version, it's just that it's only enabled on 16.

LitoMore · 2022-10-11T15:49:58Z

Passing now.

Qix- · 2022-10-11T15:57:40Z

Curious, what was the issue? The error message led me to believe it was a transient issue...

LitoMore · 2022-10-11T16:01:15Z

No idea. I just git commit --amend my commit. I believe it's a Codecov-related issue. Maybe they fixed the problem in a short time.

source/index.d.ts

source/index.js

source/index.d.ts

LitoMore mentioned this pull request Oct 5, 2022

Expose style names chalk/ansi-styles#82

Merged

Bump dependencies

629d4e4

LitoMore force-pushed the remove-non-styles-from-exposed-style-names branch from bc60dcf to 629d4e4 Compare October 9, 2022 16:34

Apply XO fixes

ef53fde

LitoMore changed the title ~~Drop non-styles from exposed style names~~ Export styles from ansi-styles Oct 9, 2022

LitoMore added 2 commits October 10, 2022 14:41

Sync code

79e9185

Sync

553c468

Deprecated current style names in favor of using Name suffix

8011f5f

LitoMore force-pushed the remove-non-styles-from-exposed-style-names branch from 202e797 to 8011f5f Compare October 11, 2022 15:48

sindresorhus reviewed Oct 12, 2022

View reviewed changes

source/index.d.ts Outdated Show resolved Hide resolved

sindresorhus reviewed Oct 12, 2022

View reviewed changes

source/index.js Show resolved Hide resolved

sindresorhus reviewed Oct 12, 2022

View reviewed changes

source/index.d.ts Show resolved Hide resolved

LitoMore added 2 commits October 12, 2022 11:49

Tweaks

2b668aa

Add TODO note

5a3245c

LitoMore requested a review from sindresorhus October 12, 2022 03:54

sindresorhus approved these changes Oct 12, 2022

View reviewed changes

sindresorhus requested a review from Qix- October 12, 2022 05:47

Qix- approved these changes Oct 12, 2022

View reviewed changes

sindresorhus merged commit 6e0df05 into chalk:main Oct 12, 2022

LitoMore deleted the remove-non-styles-from-exposed-style-names branch October 12, 2022 11:27

cezaraugusto mentioned this pull request May 24, 2024

[Snyk] Upgrade chalk from 5.0.0 to 5.3.0 cezaraugusto/log-md#4

Open

brittag mentioned this pull request Jun 14, 2024

[Snyk] Upgrade chalk from 2.4.2 to 5.3.0 Enterprise-CMCS/cmcs-eregulations#1342

Closed

victorperin mentioned this pull request Jun 15, 2024

[Snyk] Upgrade chalk from 4.1.2 to 5.3.0 victorperin/qr-scanner-cli#228

Open

YoutacRandS-VA mentioned this pull request Jun 19, 2024

[Snyk] Upgrade chalk from 2.4.2 to 5.3.0 YoutacRandS-VA/build#4

Open

This was referenced Jul 5, 2024

[Snyk] Upgrade chalk from 3.0.0 to 5.3.0 Morin3/platform-samples#5

Open

[Snyk] Upgrade chalk from 3.0.0 to 5.3.0 Morin3/Hcc12#11

Open

mhill-os mentioned this pull request Jul 25, 2024

[Snyk] Upgrade chalk from 4.1.2 to 5.3.0 OrdnanceSurvey/AddressBase#9

Open

Stanislav1975 mentioned this pull request Aug 9, 2024

[Snyk] Upgrade chalk from 4.1.2 to 5.3.0 Stanislav1975/eslint#7

Open

snyk-io bot mentioned this pull request Aug 12, 2024

[Snyk] Upgrade chalk from 4.1.2 to 5.3.0 Playgirlkaybraz11/eslint#3

Open

This was referenced Aug 19, 2024

[Snyk] Upgrade chalk from 2.4.2 to 5.3.0 PavinStrickland/babel#1

Open

[Snyk] Upgrade chalk from 1.1.3 to 5.3.0 PavinStrickland/compat-table#3

Open

snyk-io bot mentioned this pull request Sep 8, 2024

[Snyk] Upgrade: , chalk, mime Playgirlkaybraz11/electron-builder#7

Open

lucentlabz mentioned this pull request Sep 10, 2024

[Snyk] Upgrade: , , , chalk, command-line-args, jsonc-parser, leven, tmp lucentlabz/pyright#1

Merged

mikolajroszak mentioned this pull request Sep 10, 2024

[Snyk] Upgrade: , , , chalk, ora, p-map, strip-ansi mikolajroszak/mikolaj.com-snyk#311

Open

AKJUS mentioned this pull request Sep 12, 2024

[Snyk] Upgrade chalk from 5.0.1 to 5.3.0 AKJUS/rainbowkit#8

Open

mikolajroszak mentioned this pull request Sep 15, 2024

[Snyk] Upgrade: , , , chalk, ora, p-map, strip-ansi mikolajroszak/mikolaj.com-snyk#314

Open

This was referenced Sep 23, 2024

[Snyk] Upgrade chalk from 2.4.2 to 5.3.0 SherfeyInv/token-profile#5

Open

[Snyk] Upgrade chalk from 4.1.2 to 5.3.0 SherfeyInv/pyright#8

Open

nerdy-tech-com-gitub mentioned this pull request Oct 28, 2024

[Snyk] Upgrade chalk from 4.1.2 to 5.3.0 nerdy-tech-com-gitub/ant-design#3

Open

	styles.color.ansi = wrapAnsi16();
	styles.color.ansi256 = wrapAnsi256();
	styles.color.ansi16m = wrapAnsi16m();
	styles.bgColor.ansi = wrapAnsi16(ANSI_BACKGROUND_OFFSET);
	styles.bgColor.ansi256 = wrapAnsi256(ANSI_BACKGROUND_OFFSET);
	styles.bgColor.ansi16m = wrapAnsi16m(ANSI_BACKGROUND_OFFSET);

Uh oh!

Conversation

LitoMore commented Oct 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sindresorhus commented Oct 9, 2022

Uh oh!

LitoMore commented Oct 9, 2022

Uh oh!

sindresorhus commented Oct 9, 2022

Uh oh!

LitoMore commented Oct 9, 2022

Uh oh!

codecov bot commented Oct 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sindresorhus commented Oct 11, 2022

Uh oh!

LitoMore commented Oct 11, 2022

Uh oh!

Qix- commented Oct 11, 2022

Uh oh!

LitoMore commented Oct 11, 2022

Uh oh!

Qix- commented Oct 11, 2022

Uh oh!

LitoMore commented Oct 11, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

LitoMore commented Oct 5, 2022 •

edited

Loading

codecov bot commented Oct 9, 2022 •

edited

Loading