cfonts-node 2.10.1

package/fonts/tiny.json

@@ -0,0 +1,245 @@
+{
+	"name": "tiny",
+	"version": "0.1.0",
+	"homepage": "https://github.com/dominikwilkowski/cfonts",
+	"colors": 1,
+	"lines": 2,
+	"buffer": [
+		"",
+		""
+	],
+	"letterspace": [
+		" ",
+		" "
+		],
+	"chars": {
+		"A": [
+			"▄▀█",
+			"█▀█"
+		],
+		"B": [
+			"█▄▄",
+			"█▄█"
+		],
+		"C": [
+			"█▀▀",
+			"█▄▄"
+		],
+		"D": [
+			"█▀▄",
+			"█▄▀"
+		],
+		"E": [
+			"█▀▀",
+			"██▄"
+		],
+		"F": [
+			"█▀▀",
+			"█▀ "
+		],
+		"G": [
+			"█▀▀",
+			"█▄█"
+		],
+		"H": [
+			"█ █",
+			"█▀█"
+		],
+		"I": [
+			"█",
+			"█"
+		],
+		"J": [
+			"  █",
+			"█▄█"
+		],
+		"K": [
+			"█▄▀",
+			"█ █"
+		],
+		"L": [
+			"█  ",
+			"█▄▄"
+		],
+		"M": [
+			"█▀▄▀█",
+			"█ ▀ █"
+		],
+		"N": [
+			"█▄ █",
+			"█ ▀█"
+		],
+		"O": [
+			"█▀█",
+			"█▄█"
+		],
+		"P": [
+			"█▀█",
+			"█▀▀"
+		],
+		"Q": [
+			"█▀█",
+			"▀▀█"
+		],
+		"R": [
+			"█▀█",
+			"█▀▄"
+		],
+		"S": [
+			"█▀▀",
+			"▄▄█"
+		],
+		"T": [
+			"▀█▀",
+			" █ "
+		],
+		"U": [
+			"█ █",
+			"█▄█"
+		],
+		"V": [
+			"█ █",
+			"▀▄▀"
+		],
+		"W": [
+			"█ █ █",
+			"▀▄▀▄▀"
+		],
+		"X": [
+			"▀▄▀",
+			"█ █"
+		],
+		"Y": [
+			"█▄█",
+			" █ "
+		],
+		"Z": [
+			"▀█",
+			"█▄"
+		],
+		"0": [
+			"▞█▚",
+			"▚█▞"
+		],
+		"1": [
+			"▄█",
+			" █"
+		],
+		"2": [
+			"▀█",
+			"█▄"
+		],
+		"3": [
+			"▀▀█",
+			"▄██"
+		],
+		"4": [
+			"█ █",
+			"▀▀█"
+		],
+		"5": [
+			"█▀",
+			"▄█"
+		],
+		"6": [
+			"█▄▄",
+			"█▄█"
+		],
+		"7": [
+			"▀▀█",
+			"  █"
+		],
+		"8": [
+			"███",
+			"█▄█"
+		],
+		"9": [
+			"█▀█",
+			"▀▀█"
+		],
+		"!": [
+			"█",
+			"▄"
+		],
+		"?": [
+			"▀█",
+			" ▄"
+		],
+		".": [
+			" ",
+			"▄"
+		],
+		"+": [
+			"▄█▄",
+			" ▀ "
+		],
+		"-": [
+			"▄▄",
+			"  "
+		],
+		"_": [
+			"  ",
+			"▄▄"
+		],
+		"=": [
+			"▀▀",
+			"▀▀"
+		],
+		"@": [
+			"▛█▜",
+			"▙▟▃"
+		],
+		"#": [
+			"▟▄▙",
+			"▜▀▛"
+		],
+		"$": [
+			"▖█▗",
+			"▘█▝"
+		],
+		"%": [
+			"▀ ▄▀",
+			"▄▀ ▄"
+		],
+		"&": [
+			"▄▄█",
+			"█▄█"
+		],
+		"(": [
+			"▄▀",
+			"▀▄"
+		],
+		")": [
+			"▀▄",
+			"▄▀"
+		],
+		"/": [
+			"  ▄▀",
+			"▄▀  "
+		],
+		":": [
+			"▀",
+			"▄"
+		],
+		";": [
+			"  ",
+			"▄▀"
+		],
+		",": [
+			" ",
+			"█"
+		],
+		"'": [
+			"▀",
+			" "
+		],
+		"\"": [
+			"▛ ▜",
+			"   "
+		],
+		" ": [
+			" ",
+			" "
+		]
+	}
+}

