Expose style names (#566)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
chalk · Oct 5, 2022 · d7d7571 · d7d7571
1 parent 96f44c9
commit d7d7571
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -210,6 +210,22 @@ Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=
 
 `chalkStderr` contains a separate instance configured with color support detected for `stderr` stream instead of `stdout`. Override rules from `supportsColor` apply to this too. `supportsColorStderr` is exposed for convenience.
 
+### modifiers, foregroundColors, backgroundColors, and colors
+
+All supported style strings are exposed as an array of strings for convenience. `colors` is the combination of `foregroundColors` and `backgroundColors`.
+
+This can be useful if you wrap Chalk and need to validate input:
+
+```js
+import {modifiers, foregroundColors} from 'chalk';
+
+console.log(modifiers.includes('bold'));
+//=> true
+
+console.log(foregroundColors.includes('pink'));
+//=> false
+```
+
 ## Styles
 
 ### Modifiers

diff --git a/source/index.d.ts b/source/index.d.ts
@@ -284,4 +284,9 @@ export {
 // } from '#supports-color';
 } from './vendor/supports-color/index.js';
 
+export const modifiers: readonly Modifiers[];
+export const foregroundColors: readonly ForegroundColor[];
+export const backgroundColors: readonly BackgroundColor[];
+export const colors: readonly Color[];
+
 export default chalk;
diff --git a/source/index.js b/source/index.js
@@ -209,4 +209,9 @@ export {
 	stderrColor as supportsColorStderr,
 };
 
+export const modifiers = Object.keys(ansiStyles.modifier);
+export const foregroundColors = Object.keys(ansiStyles.color);
+export const backgroundColors = Object.keys(ansiStyles.bgColor);
+export const colors = [...foregroundColors, ...backgroundColors];
+
 export default chalk;