cfonts-node 2.10.1

package/src/Log.js

@@ -0,0 +1,42 @@
+/***************************************************************************************************************************************************************
+ *
+ * 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
+ *
+ * Log
+ *   Logging prettiness
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const { Chalk } = require('./Chalk.js');
+
+
+/**
+ * Logging prettiness
+ *
+ * @type {object}
+ */
+const Log = {
+	/**
+	 * Print error message to console.
+	 *
+	 * @param  {string} text - The sting you want to log
+	 */
+	error: ( text ) => {
+		text = text.replace( /(?:\r\n|\r|\n)/g, '\n       ' ); // indent each line
+
+		console.error(`\n ${ Chalk.bold.red('Ouch:') } ${ text }\n`);
+	},
+};
+
+
+module.exports = exports = {
+	Log,
+};

package/src/Options.js

@@ -0,0 +1,162 @@
+/***************************************************************************************************************************************************************
+ *
+ * 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
+ *
+ * Options
+ *   Merge user settings with default options
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const {
+	COLORS,
+	BGCOLORS,
+	FONTFACES,
+} = require('./constants.js');
+
+
+/**
+ * The options store with getter and setter methods
+ *
+ * @type {Object}
+ */
+const Options = {
+	store: {},
+
+	reset() {
+		const defaults = {
+			font: 'block',
+			align: 'left',
+			colors: [],
+			background: 'transparent',
+			letterSpacing: 1,
+			lineHeight: 1,
+			space: true,
+			maxLength: 0,
+			gradient: false,
+			independentGradient: false,
+			transitionGradient: false,
+			env: 'node',
+		};
+
+		this.store = { ...defaults }; // cloning
+	},
+
+	/**
+	 * Get the current options
+	 *
+	 * @return {object} - Our options as hey are stored in our object
+	 */
+	get get() {
+		return this.store;
+	},
+
+	/**
+	 * Merge settings into our options object
+	 *
+	 * @param  {object}                  options                     - The settings object
+	 * @param  {string}                  options.font                - Font face, Default 'block'
+	 * @param  {string}                  options.align               - Text alignment, Default: 'left'
+	 * @param  {array}                   options.colors              - Colors for font, Default: []
+	 * @param  {string}                  options.background          - Chalk color string for background, Default 'Black'
+	 * @param  {string}                  options.backgroundColor     - Alias for background
+	 * @param  {number}                  options.letterSpacing       - Space between letters, Default: set by selected font face
+	 * @param  {number}                  options.lineHeight          - Space between lines, Default: 1
+	 * @param  {boolean}                 options.space               - Output space before and after output, Default: true
+	 * @param  {number}                  options.maxLength           - Maximum amount of characters per line, Default width of console window
+	 * @param  {(string|array|boolean)}  options.gradient            - Gradient color pair, Default: false
+	 * @param  {boolean}                 options.independentGradient - A switch to calculate gradient per line or not
+	 * @param  {boolean}                 options.transitionGradient  - A switch for transition gradients
+	 * @param  {string}                  options.env                 - The environment we run cfonts in
+	 * @param  {object}                  options.allowedColors       - All allowed font colors
+	 * @param  {object}                  options.allowedBG           - All allowed background colors
+	 * @param  {object}                  options.allowedFont         - All allowed fontfaces
+	 */
+	set set({
+		font = '',
+		align,
+		colors,
+		background,
+		backgroundColor,
+		letterSpacing,
+		lineHeight,
+		space,
+		maxLength,
+		gradient,
+		independentGradient,
+		transitionGradient,
+		env,
+		allowedColors = COLORS,
+		allowedBG = BGCOLORS,
+		allowedFont = FONTFACES,
+	}) {
+		this.store.font = font !== ''
+			? allowedFont[ font.toLowerCase() ] || font
+			: this.store.font;
+
+		this.store.align = align !== undefined
+			? align.toLowerCase()
+			: this.store.align;
+
+		this.store.colors = Array.isArray( colors )
+			? colors.map( color => allowedColors[ color.toLowerCase() ] || color )
+			: this.store.colors;
+
+		const bg = backgroundColor || background;
+		this.store.background = bg !== undefined
+			? allowedBG[ bg.toLowerCase() ] || bg
+			: this.store.background;
+
+		this.store.letterSpacing = letterSpacing !== undefined
+			? parseInt( letterSpacing.toString() )
+			: font.toLowerCase() === 'console'
+				? 0
+				: this.store.letterSpacing;
+
+		this.store.lineHeight = lineHeight !== undefined
+			? parseInt( lineHeight.toString() )
+			: font.toLowerCase() === 'console'
+				? 0
+				: this.store.lineHeight;
+
+		this.store.space = typeof space === 'boolean'
+			? space
+			: this.store.space;
+
+		this.store.maxLength = maxLength !== undefined
+			? maxLength
+			: this.store.maxLength;
+
+		this.store.gradient = gradient !== undefined && typeof gradient !== 'boolean'
+			? Array.isArray( gradient )
+				? gradient
+				: gradient.split(',')
+			: gradient === false
+				? false
+				: this.store.gradient;
+
+		this.store.independentGradient = independentGradient !== undefined
+			? independentGradient
+			: this.store.independentGradient;
+
+		this.store.transitionGradient = transitionGradient !== undefined
+			? transitionGradient
+			: this.store.transitionGradient;
+
+		this.store.env = env !== undefined
+			? env
+			: this.store.env;
+	},
+};
+
+
+module.exports = exports = {
+	Options,
+};