package/package.json

@@ -0,0 +1,117 @@
+{
+	"name": "cfonts-node",
+	"description": "Set of available fonts for nodejs projects",
+	"version": "2.10.1",
+	"author": {
+		"name": "Yuval Moshe"
+	},
+	"licenses": [
+		{
+			"type": "GPL-2.0"
+		}
+	],
+	"engines": {
+		"node": ">=10"
+	},
+	"scripts": {
+		"prepublish": "yarn build && yarn test",
+		"test": "yarn build && yarn test:unit && yarn test:lint && yarn test:types && yarn test:fonts",
+		"test:fonts": "node ./test/fonttest.js",
+		"test:watch": "jest --watchAll --coverage",
+		"test:unit": "npx cross-env FORCE_COLOR=3 jest",
+		"test:types": "yarn types:clean && tsc -p tsconfig.json",
+		"test:lint": "eslint src/",
+		"build": "yarn build:lib && yarn build:bin",
+		"postinstall": "npm run fonts-assist",
+		"fonts-assist": "node ./src/Config.js",
+		"build:bin": "npx mkdirp bin && mv lib/bin.js bin/index.js",
+		"build:lib": "npx mkdirp lib && babel src --out-dir lib",
+		"types:clean": "find lib/ -type f -name '*.d.ts' -exec rm {} +",
+		"watch": "yarn build:lib && onchange 'src/**/*' -- yarn build:lib",
+		"coveralls": "jest --coverage --coverageReporters=text-lcov | coveralls",
+		"nuke": "rm -rf lib && rm -rf node_modules && rm yarn.lock"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.15.4",
+		"@babel/core": "^7.15.5",
+		"@babel/preset-env": "^7.15.6",
+		"@types/node": "latest",
+		"coveralls": "^3.1.1",
+		"eslint": "^7.32.0",
+		"jest-cli": "^27.2.0",
+		"onchange": "^7.1.0",
+		"typescript": "^4.4.3"
+	},
+	"dependencies": {
+		"axios": "^0.26.1",
+		"chalk": "^4.1.2",
+		"window-size": "^1.1.1"
+	},
+	"jest": {
+		"displayName": "CFonts",
+		"testEnvironment": "node",
+		"testRegex": "\\.spec.js$",
+		"collectCoverageFrom": [
+			"src/*.js"
+		],
+		"setupFiles": [
+			"<rootDir>/test/env.js"
+		],
+		"coverageThreshold": {
+			"global": {
+				"branches": 95,
+				"functions": 100,
+				"lines": 95,
+				"statements": 95
+			}
+		}
+	},
+	"eslintConfig": {
+		"env": {
+			"node": true,
+			"commonjs": true,
+			"es6": true
+		},
+		"extends": "eslint:recommended",
+		"globals": {
+			"Atomics": "readonly",
+			"SharedArrayBuffer": "readonly"
+		},
+		"parserOptions": {
+			"ecmaVersion": 2018
+		},
+		"rules": {
+			"no-async-promise-executor": "off",
+			"no-console": "off",
+			"no-unused-vars": [
+				"error",
+				{
+					"argsIgnorePattern": "_"
+				}
+			]
+		}
+	},
+	"browserslist": [
+		"node >= 10"
+	],
+	"keywords": [
+		"font",
+		"banner",
+		"logo",
+		"CLI",
+		"console",
+		"ascii",
+		"pretty"
+	],
+	"files": [
+		"lib/*.js",
+		"bin/*",
+		"fonts/*",
+		"src/*"
+	],
+	"main": "lib/index.js",
+	"bin": {
+		"cfonts": "./bin/index.js"
+	},
+	"license": "GPL-2.0"
+}

package/src/AddChar.js

@@ -0,0 +1,51 @@
+/***************************************************************************************************************************************************************
+ *
+ * cfonts
+ *
+ * Sexy fonts for the console. (CLI output)
+ *
+ * @license     https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE  GNU GPLv2
+ * @author      Dominik Wilkowski  hi@dominik-wilkowski.com
+ * @repository  https://github.com/dominikwilkowski/cfonts
+ *
+ * AddChar
+ *   Add a new character to the output array
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const { Debugging } = require('./Debugging.js');
+const { Colorize } = require('./Colorize.js');
+
+
+/**
+ * Add a new character to the output array
+ *
+ * @param  {string}  CHAR       - The character to be added
+ * @param  {array}   output     - The output array the line shall be appended to
+ * @param  {number}  fontLines  - The number of lines this font has per character
+ * @param  {object}  fontChars  - An object with all character arrays
+ * @param  {number}  fontColors - The amount of colors allowed for this font
+ * @param  {object}  colors     - Our options
+ *
+ * @return {array}              - The output array with new line
+ */
+const AddChar = ( CHAR, output, fontLines, fontChars, fontColors, colors ) => {
+	Debugging.report( `Running AddChar with "${ CHAR }"`, 1 );
+
+	let lines = output.length - fontLines; // last line is fontLines tall and is located at the bottom of the output array
+
+	for( let i = lines; i < output.length; i++ ) { // iterate over last line
+		let index = i - lines;
+
+		output[ i ] += Colorize( fontChars[ CHAR ][ index ], fontColors, colors );
+	}
+
+	return output;
+};
+
+
+module.exports = exports = {
+	AddChar,
+};

