Add overline style (#67)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
chalk · Jan 22, 2021 · 80dcce2 · 80dcce2
1 parent 13605f8
commit 80dcce2
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -48,6 +48,13 @@ declare namespace ansiStyles {
 		*/
 		readonly underline: CSPair;
 
+		/**
+		Make text overline.
+
+		Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.
+		*/
+		readonly overline: CSPair;
+
 		/**
 		Inverse background and foreground colors.
 		*/

diff --git a/index.js b/index.js
@@ -16,6 +16,7 @@ function assembleStyles() {
 			dim: [2, 22],
 			italic: [3, 23],
 			underline: [4, 24],
+			overline: [53, 55],
 			inverse: [7, 27],
 			hidden: [8, 28],
 			strikethrough: [9, 29]

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -62,6 +62,7 @@ expectType<ansiStyles.CSPair>(ansiStyles.modifier.italic);
 expectType<ansiStyles.CSPair>(ansiStyles.modifier.reset);
 expectType<ansiStyles.CSPair>(ansiStyles.modifier.strikethrough);
 expectType<ansiStyles.CSPair>(ansiStyles.modifier.underline);
+expectType<ansiStyles.CSPair>(ansiStyles.modifier.overline);
 
 // -- Top level --
 // --- Foreground color ---

diff --git a/readme.md b/readme.md
@@ -42,6 +42,7 @@ Each style has an `open` and `close` property.
 - `dim`
 - `italic` *(Not widely supported)*
 - `underline`
+- `overline` *Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.*
 - `inverse`
 - `hidden`
 - `strikethrough` *(Not widely supported)*