package/src/ParseArgs.js

@@ -0,0 +1,82 @@
+/***************************************************************************************************************************************************************
+ *
+ * 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
+ *
+ * ParseArgs
+ *   Parse cli arguments into a nice object
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const { AddShortcuts } = require('./AddShortcuts.js');
+const { CLIOPTIONS } = require('./constants.js');
+const { Debugging } = require('./Debugging.js');
+
+
+/**
+ * Parse cli arguments into a nice object
+ *
+ * @param  {object} inputOptions - All possible options registered for this app
+ * @param  {array}  inputArgs    - The arguments given to us in our cli, default: process.argv
+ *
+ * @return {object}              - An object of all options with at least their default values
+ */
+const ParseArgs = ( inputOptions = CLIOPTIONS, inputArgs = process.argv ) => {
+	const parsedArgs = {
+		text: inputArgs[ 2 ],
+	};
+
+	// create defaults
+	Object.keys( inputOptions ).forEach( option => {
+		const name = option.replace( '--', '' );
+
+		parsedArgs[ name ] = inputOptions[ option ].default;
+	});
+
+	if( inputArgs[ 2 ] === '--help' || inputArgs[ 2 ] === '-h' ) {
+		parsedArgs.help = true;
+	}
+
+	if( inputArgs[ 2 ] === '--version' || inputArgs[ 2 ] === '-v' ) {
+		parsedArgs.version = true;
+	}
+
+	const args = inputArgs.splice( 3 ); // the first two are node specific, the third is our text
+
+	const options = AddShortcuts( inputOptions );
+
+	for( let index = 0; args.length > index; index ++ ) {
+		const option = options[ args[ index ] ];
+
+		if( option ) {
+			const name = option._name.replace( '--', '' );
+
+			if( option.options !== undefined ) {
+				index ++;
+				const value = args[ index ];
+
+				parsedArgs[ name ] = value;
+			}
+			else {
+				parsedArgs[ name ] = true;
+			}
+		}
+		else {
+			Debugging.report( `The cli argument ${ args[ index ] } was not found and ignored`, 2 );
+		}
+	}
+
+	return parsedArgs;
+};
+
+
+module.exports = exports = {
+	ParseArgs,
+};

package/src/Render.js