package/src/AddLetterSpacing.js

@@ -0,0 +1,59 @@
+/***************************************************************************************************************************************************************
+ *
+ * cfonts
+ *
+ * Sexy fonts for the console. (CLI output)
+ *
+ * @license     https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE  GNU GPLv2
+ * @author      Dominik Wilkowski  hi@dominik-wilkowski.com
+ * @repository  https://github.com/dominikwilkowski/cfonts
+ *
+ * AddLetterSpacing
+ *   Add letter spacing for the next character
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const { Debugging } = require('./Debugging.js');
+const { Colorize } = require('./Colorize.js');
+
+
+
+/**
+ * Add letter spacing for the next character
+ *
+ * @param  {array}   output          - The output array the line shall be appended to
+ * @param  {number}  fontLines       - The number of lines this font has per character
+ * @param  {array}   fontLetterspace - A space between the letters
+ * @param  {number}  fontColors      - The amount of colors allowed for this font
+ * @param  {array}   colors          - The user defined colors
+ * @param  {number}  letterSpacing   - The user defined letter spacing
+ *
+ * @return {array}                   - The output array with space
+ */
+const AddLetterSpacing = ( output, fontLines, fontLetterspace, fontColors, colors, letterSpacing ) => {
+	Debugging.report( `Running AddLetterSpacing`, 1 );
+
+	let lines = output.length - fontLines; // last line is fontLines tall and is located at the bottom of the output array
+
+	for( let i = lines; i < output.length; i++ ) { // iterate over last line
+		let index = i - lines;
+		let space = Colorize( fontLetterspace[ index ], fontColors, colors );
+
+		if( space.length === 0 && letterSpacing > 0 ) {
+			Debugging.report( `AddLetterSpacing: Adding space to letter spacing`, 1 );
+
+			space = ' ';
+		}
+
+		output[ i ] += space.repeat( letterSpacing );
+	}
+
+	return output;
+};
+
+
+module.exports = exports = {
+	AddLetterSpacing,
+};

package/src/AddLine.js

@@ -0,0 +1,58 @@
+/***************************************************************************************************************************************************************
+ *
+ * cfonts
+ *
+ * Sexy fonts for the console. (CLI output)
+ *
+ * @license     https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE  GNU GPLv2
+ * @author      Dominik Wilkowski  hi@dominik-wilkowski.com
+ * @repository  https://github.com/dominikwilkowski/cfonts
+ *
+ * AddLine
+ *   Add a new line to the output array
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const { Debugging } = require('./Debugging.js');
+
+
+/**
+ * Add a new line to the output array
+ *
+ * @param  {array}   output      - The output array the line shall be appended to
+ * @param  {number}  fontLines   - The number of lines this font has per character
+ * @param  {array}   FontBuffer  - An array of the space we add at the beginning of each line
+ * @param  {number}  lineHeight  - The user defined line height
+ *
+ * @return {array}               - The output array with new line
+ */
+const AddLine = ( output, fontLines, FontBuffer, lineHeight ) => {
+	Debugging.report( `Running AddLine`, 1 );
+
+	if( output.length === 0 ) {
+		lineHeight = 0;
+	}
+
+	let lines = fontLines + output.length + lineHeight;
+	let length = output.length;
+
+	for( let i = length; i < lines; i++ ) {
+		let index = i - length;
+
+		if( index > lineHeight ) {
+			output[ i ] = FontBuffer[ ( index - lineHeight ) ];
+		}
+		else {
+			output[ i ] = '';
+		}
+	}
+
+	return output;
+};
+
+
+module.exports = exports = {
+	AddLine,
+};

package/src/AddShortcuts.js

