From c67cf54388f2c98bd074cde78ec4e3ffdccb529b Mon Sep 17 00:00:00 2001 From: David Ralph Date: Wed, 22 Sep 2021 14:36:10 +0100 Subject: [PATCH] Cleanup --- .gitignore | 2 +- .npmignore | 2 +- LICENSE | 2 +- README.md | 11 +- example/test.js | 2 +- index.d.ts | 252 +++++++++++++++++------------------ package.json | 64 ++++----- src/data/Colours.ts | 77 ++++++----- src/data/Keywords.ts | 303 ++++++++++++++++++++++--------------------- src/data/Styles.ts | 37 +++--- src/index.ts | 114 ++++++++-------- tsconfig.json | 20 +-- 12 files changed, 444 insertions(+), 442 deletions(-) diff --git a/.gitignore b/.gitignore index 6b02551..feef622 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,4 @@ node_modules/ # Files yarn.lock -package-lock.json \ No newline at end of file +package-lock.json diff --git a/.npmignore b/.npmignore index 58d5e8e..e3064da 100644 --- a/.npmignore +++ b/.npmignore @@ -5,4 +5,4 @@ example/ src/ # Files -tsconfig.json \ No newline at end of file +tsconfig.json diff --git a/LICENSE b/LICENSE index f93320b..eb9feba 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2019-2021 David Ralph (ohlookitsderpy) +Copyright (c) 2019-2021 David Ralph Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index c8eef17..05ecaf8 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,4 @@ Simple ANSI styling for your terminal * Set alias for colours and styles with leeks.alias() ## Usage -See the [documentation](https://docs.davidjcralph.co.uk/#/leeks) and [example](https://github.com/davidjcralph/leeks.js/blob/main/example/test.js) - -## Credits -[ansicolors](https://github.com/thlorenz/ansicolors), [ansistyles](https://github.com/thlorenz/ansistyles), [W3C](https://www.w3.org/TR/2018/REC-css-color-3-20180619/) and [Stack Overflow](https://stackoverflow.com/a/33206814) - Reference - -[colorette](https://github.com/jorgebucaran/colorette) - Colour support checking code - -[Stack Overflow](https://stackoverflow.com/questions/5623838/rgb-to-hex-and-hex-to-rgb) - Hex support - -and all the contributors! \ No newline at end of file +See the [documentation](https://docs.davidcralph.co.uk/#/leeks) and [example](example/test.js) diff --git a/example/test.js b/example/test.js index 7744877..11f94ee 100644 --- a/example/test.js +++ b/example/test.js @@ -33,4 +33,4 @@ console.log(error('test')); console.log(leeks.colours.blue`hello there`); leeks.alias('primary', 'colours', leeks.colours.green); -console.log(leeks.colours.primary('hi')); \ No newline at end of file +console.log(leeks.colours.primary('hi')); diff --git a/index.d.ts b/index.d.ts index 151d676..de8f367 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,127 +1,127 @@ declare module 'leeks.js' { - type Styles = 'reset' | 'bold' | 'dim' | 'italic' | 'underline' | 'overline' | 'blink' | 'inverse' | 'strikethrough' | 'nostrikethrough' | 'nounderline' | 'nooverline' | 'noblink' | 'noinverse'; - type Colors = 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray' | 'grey' | - 'blackBright' | 'redBright' | 'yellowBright' | 'blueBright' | 'magentaBright' | 'cyanBright' | 'whiteBright' | 'greenBright' | - 'bgBlack' | 'bgRed' | 'bgGreen' | 'bgYellow' | 'bgBlue' | 'bgMagenta' | 'bgCyan' | 'bgWhite' | - 'bgBlackBright' | 'bgRedBright' | 'bgGreenBright' | 'bgBlueBright' | 'bgMagentaBright' | 'bgCyanBright' | 'bgWhiteBright' | 'bgYellowBright' | - 'bgGray' | 'bgGrey'; - - type Keywords = 'black' | 'silver' | 'gray' | 'white' | 'maroon' | 'red' | 'purple' | 'fuchsia' | 'green' | 'lime' | 'olive' | - 'yellow' | 'navy' | 'blue' | 'teal' | 'aqua' | 'aliceblue' | 'antiquewhite' | 'aquamarine' | 'azure' | 'beige' | 'bisque' | 'blanchedalmond' | 'blueviolet' | 'brown' | 'burlywood' | 'cadetblue' | - 'chartreuse' | 'chocolate' | 'coral' | 'cornflowerblue' | 'cornsilk' | 'crimson' | 'cyan' | 'darkblue' | 'darkcyan' | 'darkgoldenrod' | 'darkgray' | 'darkgreen' | 'darkgrey' | 'darkkhaki' | - 'darkmagenta' | 'darkolivegreen' | 'darkorange' | 'darkorchid' | 'darkred' | 'darksalmon' | 'darkseagreen' | 'darkslateblue' | 'darkslategray' | 'darkslategrey' | 'darkturquoise' | 'darkviolet' | - 'deeppink' | 'deepskyblue' | 'dimgray' | 'dimgrey' | 'dodgerblue' | 'firebrick' | 'floralwhite' | 'forestgreen' | 'gainsboro' | 'ghostwhite' | 'gold' | 'goldenrod' | 'greenyellow' | 'grey' | 'honeydew' | - 'hotpink' | 'indianred' | 'indigo' | 'ivory' | 'khaki' | 'lavender' | 'lavenderblush' | 'lawngreen' | 'lemonchiffon' | 'lightblue' | 'lightcoral' | 'lightcyan' | 'lightgoldenrodyellow' | 'lightgray' | 'lightgreen' | - 'lightgrey' | 'lightpink' | 'lightsalmon' | 'lightseagreen' | 'lightskyblue' | 'lightslategray' | 'lightslategrey' | 'lightsteelblue' | 'lightyellow' | 'limegreen' | 'linen' | 'magenta' | 'mediumaquamarine' | 'mediumblue' | - 'mediumorchid' | 'mediumpurple' | 'mediumseagreen' | 'mediumslateblue' | 'mediumspringgreen' | 'mediumturquoise' | 'mediumvioletred' | 'midnightblue' | 'mintcream' | 'mistyrose' | 'moccasin' | 'navajowhite' | 'oldlace' | - 'olivedrab' | 'orange' | 'orangered' | 'orchid' | 'palegoldenrod' | 'palegreen' | 'paleturquoise' | 'palevioletred' | 'papayawhip' | 'peachpuff' | 'peru' | 'pink' | 'plum' | 'powderblue' | 'rosybrown' | 'royalblue' | - 'saddlebrown' | 'salmon' | 'sandybrown' | 'seagreen' | 'seashell' | 'sienna' | 'skyblue' | 'slateblue' | 'slategray' | 'slategrey' | 'snow' | 'springgreen' | 'steelblue' | 'tan' | 'thistle' | 'tomato' | 'turquoise' | - 'violet' | 'wheat' | 'whitesmoke' | 'yellowgreen'; - - /** Alias for `colours` */ - export const colors: { - [x in Colors]: (t: string) => string; - }; - - /** - * Change the colour of the given text (List: https://docs.davidjcralph.co.uk/#/leeks) - * @param {string} t The text to change the colour of - */ - export const colours: { - [x in Colors]: (t: string) => string - }; - - /** - * Change the style of the given text (List: https://docs.davidjcralph.co.uk/#/leeks) - * @param {string} t The text to change the style of - */ - export const styles: { - [x in Styles]: (t: string) => string - }; - - /** - * Change the colour of the given text (List: https://docs.davidjcralph.co.uk/#/leeks) - * @param {string} t The text to change the colour of - */ - export const keywords: { - [x in Keywords]: (t: string) => string - }; - - /** - * Change the background colour of the given text (List: https://docs.davidjcralph.co.uk/#/leeks) - * @param {string} t The text to change the colour of - */ - export const bgKeywords: { - [x in Keywords]: (t: string) => string - }; - - /** Alias for `supportsColour` */ - export const supportsColor: boolean; - - /** Check if colours are supported (From https://github.com/jorgebucaran/colorette) (returns false on all browsers) */ - export const supportsColour: boolean; - - /** - * Change the background colour of the given text using 8-bit colours - * @param i The 8-bit colour to use - * @param t The text to show with the 8-bit colour - */ - export const eightBit: (i: string, t: string) => string; - - /** - * Change the background colour of the given text using 8-bit colours - * @param i The 8-bit colour to use - * @param t The text to show with the 8-bit colour - */ - export const eightBitBg: (i: string, t: string) => string; - - /** - * Change the colour of the given text using RGB - * @param rgb An array of the RGB to use - * @param t The text to show with the RGB color - */ - export const rgb: (rgb: [number, number, number], t: string) => string; - - /** - * Change the background colour of the given text using RGB - * @param rgb An array of the RGB to use - * @param t The text to show with the RGB colour - */ - export const rgbBg: (rgb: [number, number, number], t: string) => string; - - /** - * Change the colour of the given text using hexadecimals - * @param {string} hex The hex to use - * @param {string} t The text to show with the hexadecimal colour - * @credit [Stack Overflow](https://stackoverflow.com/q/5623838) - */ - export const hex: (hex: string, t: string) => string; - - /** - * Change the background colour of the given text using hexadecimals - * @param {string} hex The hex to use - * @param {string} t The text to show with the hexadecimal colour - * @credit [Stack Overflow](https://stackoverflow.com/q/5623838) - */ - export const hexBg: (hex: string, t: string) => string; - - /** - * Set an alias - * @param {string} name The name of the alias - * @param {string} type Either "colours", "colors" or "styles" - * @param {string} value The colour/style you want to use, e.g leeks.colours.green - */ - export type alias = () => void; - - /** Enable colour support for leeks.js */ - export type enableColours = () => void; - - /** Alias for `enableColours` */ - export type enableColors = () => void; - - /** Disable colour support for leeks.js */ - export type disableColours = () => void; - - /** Alias for `disabeColours` */ - export type disableColors = () => void; -} + type Styles = 'reset' | 'bold' | 'dim' | 'italic' | 'underline' | 'overline' | 'blink' | 'inverse' | 'strikethrough' | 'nostrikethrough' | 'nounderline' | 'nooverline' | 'noblink' | 'noinverse'; + type Colors = 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray' | 'grey' | + 'blackBright' | 'redBright' | 'yellowBright' | 'blueBright' | 'magentaBright' | 'cyanBright' | 'whiteBright' | 'greenBright' | + 'bgBlack' | 'bgRed' | 'bgGreen' | 'bgYellow' | 'bgBlue' | 'bgMagenta' | 'bgCyan' | 'bgWhite' | + 'bgBlackBright' | 'bgRedBright' | 'bgGreenBright' | 'bgBlueBright' | 'bgMagentaBright' | 'bgCyanBright' | 'bgWhiteBright' | 'bgYellowBright' | + 'bgGray' | 'bgGrey'; + + type Keywords = 'black' | 'silver' | 'gray' | 'white' | 'maroon' | 'red' | 'purple' | 'fuchsia' | 'green' | 'lime' | 'olive' | + 'yellow' | 'navy' | 'blue' | 'teal' | 'aqua' | 'aliceblue' | 'antiquewhite' | 'aquamarine' | 'azure' | 'beige' | 'bisque' | 'blanchedalmond' | 'blueviolet' | 'brown' | 'burlywood' | 'cadetblue' | + 'chartreuse' | 'chocolate' | 'coral' | 'cornflowerblue' | 'cornsilk' | 'crimson' | 'cyan' | 'darkblue' | 'darkcyan' | 'darkgoldenrod' | 'darkgray' | 'darkgreen' | 'darkgrey' | 'darkkhaki' | + 'darkmagenta' | 'darkolivegreen' | 'darkorange' | 'darkorchid' | 'darkred' | 'darksalmon' | 'darkseagreen' | 'darkslateblue' | 'darkslategray' | 'darkslategrey' | 'darkturquoise' | 'darkviolet' | + 'deeppink' | 'deepskyblue' | 'dimgray' | 'dimgrey' | 'dodgerblue' | 'firebrick' | 'floralwhite' | 'forestgreen' | 'gainsboro' | 'ghostwhite' | 'gold' | 'goldenrod' | 'greenyellow' | 'grey' | 'honeydew' | + 'hotpink' | 'indianred' | 'indigo' | 'ivory' | 'khaki' | 'lavender' | 'lavenderblush' | 'lawngreen' | 'lemonchiffon' | 'lightblue' | 'lightcoral' | 'lightcyan' | 'lightgoldenrodyellow' | 'lightgray' | 'lightgreen' | + 'lightgrey' | 'lightpink' | 'lightsalmon' | 'lightseagreen' | 'lightskyblue' | 'lightslategray' | 'lightslategrey' | 'lightsteelblue' | 'lightyellow' | 'limegreen' | 'linen' | 'magenta' | 'mediumaquamarine' | 'mediumblue' | + 'mediumorchid' | 'mediumpurple' | 'mediumseagreen' | 'mediumslateblue' | 'mediumspringgreen' | 'mediumturquoise' | 'mediumvioletred' | 'midnightblue' | 'mintcream' | 'mistyrose' | 'moccasin' | 'navajowhite' | 'oldlace' | + 'olivedrab' | 'orange' | 'orangered' | 'orchid' | 'palegoldenrod' | 'palegreen' | 'paleturquoise' | 'palevioletred' | 'papayawhip' | 'peachpuff' | 'peru' | 'pink' | 'plum' | 'powderblue' | 'rosybrown' | 'royalblue' | + 'saddlebrown' | 'salmon' | 'sandybrown' | 'seagreen' | 'seashell' | 'sienna' | 'skyblue' | 'slateblue' | 'slategray' | 'slategrey' | 'snow' | 'springgreen' | 'steelblue' | 'tan' | 'thistle' | 'tomato' | 'turquoise' | + 'violet' | 'wheat' | 'whitesmoke' | 'yellowgreen'; + + /** Alias for `colours` */ + export const colors: { + [x in Colors]: (t: string) => string; + }; + + /** + * Change the colour of the given text (List: https://docs.davidcralph.co.uk/#/leeks) + * @param {string} t The text to change the colour of + */ + export const colours: { + [x in Colors]: (t: string) => string + }; + + /** + * Change the style of the given text (List: https://docs.davidcralph.co.uk/#/leeks) + * @param {string} t The text to change the style of + */ + export const styles: { + [x in Styles]: (t: string) => string + }; + + /** + * Change the colour of the given text (List: https://docs.davidcralph.co.uk/#/leeks) + * @param {string} t The text to change the colour of + */ + export const keywords: { + [x in Keywords]: (t: string) => string + }; + + /** + * Change the background colour of the given text (List: https://docs.davidcralph.co.uk/#/leeks) + * @param {string} t The text to change the colour of + */ + export const bgKeywords: { + [x in Keywords]: (t: string) => string + }; + + /** Alias for `supportsColour` */ + export const supportsColor: boolean; + + /** Check if colours are supported (From https://github.com/jorgebucaran/colorette) (returns false on all browsers) */ + export const supportsColour: boolean; + + /** + * Change the background colour of the given text using 8-bit colours + * @param i The 8-bit colour to use + * @param t The text to show with the 8-bit colour + */ + export const eightBit: (i: string, t: string) => string; + + /** + * Change the background colour of the given text using 8-bit colours + * @param i The 8-bit colour to use + * @param t The text to show with the 8-bit colour + */ + export const eightBitBg: (i: string, t: string) => string; + + /** + * Change the colour of the given text using RGB + * @param rgb An array of the RGB to use + * @param t The text to show with the RGB color + */ + export const rgb: (rgb: [number, number, number], t: string) => string; + + /** + * Change the background colour of the given text using RGB + * @param rgb An array of the RGB to use + * @param t The text to show with the RGB colour + */ + export const rgbBg: (rgb: [number, number, number], t: string) => string; + + /** + * Change the colour of the given text using hexadecimals + * @param {string} hex The hex to use + * @param {string} t The text to show with the hexadecimal colour + * @credit [Stack Overflow](https://stackoverflow.com/q/5623838) + */ + export const hex: (hex: string, t: string) => string; + + /** + * Change the background colour of the given text using hexadecimals + * @param {string} hex The hex to use + * @param {string} t The text to show with the hexadecimal colour + * @credit [Stack Overflow](https://stackoverflow.com/q/5623838) + */ + export const hexBg: (hex: string, t: string) => string; + + /** + * Set an alias + * @param {string} name The name of the alias + * @param {string} type Either "colours", "colors" or "styles" + * @param {string} value The colour/style you want to use, e.g leeks.colours.green + */ + export type alias = () => void; + + /** Enable colour support for leeks.js */ + export type enableColours = () => void; + + /** Alias for `enableColours` */ + export type enableColors = () => void; + + /** Disable colour support for leeks.js */ + export type disableColours = () => void; + + /** Alias for `disabeColours` */ + export type disableColors = () => void; +}; diff --git a/package.json b/package.json index 9b3e154..cd1d0db 100644 --- a/package.json +++ b/package.json @@ -1,34 +1,34 @@ { - "name": "leeks.js", - "version": "0.2.2", - "description": "Simple ANSI styling for your terminal", - "author": "David Ralph", - "license": "MIT", - "main": "dist/index.js", - "types": "index.d.ts", - "bugs": { - "url": "https://github.com/davidcralph/leeks.js/issues" - }, - "homepage": "https://leeks.js.org", - "repository": { - "type": "git", - "url": "https://github.com/davidcralph/leeks.js" - }, - "keywords": [ - "color", - "colour", - "colors", - "colours", - "ansi", - "style", - "styles", - "terminal", - "console", - "lightweight", - "rgb", - "256" - ], - "devDependencies": { - "@types/node": "^16.0.0" - } + "name": "leeks.js", + "version": "0.2.2", + "description": "Simple ANSI styling for your terminal", + "author": "David Ralph", + "license": "MIT", + "main": "dist/index.js", + "types": "index.d.ts", + "bugs": { + "url": "https://github.com/davidcralph/leeks.js/issues" + }, + "homepage": "https://leeks.js.org", + "repository": { + "type": "git", + "url": "https://github.com/davidcralph/leeks.js" + }, + "keywords": [ + "color", + "colour", + "colors", + "colours", + "ansi", + "style", + "styles", + "terminal", + "console", + "lightweight", + "rgb", + "256" + ], + "devDependencies": { + "@types/node": "^16.9.6" + } } diff --git a/src/data/Colours.ts b/src/data/Colours.ts index 432962f..343d66f 100644 --- a/src/data/Colours.ts +++ b/src/data/Colours.ts @@ -1,41 +1,40 @@ +// List: https://en.wikipedia.org/wiki/ANSI_escape_code#3-bit_and_4-bit export default { - // Default - black: 30, - red: 31, - green: 32, - yellow: 33, - blue: 34, - magenta: 35, - cyan: 36, - white: 37, - gray: 90, - grey: 90, - blackBright: 90, - redBright: 91, - greenBright: 92, - yellowBright: 93, - blueBright: 94, - magentaBright: 95, - cyanBright: 96, - whiteBright: 97, + black: 30, + red: 31, + green: 32, + yellow: 33, + blue: 34, + magenta: 35, + cyan: 36, + white: 37, + gray: 90, + grey: 90, + blackBright: 90, + redBright: 91, + greenBright: 92, + yellowBright: 93, + blueBright: 94, + magentaBright: 95, + cyanBright: 96, + whiteBright: 97, - // Background - bgBlack: 40, - bgRed: 41, - bgGreen: 42, - bgYellow: 43, - bgBlue: 44, - bgMagenta: 45, - bgCyan: 46, - bgWhite: 47, - bgBlackBright: 100, - bgRedBright: 101, - bgGreenBright: 102, - bgYellowBright: 103, - bgBlueBright: 104, - bgMagentaBright: 105, - bgCyanBright: 106, - bgWhiteBright: 107, - bgGray: 100, - bgGrey: 100 -} \ No newline at end of file + bgBlack: 40, + bgRed: 41, + bgGreen: 42, + bgYellow: 43, + bgBlue: 44, + bgMagenta: 45, + bgCyan: 46, + bgWhite: 47, + bgBlackBright: 100, + bgRedBright: 101, + bgGreenBright: 102, + bgYellowBright: 103, + bgBlueBright: 104, + bgMagentaBright: 105, + bgCyanBright: 106, + bgWhiteBright: 107, + bgGray: 100, + bgGrey: 100 +}; diff --git a/src/data/Keywords.ts b/src/data/Keywords.ts index 18d4c28..57324e9 100644 --- a/src/data/Keywords.ts +++ b/src/data/Keywords.ts @@ -1,152 +1,153 @@ +// List: https://www.w3.org/TR/2018/REC-css-color-3-20180619/ export default { - // Basic - black: [0, 0, 0], - silver: [192, 192, 192], - gray: [128, 128, 128], - white: [255, 255, 255], - maroon: [128, 0, 0], - red: [255, 0, 0], - purple: [128, 0, 128], - fuchsia: [255, 0, 255], - green: [0, 128, 0], - lime: [0, 255, 0], - olive: [128, 128, 0], - yellow: [255, 255, 0], - navy: [0, 0, 128], - blue: [0, 0, 255], - teal: [0, 128, 128], - aqua: [0, 255, 255], - - // Extended - aliceblue: [240, 248, 255], - antiquewhite: [250, 235, 215], - aquamarine: [127, 255, 212], - azure: [240, 255, 255], - beige: [245, 245, 220], - bisque: [255, 228, 196], - blanchedalmond: [255, 235, 205], - blueviolet: [138, 43, 226], - brown: [165, 42, 42], - burlywood: [222, 184, 135], - cadetblue: [95, 158, 160], - chartreuse: [127, 255, 0], - chocolate: [210, 105, 30], - coral: [255, 127, 80], - cornflowerblue: [100, 149, 237], - cornsilk: [255, 248, 220], - crimson: [220, 20, 60], - cyan: [0, 255, 255], - darkblue: [0, 0, 139], - darkcyan: [0, 139, 139], - darkgoldenrod: [184, 134, 11], - darkgray: [169, 169, 169], - darkgreen: [0, 100, 0], - darkgrey: [169, 169, 169], - darkkhaki: [189, 183, 107], - darkmagenta: [139, 0, 139], - darkolivegreen: [85, 107, 47], - darkorange: [255, 140, 0], - darkorchid: [153, 50, 204], - darkred: [139, 0, 0], - darksalmon: [233, 150, 122], - darkseagreen: [143, 188, 143], - darkslateblue: [72, 61, 139], - darkslategray: [47, 79, 79], - darkslategrey: [47, 79, 79], - darkturquoise: [0, 206, 209], - darkviolet: [148, 0, 211], - deeppink: [255, 20, 147], - deepskyblue: [0, 191, 255], - dimgray: [105, 105, 105], - dimgrey: [105, 105, 105], - dodgerblue: [30, 144, 255], - firebrick: [178, 34, 34], - floralwhite: [255, 250, 240], - forestgreen: [34, 139, 34], - gainsboro: [220, 220, 220], - ghostwhite: [248, 248, 255], - gold: [255, 215, 0], - goldenrod: [218, 165, 32], - greenyellow: [173, 255, 47], - grey: [128, 128, 128], - honeydew: [240, 255, 240], - hotpink: [255, 105, 180], - indianred: [205, 92, 92], - indigo: [75, 0, 130], - ivory: [255, 255, 240], - khaki: [240, 230, 140], - lavender: [230, 230, 250], - lavenderblush: [255, 240, 245], - lawngreen: [124, 252, 0], - lemonchiffon: [255, 250, 205], - lightblue: [173, 216, 230], - lightcoral: [240, 128, 128], - lightcyan: [224, 255, 255], - lightgoldenrodyellow: [250, 250, 210], - lightgray: [211, 211, 211], - lightgreen: [144, 238, 144], - lightgrey: [211, 211, 211], - lightpink: [255, 182, 193], - lightsalmon: [255, 160, 122], - lightseagreen: [32, 178, 170], - lightskyblue: [135, 206, 250], - lightslategray: [119, 136, 153], - lightslategrey: [119, 136, 153], - lightsteelblue: [176, 196, 222], - lightyellow: [255, 255, 224], - limegreen: [50, 205, 50], - linen: [250, 240, 230], - magenta: [255, 0, 255], - mediumaquamarine: [102, 205, 170], - mediumblue: [0, 0, 205], - mediumorchid: [186, 85, 211], - mediumpurple: [147, 112, 219], - mediumseagreen: [60, 179, 113], - mediumslateblue: [123, 104, 238], - mediumspringgreen: [0, 250, 154], - mediumturquoise: [72, 209, 204], - mediumvioletred: [199, 21, 133], - midnightblue: [25, 25, 112], - mintcream: [245, 255, 250], - mistyrose: [255, 228, 225], - moccasin: [255, 228, 181], - navajowhite: [255, 222, 173], - oldlace: [253, 245, 230], - olivedrab: [107, 142, 35], - orange: [255, 165, 0], - orangered: [255, 69, 0], - orchid: [218, 112, 214], - palegoldenrod: [238, 232, 170], - palegreen: [152, 251, 152], - paleturquoise: [175, 238, 238], - palevioletred: [219, 112, 147], - papayawhip: [255, 239, 213], - peachpuff: [255, 218, 185], - peru: [205, 133, 63], - pink: [255, 192, 203], - plum: [221, 160, 221], - powderblue: [176, 224, 230], - rosybrown: [188, 143, 143], - royalblue: [65, 105, 225], - saddlebrown: [139, 69, 19], - salmon: [250, 128, 114], - sandybrown: [244, 164, 96], - seagreen: [46, 139, 87], - seashell: [255, 245, 238], - sienna: [160, 82, 45], - skyblue: [135, 206, 235], - slateblue: [106, 90, 205], - slategray: [112, 128, 144], - slategrey: [112, 128, 144], - snow: [255, 250, 250], - springgreen: [0, 255, 127], - steelblue: [70, 130, 180], - tan: [210, 180, 140], - thistle: [216, 191, 216], - tomato: [255, 99, 71], - turquoise: [64, 224, 208], - violet: [238, 130, 238], - wheat: [245, 222, 179], - whitesmoke: [245, 245, 245], - yellowgreen: [154, 205, 50] -} \ No newline at end of file + // Basic + black: [0, 0, 0], + silver: [192, 192, 192], + gray: [128, 128, 128], + white: [255, 255, 255], + maroon: [128, 0, 0], + red: [255, 0, 0], + purple: [128, 0, 128], + fuchsia: [255, 0, 255], + green: [0, 128, 0], + lime: [0, 255, 0], + olive: [128, 128, 0], + yellow: [255, 255, 0], + navy: [0, 0, 128], + blue: [0, 0, 255], + teal: [0, 128, 128], + aqua: [0, 255, 255], + + // Extended + aliceblue: [240, 248, 255], + antiquewhite: [250, 235, 215], + aquamarine: [127, 255, 212], + azure: [240, 255, 255], + beige: [245, 245, 220], + bisque: [255, 228, 196], + blanchedalmond: [255, 235, 205], + blueviolet: [138, 43, 226], + brown: [165, 42, 42], + burlywood: [222, 184, 135], + cadetblue: [95, 158, 160], + chartreuse: [127, 255, 0], + chocolate: [210, 105, 30], + coral: [255, 127, 80], + cornflowerblue: [100, 149, 237], + cornsilk: [255, 248, 220], + crimson: [220, 20, 60], + cyan: [0, 255, 255], + darkblue: [0, 0, 139], + darkcyan: [0, 139, 139], + darkgoldenrod: [184, 134, 11], + darkgray: [169, 169, 169], + darkgreen: [0, 100, 0], + darkgrey: [169, 169, 169], + darkkhaki: [189, 183, 107], + darkmagenta: [139, 0, 139], + darkolivegreen: [85, 107, 47], + darkorange: [255, 140, 0], + darkorchid: [153, 50, 204], + darkred: [139, 0, 0], + darksalmon: [233, 150, 122], + darkseagreen: [143, 188, 143], + darkslateblue: [72, 61, 139], + darkslategray: [47, 79, 79], + darkslategrey: [47, 79, 79], + darkturquoise: [0, 206, 209], + darkviolet: [148, 0, 211], + deeppink: [255, 20, 147], + deepskyblue: [0, 191, 255], + dimgray: [105, 105, 105], + dimgrey: [105, 105, 105], + dodgerblue: [30, 144, 255], + firebrick: [178, 34, 34], + floralwhite: [255, 250, 240], + forestgreen: [34, 139, 34], + gainsboro: [220, 220, 220], + ghostwhite: [248, 248, 255], + gold: [255, 215, 0], + goldenrod: [218, 165, 32], + greenyellow: [173, 255, 47], + grey: [128, 128, 128], + honeydew: [240, 255, 240], + hotpink: [255, 105, 180], + indianred: [205, 92, 92], + indigo: [75, 0, 130], + ivory: [255, 255, 240], + khaki: [240, 230, 140], + lavender: [230, 230, 250], + lavenderblush: [255, 240, 245], + lawngreen: [124, 252, 0], + lemonchiffon: [255, 250, 205], + lightblue: [173, 216, 230], + lightcoral: [240, 128, 128], + lightcyan: [224, 255, 255], + lightgoldenrodyellow: [250, 250, 210], + lightgray: [211, 211, 211], + lightgreen: [144, 238, 144], + lightgrey: [211, 211, 211], + lightpink: [255, 182, 193], + lightsalmon: [255, 160, 122], + lightseagreen: [32, 178, 170], + lightskyblue: [135, 206, 250], + lightslategray: [119, 136, 153], + lightslategrey: [119, 136, 153], + lightsteelblue: [176, 196, 222], + lightyellow: [255, 255, 224], + limegreen: [50, 205, 50], + linen: [250, 240, 230], + magenta: [255, 0, 255], + mediumaquamarine: [102, 205, 170], + mediumblue: [0, 0, 205], + mediumorchid: [186, 85, 211], + mediumpurple: [147, 112, 219], + mediumseagreen: [60, 179, 113], + mediumslateblue: [123, 104, 238], + mediumspringgreen: [0, 250, 154], + mediumturquoise: [72, 209, 204], + mediumvioletred: [199, 21, 133], + midnightblue: [25, 25, 112], + mintcream: [245, 255, 250], + mistyrose: [255, 228, 225], + moccasin: [255, 228, 181], + navajowhite: [255, 222, 173], + oldlace: [253, 245, 230], + olivedrab: [107, 142, 35], + orange: [255, 165, 0], + orangered: [255, 69, 0], + orchid: [218, 112, 214], + palegoldenrod: [238, 232, 170], + palegreen: [152, 251, 152], + paleturquoise: [175, 238, 238], + palevioletred: [219, 112, 147], + papayawhip: [255, 239, 213], + peachpuff: [255, 218, 185], + peru: [205, 133, 63], + pink: [255, 192, 203], + plum: [221, 160, 221], + powderblue: [176, 224, 230], + rosybrown: [188, 143, 143], + royalblue: [65, 105, 225], + saddlebrown: [139, 69, 19], + salmon: [250, 128, 114], + sandybrown: [244, 164, 96], + seagreen: [46, 139, 87], + seashell: [255, 245, 238], + sienna: [160, 82, 45], + skyblue: [135, 206, 235], + slateblue: [106, 90, 205], + slategray: [112, 128, 144], + slategrey: [112, 128, 144], + snow: [255, 250, 250], + springgreen: [0, 255, 127], + steelblue: [70, 130, 180], + tan: [210, 180, 140], + thistle: [216, 191, 216], + tomato: [255, 99, 71], + turquoise: [64, 224, 208], + violet: [238, 130, 238], + wheat: [245, 222, 179], + whitesmoke: [245, 245, 245], + yellowgreen: [154, 205, 50] +}; diff --git a/src/data/Styles.ts b/src/data/Styles.ts index 3cab63b..2bf486b 100644 --- a/src/data/Styles.ts +++ b/src/data/Styles.ts @@ -1,22 +1,21 @@ +// list: https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters (only some are added) export default { - reset: 0, + reset: 0, - // Styles - bold: 1, - dim: 2, - italic: 3, - underline: 4, - overline: 53, - blink: 5, - inverse: 7, - strikethrough: 9, - hidden: 8, - shown: 28, + bold: 1, + dim: 2, + italic: 3, + underline: 4, + overline: 53, + blink: 5, + inverse: 7, + strikethrough: 9, + hidden: 8, + shown: 28, - // Remove styles - nostrikethrough: 29, - nounderline: 24, - nooverline: 55, - noblink: 25, - noinverse: 27 -} \ No newline at end of file + nostrikethrough: 29, + nounderline: 24, + nooverline: 55, + noblink: 25, + noinverse: 27 +}; diff --git a/src/index.ts b/src/index.ts index 67d0c49..e0c2e84 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,6 +1,6 @@ /** * @module leeks.js - * @copyright David Ralph (ohlookitsderpy) 2019-2021 + * @copyright David Ralph 2019-2021 * @license MIT */ import Colours from './data/Colours'; @@ -11,47 +11,49 @@ const isNode = typeof process !== 'undefined'; /** * Check if colours are supported (returns false on browser) - * @credit [Colorette](https://github.com/jorgebucaran/colorette) */ -const supports = isNode ? !('NO_COLOR' in process.env) && process.env.FORCE_COLOR !== '0' && (process.env.FORCE_COLOR !== undefined || process.platform === 'win32' || (process.stdout.isTTY && process.env.TERM && process.env.TERM !== 'dumb')) : false; +const supports = isNode ? + !('NO_COLOR' in process.env) && process.env.FORCE_COLOR !== '0' // NO_COLOR support and FORCE_COLOR=0 (disabling colour support) + && process.stdout.hasColors && process.stdout.hasColors() == true + : false; // Enable/disable support for colours, by default checks for support using the function let enabled = supports ? true : false; /** - * Change the colour of the given text (List: https://docs.davidjcralph.co.uk/#/leeks) + * Change the colour of the given text (List: https://docs.davidcralph.co.uk/#/leeks) * @param {string} t The text to change the colour of */ -let colours = []; +const colours = []; for (const c in Colours) { - colours[c] = (t: string) => enabled ? `\x1b[${Colours[c]}m${t}\x1b[0m` : t; + colours[c] = (t: string) => enabled ? `\x1b[${Colours[c]}m${t}\x1b[0m` : t; } /** - * Change the style of the given text (List: https://docs.davidjcralph.co.uk/#/leeks) + * Change the style of the given text (List: https://docs.davidcralph.co.uk/#/leeks) * @param {string} t The text to change the colour of */ -let styles = []; +const styles = []; for (const s in Styles) { - styles[s] = (t: string) => `\x1b[${Styles[s]}m${t}\x1b[0m`; + styles[s] = (t: string) => `\x1b[${Styles[s]}m${t}\x1b[0m`; } /** - * Change the colour of the given text using CSS keywords (List: https://docs.davidjcralph.co.uk/#/leeks) + * Change the colour of the given text using CSS keywords (List: https://docs.davidcralph.co.uk/#/leeks) * @param {string} t The text to change the colour of */ -let keywords = []; +const keywords = []; for (const k in Keywords) { - keywords[k] = (t: string) => enabled ? rgb(Keywords[k], t) : t; + keywords[k] = (t: string) => enabled ? rgb(Keywords[k], t) : t; } /** - * Change the background colour of the given text using CSS keywords (List: https://docs.davidjcralph.co.uk/#/leeks) + * Change the background colour of the given text using CSS keywords (List: https://docs.davidcralph.co.uk/#/leeks) * @param {string} t The text to change the colour of */ -let bgKeywords = []; +const bgKeywords = []; for (const k in Keywords) { - bgKeywords[k] = (t: string) => enabled ? rgbBg(Keywords[k], t) : t; + bgKeywords[k] = (t: string) => enabled ? rgbBg(Keywords[k], t) : t; } /** @@ -60,8 +62,11 @@ for (const k in Keywords) { * @param {string} t The text to show with the 8-bit colour */ export function eightBit(i: string, t: string) { - if (!enabled) return t; - return '\033' + `[38;5;${i}m${t}\x1b[0m`; + if (!enabled) { + return t; + } + + return '\033' + `[38;5;${i}m${t}\x1b[0m`; }; /** @@ -70,8 +75,11 @@ export function eightBit(i: string, t: string) { * @param {string} t The text to show with the 8-bit colour */ export function eightBitBg(i: string, t: string) { - if (!enabled) return t; - return '\033' + `[48;5;${i}m${t}\x1b[0m`; + if (!enabled) { + return t; + } + + return '\033' + `[48;5;${i}m${t}\x1b[0m`; }; /** @@ -80,10 +88,12 @@ export function eightBitBg(i: string, t: string) { * @param {string} t The text to show with the RGB colour */ export function rgb(rgb: [number, number, number], t: string) { - if (!enabled) return t; + if (!enabled) { + return t; + } - const [r, g, b] = rgb; - return '\033' + `[38;2;${r};${g};${b}m${t}\x1b[0m`; + const [r, g, b] = rgb; + return '\033' + `[38;2;${r};${g};${b}m${t}\x1b[0m`; }; /** @@ -92,10 +102,12 @@ export function rgb(rgb: [number, number, number], t: string) { * @param {string} t The text to show with the RGB colour */ export function rgbBg(rgb: [number, number, number], t: string) { - if (!enabled) return t; + if (!enabled) { + return t; + } - const [r, g, b] = rgb; - return '\033' + `[48;2;${r};${g};${b}m${t}\x1b[0m`; + const [r, g, b] = rgb; + return '\033' + `[48;2;${r};${g};${b}m${t}\x1b[0m`; }; /** @@ -105,8 +117,8 @@ export function rgbBg(rgb: [number, number, number], t: string) { * @credit [Stack Overflow](https://stackoverflow.com/q/5623838) */ export function hex(hex: string, t: string) { - const bigint = parseInt(hex.replace('#', ''), 16); - return rgb([(bigint >> 16) & 255, (bigint >> 8) & 255, bigint & 255], t); + const bigint = parseInt(hex.replace('#', ''), 16); + return rgb([(bigint >> 16) & 255, (bigint >> 8) & 255, bigint & 255], t); }; /** @@ -116,8 +128,8 @@ export function hex(hex: string, t: string) { * @credit [Stack Overflow](https://stackoverflow.com/q/5623838) */ export function hexBg(hex: string, t: string) { - const bigint = parseInt(hex.replace('#', ''), 16); - return rgbBg([(bigint >> 16) & 255, (bigint >> 8) & 255, bigint & 255], t); + const bigint = parseInt(hex.replace('#', ''), 16); + return rgbBg([(bigint >> 16) & 255, (bigint >> 8) & 255, bigint & 255], t); }; /** @@ -127,41 +139,41 @@ export function hexBg(hex: string, t: string) { * @param {string} value The colour/style you want to use, e.g leeks.colours.green */ export function alias(name: string, type: string, value: string) { - switch (type) { - case 'colors': - case 'colours': - colours[name] = value; - break; - case 'styles': - styles[name] = value; - break; - default: - throw new Error('Must be "colours", "colors" or "styles"'); - } + switch (type) { + case 'colors': + case 'colours': + colours[name] = value; + break; + case 'styles': + styles[name] = value; + break; + default: + throw new Error('Must be "colours", "colors" or "styles"'); + } }; /** * Enable colour support for leeks.js */ export function enableColours() { - enabled = true; + enabled = true; }; /** * Disable colour support for leeks.js */ export function disableColours() { - enabled = false; + enabled = false; }; export { - colours as colors, - supports as supportsColor, - supports as supportsColour, - enableColours as enableColors, - disableColours as disableColors, - colours, - keywords, - bgKeywords, - styles + colours as colors, + supports as supportsColor, + supports as supportsColour, + enableColours as enableColors, + disableColours as disableColors, + colours, + keywords, + bgKeywords, + styles }; diff --git a/tsconfig.json b/tsconfig.json index 3facb1d..44241cb 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,11 +1,11 @@ { - "compilerOptions": { - "target": "ESNext", - "module": "CommonJS", - "lib": ["ES2015", "ES2016", "ES2017", "ES2018", "ES2019", "ES2020", "ESNext"], - "outDir": "./dist", - "rootDir": "src", - "noImplicitUseStrict": true - }, - "include": ["src/**/*"], - } \ No newline at end of file + "compilerOptions": { + "target": "ESNext", + "module": "CommonJS", + "lib": ["ES2015", "ES2016", "ES2017", "ES2018", "ES2019", "ES2020", "ESNext"], + "outDir": "./dist", + "rootDir": "src", + "noImplicitUseStrict": true + }, + "include": ["src/**/*"] +}