@@ -0,0 +1,257 @@
+/***************************************************************************************************************************************************************
+ *
+ * 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
+ *
+ * Render
+ *   Main method to get the ANSI output for a string
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const { AddLetterSpacing } = require('./AddLetterSpacing.js');
+const { RenderConsole } = require('./RenderConsole.js');
+const { Debugging, DEBUG } = require('./Debugging.js');
+const { PaintGradient } = require('./Gradient.js');
+const { CharLength } = require('./CharLength.js');
+const { CheckInput } = require('./CheckInput.js');
+const { CleanInput } = require('./CleanInput.js');
+const { AlignText } = require('./AlignText.js');
+const { AddLine } = require('./AddLine.js');
+const { AddChar } = require('./AddChar.js');
+const { Options } = require('./Options.js');
+const { GetFont } = require('./GetFont.js');
+const { CHARS } = require('./constants.js');
+const { Color } = require('./Color.js');
+const { Size } = require('./Size.js');
+const { Log } = require('./Log.js');
+
+
+/**
+ * Main method to get the ANSI output for a string
+ *
+ * @param  {string}  input       - The string you want to write out
+ * @param  {object}  SETTINGS    - Settings object
+ * @param  {boolean} debug       - A flag to enable debug mode
+ * @param  {number}  debuglevel  - The debug level we want to show
+ * @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
+ *
+ * @typedef  {(object|boolean)} ReturnObject
+ *   @property {string}  string  - The pure string for output with all line breaks
+ *   @property {array}   array   - Each line of output in an array
+ *   @property {number}  lines   - The number of lines
+ *   @property {object}  options - All options used
+ *
+ * @return {ReturnObject}        - CLI output of INPUT to be consoled out
+ */
+const Render = ( input, SETTINGS = {}, debug = DEBUG.enabled, debuglevel = DEBUG.level, size = Size ) => {
+	Debugging.report(`Running render`, 1);
+
+	DEBUG.enabled = debug;
+	DEBUG.level = debuglevel;
+
+	const INPUT = CleanInput( input, CHARS );
+	Options.reset();
+	Options.set = SETTINGS;
+	const OPTIONS = Options.get;
+
+	let output = [];   // for output where each line is an output line
+	let lines = 0;     // for counting each line
+	let FONTFACE = {}; // scoping the fontface object higher for fonts with just one color
+
+	const _isGoodHuman = CheckInput( INPUT, OPTIONS.font, OPTIONS.colors, OPTIONS.background, OPTIONS.align, OPTIONS.gradient, OPTIONS.transitionGradient, OPTIONS.env );
+	if( !_isGoodHuman.pass ) {
+		Log.error( _isGoodHuman.message );
+
+		return false;
+	}
+
+	// the gradient option supersedes the color options
+	if( OPTIONS.gradient ) {
+		OPTIONS.colors = [];
+	}
+
+
+	// display an overview of options if debug flag is enabled
+	if( DEBUG.enabled ) {
+		let outOption = `OPTIONS:\n  Text: ${ INPUT }`;
+
+		for( let key in OPTIONS ) {
+			outOption += `\n  Options.${ key }: ${ OPTIONS[ key ] }`;
+		}
+
+		Debugging.report( outOption, 3 );
+	}
+
+
+	if( OPTIONS.env === 'browser' ) {
+		size = { ...size }; // we clone so we don't make changes to this object across multiple instances
+		size.width = OPTIONS.maxLength === 0 ? 999999999999 : OPTIONS.maxLength;
+	}
+
+
+	if( OPTIONS.font === 'console' ) { // console fontface is pretty easy to process
+		FONTFACE = {
+			colors: 1,
+			lines: 1,
+		};
+
+		const consoleOutput = RenderConsole( INPUT, OPTIONS, size );
+
+		output = consoleOutput.output;
+		lines = consoleOutput.lines;
+	}
+	else { // all other fontfaces need the font-file and some more work
+		FONTFACE = GetFont( OPTIONS.font );
+
+		if( !FONTFACE ) {
+			Log.error( `Font file for the font "${ OPTIONS.font }" could not be found.\nTry reinstalling this package.` );
+
+			return false;
+		}
+
+		// setting the letterspacing preference from font face if there is no user overwrite
+		if( SETTINGS.letterSpacing === undefined ) {
+			Debugging.report( `Looking up letter spacing from font face`, 1 );
+
+			let width = 0;
+
+			FONTFACE.letterspace.forEach( item => {
+				let char = item.replace( /(<([^>]+)>)/ig, '' ); // get character and strip color infos
+
+				if( width < char.length ) {
+					width = char.length;
+				}
+			});
+
+			Debugging.report(`Letter spacing set to font face default: "${ width }"`, 2);
+			OPTIONS.letterSpacing = width;
+		}
+
+		let lineLength = CharLength( FONTFACE.buffer, FONTFACE.lines, OPTIONS ); // count each output character per line and start with the buffer
+		let maxChars = 0; // count each character we print for maxLength option
+
+		output = AddLine( [], FONTFACE.lines, FONTFACE.buffer, OPTIONS.lineHeight ); // create first lines with buffer
+		lines ++;
+
+		output = AddLetterSpacing( output, FONTFACE.lines, FONTFACE.letterspace, FONTFACE.colors, OPTIONS.colors, OPTIONS.letterSpacing ); // add letter spacing to the beginning
+		lineLength += CharLength( FONTFACE.letterspace, FONTFACE.lines, OPTIONS ) * OPTIONS.letterSpacing; // count the space for the letter spacing
+
+		for( let i = 0; i < INPUT.length; i++ ) { // iterate through the message
+			let CHAR = INPUT.charAt( i ).toUpperCase(); // the current character we convert, only upper case is supported at this time
+			let lastLineLength = lineLength; // we need the lineLength for alignment before we look up if the next char fits
+
+			Debugging.report(`Character found in font: "${ CHAR }"`, 2);
+
+			if( CHAR !== `|` ) { // what will the line length be if we add the next char?
+				lineLength += CharLength( FONTFACE.chars[ CHAR ], FONTFACE.lines, OPTIONS ); // get the length of this character
+				lineLength += CharLength( FONTFACE.letterspace, FONTFACE.lines, OPTIONS ) * OPTIONS.letterSpacing; // new line, new line length
+			}
+
+			// jump to next line after OPTIONS.maxLength characters or when line break is found or the console windows would have ran out of space
+			if( maxChars >= OPTIONS.maxLength && OPTIONS.maxLength != 0 || CHAR === `|` || lineLength > size.width ) {
+				lines ++;
+
+				Debugging.report(
+					`NEWLINE: maxChars: ${ maxChars }, ` +
+					`OPTIONS.maxLength: ${ OPTIONS.maxLength }, ` +
+					`CHAR: ${ CHAR }, ` +
+					`lineLength: ${ lineLength }, ` +
+					`Size.width: ${ size.width } `, 2
+				);
+
+				if( OPTIONS.env === 'node' ) {
+					output = AlignText( output, lastLineLength, FONTFACE.lines, OPTIONS.align, size ); // calculate alignment based on lineLength
+				}
+
+				lineLength = CharLength( FONTFACE.buffer, FONTFACE.lines, OPTIONS ); // new line: new line length
+				lineLength += CharLength( FONTFACE.letterspace, FONTFACE.lines, OPTIONS ) * OPTIONS.letterSpacing; // each new line starts with letter spacing
+
+				if( CHAR !== `|` ) { // if this is a character and not a line break
+					lineLength += CharLength( FONTFACE.chars[ CHAR ], FONTFACE.lines, OPTIONS ); // get the length of this character
+					lineLength += CharLength( FONTFACE.letterspace, FONTFACE.lines, OPTIONS ) * OPTIONS.letterSpacing; // add letter spacing at the end
+				}
+
+				maxChars = 0; // new line, new maxLength goal
+
+				output = AddLine( output, FONTFACE.lines, FONTFACE.buffer, OPTIONS.lineHeight ); // adding new line
+				// add letter spacing to the beginning
+				output = AddLetterSpacing( output, FONTFACE.lines, FONTFACE.letterspace, FONTFACE.colors, OPTIONS.colors, OPTIONS.letterSpacing );
+			}
+
+			Debugging.report(`lineLength at: "${ lineLength }"`, 2);
+
+			if( CHAR !== `|` ) {
+				maxChars++; // counting all printed characters
+				output = AddChar( CHAR, output, FONTFACE.lines, FONTFACE.chars, FONTFACE.colors, OPTIONS.colors ); // add new character
+				output = AddLetterSpacing( output, FONTFACE.lines, FONTFACE.letterspace, FONTFACE.colors, OPTIONS.colors, OPTIONS.letterSpacing );
+			}
+		}
+
+		if( OPTIONS.env === 'node' ) {
+			output = AlignText( output, lineLength, FONTFACE.lines, OPTIONS.align, size ); // alignment last line
+		}
+	}
+
+	if( OPTIONS.gradient ) {
+		output = PaintGradient({
+			output,
+			gradient: OPTIONS.gradient,
+			lines,
+			lineHeight: OPTIONS.lineHeight,
+			fontLines: FONTFACE.lines,
+			independentGradient: OPTIONS.independentGradient,
+			transitionGradient: OPTIONS.transitionGradient,
+		});
+	}
+
+	if( OPTIONS.space ) { // add space
+		if( OPTIONS.align === 'top' ) {
+			output[ output.length - 1 ] = `${ output[ output.length - 1 ] }\n\n\n\n`;
+		}
+		else if( OPTIONS.align === 'bottom' ) {
+			output[ 0 ] = `\n\n\n\n${ output[ 0 ] }`;
+		}
+		else {
+			output[ 0 ] = `\n\n${ output[ 0 ] }`;
+			output[ output.length - 1 ] = `${ output[ output.length - 1 ] }\n\n`;
+		}
+	}
+
+	if( OPTIONS.background !== 'transparent' && OPTIONS.env === 'node' ) {
+		const { open: openNew, close: closeNew } = Color( OPTIONS.background, true );
+
+		output[ 0 ] = `${ openNew }\n${ output[ 0 ] }`;
+		output[ output.length - 1 ] = `${ output[ output.length - 1 ] }${ closeNew }`;
+	}
+
+	let write = output.join( OPTIONS.env === 'node' ? `\n` : '<br>' );
+
+	if( OPTIONS.env === 'browser' ) {
+		const { open: bgColor } = Color( OPTIONS.background, true );
+
+		write = `<div style="font-family:monospace;white-space:pre;text-align:${ OPTIONS.align };max-width:100%;overflow:scroll;background:${ bgColor ? bgColor : 'transparent' }">` +
+		`${ write }` +
+		`</div>`;
+	}
+
+	return {
+		string: write,
+		array: output,
+		lines: lines,
+		options: OPTIONS,
+	}
+};
+
+
+module.exports = exports = {
+	Render,
+};