@@ -0,0 +1,40 @@
+/***************************************************************************************************************************************************************
+ *
+ * cfonts
+ *
+ * Sexy fonts for the console. (CLI output)
+ *
+ * @license     https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE  GNU GPLv2
+ * @author      Dominik Wilkowski  hi@dominik-wilkowski.com
+ * @repository  https://github.com/dominikwilkowski/cfonts
+ *
+ * AddShortcuts
+ *   Flatten the shortcuts in our cli options object
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+
+/**
+ * Flatten the shortcuts in our cli options object
+ *
+ * @param  {object} options - An object objects with a short key
+ *
+ * @return {object}         - All short keys flattened into first level
+ */
+const AddShortcuts = ( options ) => {
+	const flatOptions = Object.assign( {}, options );
+
+	Object.keys( flatOptions ).forEach( option => {
+		flatOptions[ option ]._name = option;
+		flatOptions[ flatOptions[ option ].short ] = flatOptions[ option ];
+	});
+
+	return flatOptions;
+};
+
+
+module.exports = exports = {
+	AddShortcuts,
+};

package/src/AlignText.js

@@ -0,0 +1,68 @@
+/***************************************************************************************************************************************************************
+ *
+ * cfonts
+ *
+ * Sexy fonts for the console. (CLI output)
+ *
+ * @license     https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE  GNU GPLv2
+ * @author      Dominik Wilkowski  hi@dominik-wilkowski.com
+ * @repository  https://github.com/dominikwilkowski/cfonts
+ *
+ * AlignText
+ *   Calculate the spaces to be added to the left of each line to align them either center or right
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const { Debugging } = require('./Debugging.js');
+const { Size } = require('./Size.js');
+
+
+/**
+ * Calculate the spaces to be added to the left of each line to align them either center or right
+ *
+ * @param  {array}   output         - The output array the line shall be appended to
+ * @param  {number}  lineLength     - The current line length
+ * @param  {number}  characterLines - The amount of line breaks in one character
+ * @param  {string}  align          - The alignment of the text, only `center` and `right` will do anything
+ * @param  {object}  size           - The size of the terminal as an object, default: Size
+ * @param  {number}  size.width     - The width of the terminal
+ * @param  {number}  size.height    - The height of the terminal
+ *
+ * @return {array}                  - The output array with space added on the left for alignment
+ */
+const AlignText = ( output, lineLength, characterLines, align, size = Size ) => {
+	Debugging.report( `Running AlignText`, 1 );
+
+	let space = 0;
+
+	if( align === 'center' ) { // calculate the size for center alignment
+		space = Math.floor( ( size.width - lineLength ) / 2 );
+
+		Debugging.report( `AlignText: Center lineLength: ${ lineLength }, size.width: ${ size.width }, space: ${ space }`, 2 );
+	}
+
+	if( align === 'right' ) { // calculate the size for right alignment
+		space = size.width - lineLength;
+
+		Debugging.report( `AlignText: Right lineLength: ${ lineLength }, size.width: ${ size.width }, space: ${ space }`, 2 );
+	}
+
+
+	if( space > 0 ) { // only add if there is something to add
+		let lines = output.length - characterLines; // last line is characterLines tall and is located at the bottom of the output array
+		const spaces = ' '.repeat( space );
+
+		for( let i = lines; i < output.length; i++ ) { // iterate over last line (which can be several line breaks long)
+			output[ i ] = spaces + output[ i ];
+		}
+	}
+
+	return output;
+};
+
+
+module.exports = exports = {
+	AlignText,
+};

package/src/Chalk.js

@@ -0,0 +1,40 @@
+/***************************************************************************************************************************************************************
+ *
+ * cfonts
+ *
+ * Sexy fonts for the console. (CLI output)
+ *
+ * @license     https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE  GNU GPLv2
+ * @author      Dominik Wilkowski  hi@dominik-wilkowski.com
+ * @repository  https://github.com/dominikwilkowski/cfonts
+ *
+ * Chalk
+ *   We pass on the FORCE_COLOR env var to chalk so we can force it in ci
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const chalkOriginal = require(`chalk`);
+
+// all possible level of chalk: https://github.com/chalk/chalk#chalklevel
+const level = {
+	'0': 0, // All colors disabled
+	'1': 1, // Basic 16 colors support
+	'2': 2, // ANSI 256 colors support
+	'3': 3, // Truecolor 16 million colors support
+}
+
+// We pass on the FORCE_COLOR env var to chalk so we can force it in ci
+const Chalk = new chalkOriginal.Instance({
+	...(
+		process.env.FORCE_COLOR
+			? { level: level[ process.env.FORCE_COLOR ] }
+			: null
+	)
+});
+
+
+module.exports = exports = {
+	Chalk,
+};