package/src/RenderConsole.js

@@ -0,0 +1,102 @@
+/***************************************************************************************************************************************************************
+ *
+ * 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
+ *
+ * RenderConsole
+ *   Render our input with the console font
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const { AlignText } = require('./AlignText.js');
+const { Colorize } = require('./Colorize.js');
+const { Size } = require('./Size.js');
+
+
+/**
+ * Render our input with the console font
+ *
+ * @param  {string}  INPUT       - The string you want to write out
+ * @param  {object}  OPTIONS     - All user options
+ * @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
+ *
+ * @typedef  {object}  ReturnObject
+ *   @property {array}   output  - An array of each line of the output
+ *   @property {number}  lines   - The count of line breaks
+ *
+ * @return {ReturnObject}        - An object with the output and the line breaks
+ */
+const RenderConsole = ( INPUT, OPTIONS, size = Size ) => {
+	const width = OPTIONS.maxLength < size.width && OPTIONS.maxLength !== 0
+		? OPTIONS.maxLength
+		: size.width;
+	let lines = 0;
+	let output = [];
+	let i = 0;
+
+	let space = '';
+	if( OPTIONS.letterSpacing > 0 ) {
+		space = ' '.repeat( OPTIONS.letterSpacing );
+	}
+
+	// we have to add our letter spacing first
+	const outputLines = INPUT
+		.replace( /(?:\r\n|\r|\n)/g, '|' )
+		.split( '|' )
+		.map( line =>
+			line
+				.split('')
+				.join( space )
+	);
+
+	// now we check each line for it's length and split them if too long
+	while( i < outputLines.length ) {
+		let line = outputLines[ i ];
+
+		if( line.length > width ) {
+			outputLines[ i ] = line.slice( 0, width );
+			outputLines.splice( i + 1, 0, line.slice( width ) );
+			line = outputLines[ i ];
+		}
+
+		if( OPTIONS.colors[ 0 ] === 'candy' ) {
+			output.push( line
+				.split('')
+				.map( character => Colorize( character, 1, OPTIONS.colors ) )
+				.join('')
+			);
+		}
+		else {
+			output.push( Colorize( line, 1, OPTIONS.colors ) );
+		}
+
+		if( OPTIONS.env !== 'browser' ) {
+			output = AlignText( output, line.length, 1, OPTIONS.align, size );
+		}
+		if( i !== outputLines.length - 1 ) {
+			output = [ ...output, ...Array( OPTIONS.lineHeight ).fill('') ];
+		}
+
+		lines++;
+		i++;
+	}
+
+	return {
+		output,
+		lines,
+	};
+};
+
+
+module.exports = exports = {
+	RenderConsole,
+};

package/src/Say.js

@@ -0,0 +1,50 @@
+/***************************************************************************************************************************************************************
+ *
+ * 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
+ *
+ * Say
+ *   Print to console
+ *
+ **************************************************************************************************************************************************************/
+
+'use strict';
+
+const { Debugging, DEBUG } = require('./Debugging.js');
+const { Render } = require('./Render.js');
+const { Size } = require('./Size.js');
+
+
+/**
+ * Print to console
+ *
+ * @param  {string}  INPUT       - The string you want to write out
+ * @param  {object}  SETTINGS    - Settings object
+ * @param  {boolean} debug       - A flag to enable debug mode
+ * @param  {number}  debuglevel  - The debug level we want to show
+ * @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
+ */
+const Say = ( INPUT, SETTINGS = {}, debug = DEBUG.enabled, debuglevel = DEBUG.level, size = Size ) => {
+	Debugging.report(`Running say`, 1);
+
+	DEBUG.enabled = debug;
+	DEBUG.level = debuglevel;
+
+	const write = Render( INPUT, SETTINGS, debug, debuglevel, size );
+
+	if( write ) {
+		console.log( write.string ); // write out
+	}
+};
+
+
+module.exports = exports = {
+	Say,
+};