@phasn/prototyping-cli 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 phasn <phasn@proton.me> (https://github.com/phasn)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+### Modular CLI base for rapidly setting up interactive test and example scripts

package/examples/interactive.js

@@ -0,0 +1,7 @@
+import {API as readlineAPI}	from '../util.readline/interactive.api.js';
+import {API as consoleAPI}	from '../util.console/interactive.api.js';
+import {initRL, useAPIs}	from '../index.js';
+
+let API = {moduleName:'Readline&Console Utils'};
+API = useAPIs(API, readlineAPI, consoleAPI);
+initRL(API);

package/index.js

@@ -0,0 +1,3 @@
+export * from './util.readline/index.js';
+export * from './util.console/index.js';
+export {default} from './util.console/index.js';

package/package.json

@@ -1,6 +1,26 @@
 {
-  "name": "@phasn/prototyping-cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@phasn/prototyping-cli",
+	"version": "1.0.0",
+	"description": "Modular CLI base for rapidly setting up interactive test and example scripts",
+	"main": "index.js",
+	"type": "module",
+	"repository":{
+		"type": "git",
+		"url": "git+https://git@github.com/phasn/Prototyping-CLI.git"
+	},
+	"homepage": "https://github.com/phasn/Prototyping-CLI",
+	"scripts":{
+		"console": "node ./util.console/interactive.js",
+		"readline": "node ./util.readline/interactive.js",
+		"start": "node ./examples/interactive.js"
+	},
+	"author": "phasn <phasn@proton.me> (https://github.com/phasn)",
+	"license": "MIT",
+	"keywords":[
+		"interactive",
+		"test",
+		"cli",
+		"console",
+		"readline"
+	]
+}

package/util.console/index.js

@@ -0,0 +1,218 @@
+export const codes = {
+	//	terms should always be imperativem', not descriptive
+	//	e.g.	'underline' not		'underlined'
+	//			'blink'		not		'blinking'
+	//			'hide'		not		'hidden'
+	//	abbreviations for 'un_' should be 'x_' rather than 'u_'
+
+	r:					'\x1b[0m',		reset:					'\x1b[0m',
+		x:				'\x1b[0m',
+		res:			'\x1b[0m',
+	b:					'\x1b[1m',		bold:					'\x1b[1m',
+											bright:				'\x1b[1m',// not a good idea to think of this code as bright because it leads to messy format interactions, but most terminals implement it as this
+		'**':			'\x1b[1m',
+	f:					'\x1b[2m',		faint:					'\x1b[2m',
+		d:				'\x1b[2m',			dim:				'\x1b[2m',
+	i:					'\x1b[3m',		italic:					'\x1b[3m',
+		'*':			'\x1b[3m',
+	u:					'\x1b[4m',		underline:				'\x1b[4m',
+		'_':			'\x1b[4m',
+	blnk:				'\x1b[5m',		blink:					'\x1b[5m',
+		sblnk:			'\x1b[5m',			slowblink:			'\x1b[5m',
+	fblnk:				'\x1b[6m',		fastblink:				'\x1b[6m',
+		rblnk:			'\x1b[6m',			rapidblink:			'\x1b[6m',
+	rev:				'\x1b[7m',		reverse:				'\x1b[7m',
+	hid:				'\x1b[8m',		hide:					'\x1b[8m',
+	str:				'\x1b[9m',		strikethrough:			'\x1b[9m',
+		stt:			'\x1b[9m',
+		stk:			'\x1b[9m',			strike:				'\x1b[9m',
+		co:				'\x1b[9m',			crossout:			'\x1b[9m',
+											cross:				'\x1b[9m',
+	f0:					'\x1b[10m',		defaultfont:			'\x1b[10m',// reverts 11-20
+		fx:				'\x1b[10m',			revertfont:			'\x1b[10m',
+		xfx:			'\x1b[10m',
+	f1:					'\x1b[11m',		font1:					'\x1b[11m',
+	f2:					'\x1b[12m',		font2:					'\x1b[12m',
+	f3:					'\x1b[13m',		font3:					'\x1b[13m',
+	f4:					'\x1b[14m',		font4:					'\x1b[14m',
+	f5:					'\x1b[15m',		font5:					'\x1b[15m',
+	f6:					'\x1b[16m',		font6:					'\x1b[16m',
+	f7:					'\x1b[17m',		font7:					'\x1b[17m',
+	f8:					'\x1b[18m',		font8:					'\x1b[18m',
+	f9:					'\x1b[19m',		font9:					'\x1b[19m',
+	f10:				'\x1b[20m',		fraktur:				'\x1b[20m',
+		ff:				'\x1b[20m',			fontfraktur:		'\x1b[20m',
+											gothic:				'\x1b[20m',
+		fg:				'\x1b[20m',			fontgothic:			'\x1b[20m',
+	du:					'\x1b[21m',		doubleunderline:		'\x1b[21m',// * some terminals incorrectly use this to revert 1
+		uu:				'\x1b[21m',
+	nrm:				'\x1b[22m',		normal:					'\x1b[22m',// reverts 1 and 2
+		xb:				'\x1b[22m',			unbold:				'\x1b[22m',
+		xf:				'\x1b[22m',			unfaint:			'\x1b[22m',
+			xd:			'\x1b[22m',				undim:			'\x1b[22m',
+		reg:			'\x1b[22m',			regular:			'\x1b[22m',
+	xi:					'\x1b[23m',		unitalic:				'\x1b[23m',// reverts 3
+	xu:					'\x1b[24m',		ununderline:			'\x1b[24m',// reverts 4 and 21 (* see note by 21)
+	xblnk:				'\x1b[25m',		unblink:				'\x1b[25m',// reverts 5 and 6
+//	?:					'\x1b[26m',		unused:					'\x1b[26m',
+	xrev:				'\x1b[27m',		unreverse:				'\x1b[27m',// reverts 7
+	rvl:				'\x1b[28m',		reveal:					'\x1b[28m',// reverts 8
+		xhid:			'\x1b[28m',			unhide:				'\x1b[28m',
+	xstr:				'\x1b[29m',		unstrikethrough:		'\x1b[29m',// reverts 9
+	xstt:				'\x1b[29m',
+		xstk:			'\x1b[29m',			unstrike:			'\x1b[29m',
+		xco:			'\x1b[29m',			uncrossout:			'\x1b[29m',
+											uncross:			'\x1b[29m',
+	blk:				'\x1b[30m',		black:					'\x1b[30m',
+										red:					'\x1b[31m',
+	grn:				'\x1b[32m',		green:					'\x1b[32m',
+	ylw:				'\x1b[33m',		yellow: 				'\x1b[33m',
+	blu:				'\x1b[34m',		blue:					'\x1b[34m',
+	mgt:				'\x1b[35m',		magenta:				'\x1b[35m',
+		ppl:			'\x1b[35m',			purple:				'\x1b[35m',
+	cyn:				'\x1b[36m',		cyan:					'\x1b[36m',
+	wht:				'\x1b[37m',		white:					'\x1b[37m',
+//	#					'\x1b[38m',		customcolor				'\x1b[38m',
+	for:				'\x1b[39m',		foreground:				'\x1b[39m',// reverts 30-38 & 90-97
+	bgblk:				'\x1b[40m',		bgblack:				'\x1b[40m',
+	bgred:				'\x1b[41m',		bgred:					'\x1b[41m',
+	bggrn:				'\x1b[42m',		bggreen:				'\x1b[42m',
+	bgylw:				'\x1b[43m',		bgyellow:				'\x1b[43m',
+	bgblu:				'\x1b[44m',		bgblue:					'\x1b[44m',
+	bgmgt:				'\x1b[45m',		bgmagenta:				'\x1b[45m',
+		bgppl:			'\x1b[45m',			bgpurple:			'\x1b[45m',
+	bgcyn:				'\x1b[46m',		bgcyan:					'\x1b[46m',
+	bgwht:				'\x1b[47m',		bgwhite:				'\x1b[47m',
+//	bg#					'\x1b[48m',		custombgcolor			'\x1b[48m',
+
+//	u#					'\x1b[58m',		customunderlinecolor	'\x1b[58m',
+
+
+	lblk:				'\x1b[90m',		lightblack:				'\x1b[90m',
+	lred:				'\x1b[91m',		lightred:				'\x1b[91m',
+	lgrn:				'\x1b[92m',		lightgreen:				'\x1b[92m',
+	lylw:				'\x1b[93m',		lightyellow: 			'\x1b[93m',
+	lblu:				'\x1b[94m',		lightblue:				'\x1b[94m',
+	lmgt:				'\x1b[95m',		lightmagenta:			'\x1b[95m',
+		lppl:			'\x1b[95m',			lightpurple:		'\x1b[95m',
+	lcyn:				'\x1b[96m',		lightcyan:				'\x1b[96m',
+	lwht:				'\x1b[97m',		lightwhite:				'\x1b[97m',
+
+	bglblk:				'\x1b[100m',	bglightblack:			'\x1b[100m',
+	bglred:				'\x1b[101m',	bglightred:				'\x1b[101m',
+	bglgrn:				'\x1b[102m',	bglightgreen:			'\x1b[102m',
+	bglylw:				'\x1b[103m',	bglightyellow:			'\x1b[103m',
+	bglblu:				'\x1b[104m',	bglightblue:			'\x1b[104m',
+	bglmgt:				'\x1b[105m',	bglightmagenta:			'\x1b[105m',
+		bglppl:			'\x1b[105m',		bglightpurple:		'\x1b[105m',
+	bglcyn:				'\x1b[106m',	bglightcyan:			'\x1b[106m',
+	bglwht:				'\x1b[107m',	bglightwhite:			'\x1b[107m',
+
+		bblk:			'\x1b[90m',			brightblack:		'\x1b[90m',
+		bred:			'\x1b[91m',			brightred:			'\x1b[91m',
+		bgrn:			'\x1b[92m',			brightgreen:		'\x1b[92m',
+		bylw:			'\x1b[93m',			brightyellow: 		'\x1b[93m',
+		bblu:			'\x1b[94m',			brightblue:			'\x1b[94m',
+		bmgt:			'\x1b[95m',			brightmagenta:		'\x1b[95m',
+			bppl:		'\x1b[95m',				brightpurple:	'\x1b[95m',
+		bcyn:			'\x1b[96m',			brightcyan:			'\x1b[96m',
+		bwht:			'\x1b[97m',			brightwhite:		'\x1b[97m',
+
+		bgbblk:			'\x1b[100m',		bgbrightblack:		'\x1b[100m',
+		bgbred:			'\x1b[101m',		bgbrightred:		'\x1b[101m',
+		bgbgrn:			'\x1b[102m',		bgbrightgreen:		'\x1b[102m',
+		bgbylw:			'\x1b[103m',		bgbrightyellow:		'\x1b[103m',
+		bgbblu:			'\x1b[104m',		bgbrightblue:		'\x1b[104m',
+		bgbmgt:			'\x1b[105m',		bgbrightmagenta:	'\x1b[105m',
+			bgbppl:		'\x1b[105m',			bgbrightpurple:	'\x1b[105m',
+		bgbcyn:			'\x1b[106m',		bgbrightcyan:		'\x1b[106m',
+		bgbwht:			'\x1b[107m',		bgbrightwhite:		'\x1b[107m',
+
+
+
+// Temp for compatibility with older things because I haven't added the toLowerCase thing in this version
+			BGblk:				'\x1b[40m',		BGblack:				'\x1b[40m',
+			BGred:				'\x1b[41m',		BGred:					'\x1b[41m',
+			BGgrn:				'\x1b[42m',		BGgreen:				'\x1b[42m',
+			BGylw:				'\x1b[43m',		BGyellow:				'\x1b[43m',
+			BGblu:				'\x1b[44m',		BGblue:					'\x1b[44m',
+			BGmgt:				'\x1b[45m',		BGmagenta:				'\x1b[45m',
+				BGppl:			'\x1b[45m',			BGpurple:			'\x1b[45m',
+			BGcyn:				'\x1b[46m',		BGcyan:					'\x1b[46m',
+			BGwht:				'\x1b[47m',		BGwhite:				'\x1b[47m',
+				BGbblk:			'\x1b[100m',		BGbrightblack:		'\x1b[100m',
+				BGbred:			'\x1b[101m',		BGbrightred:		'\x1b[101m',
+				BGbgrn:			'\x1b[102m',		BGbrightgreen:		'\x1b[102m',
+				BGbylw:			'\x1b[103m',		BGbrightyellow:		'\x1b[103m',
+				BGbblu:			'\x1b[104m',		BGbrightblue:		'\x1b[104m',
+				BGbmgt:			'\x1b[105m',		BGbrightmagenta:	'\x1b[105m',
+					BGbppl:		'\x1b[105m',			BGbrightpurple:	'\x1b[105m',
+				BGbcyn:			'\x1b[106m',		BGbrightcyan:		'\x1b[106m',
+				BGbwht:			'\x1b[107m',		BGbrightwhite:		'\x1b[107m',
+};
+
+const r = codes.r;// Don't manually export this. It gets exported in '...codes'
+
+export const br = () => console.log(`${r}\n`);
+export const hr = (a,b) => {
+	let color = codes.cyan;
+	let char = '-';
+	if(a){
+		if(codes[a] && typeof codes[a]==='string') color = codes[a];
+		if(typeof a==='string' && a.length<=2) char = a;
+	}
+	if(b){
+		if(codes[b] && typeof codes[b]==='string') color = codes[b];
+		if(typeof b==='string' && b.length<=2) char = b;
+	}
+	let str = `${r}${color}--------------------------------${r}`.replaceAll('-', char);
+
+	console.log(str);
+};
+
+export const __desc = (str) => `${r}  ${codes.brightmagenta}${str}${r}`;
+export const __sntx = (str) => `${r}  ${codes.blue}>${codes.yellow} ${str}${r}`;
+export const __cmd = (str) => `${r}${codes.brightgreen}${str}${r}`;
+export const __arg = (str) => `${r}${codes.brightyellow}<${r}${codes.yellow}${str}${r}${codes.brightyellow}>${r}`;
+
+// These shouldn't need to be exported
+console.br = console.break = console.newline = console.n = console.nl = console.enter = br;
+console.hr = console.line = console.break = console.bar = console.divider = console.div = hr;
+
+// Default Methods: White text on dark background
+console.info = (str) => console.log(`${r}${codes.f}${codes.bglightwhite}${codes.blue}${codes.rev}  `, str, ` ${r}`);//
+console.warn = (str) => console.log(`${r}${codes.f}${codes.bglightwhite}${codes.yellow}${codes.rev}  `, str, ` ${r}`);//
+console.error = (str) => console.log(`${r}${codes.bglightwhite}${codes.red}${codes.rev}  `, str, ` ${r}`);//
+console.debug = (str) => console.log(`${r}${codes.f}${codes.bglightwhite}${codes.magenta}${codes.rev}  `, str, ` ${r}`);//
+
+// Custom Methods: Light text on no background
+console.alert = (str) => console.log(`${r}${codes.b}${codes.lightyellow}  `, str, ` ${r}`);//
+console.danger = (str) => console.log(`${r}${codes.b}${codes.lightred}  `, str, ` ${r}`);//
+console.success = (str) => console.log(`${r}${codes.b}${codes.lightgreen}  `, str, ` ${r}`);//
+console.help = (str) => console.log(`${r}${codes.b}${codes.lightmagenta}  `, str, ` ${r}`);//
+
+// Custom Methods: Black text on light background
+// console.alert = (str) => console.log(`${r}${codes.black}${codes.bglightyellow}  `, str, ` ${r}`);//
+// console.danger = (str) => console.log(`${r}${codes.black}${codes.bglightred}  `, str, ` ${r}`);//
+// console.success = (str) => console.log(`${r}${codes.black}${codes.bglightgreen}  `, str, ` ${r}`);//
+// console.help = (str) => console.log(`${r}${codes.black}${codes.bglightmagenta}  `, str, ` ${r}`);//
+
+// let errorfg = '255, 0, 0'
+// let errorbg = '252, 235, 235'
+// let warnfg = '92, 60, 0'
+// let warnbg = '254, 243, 220'
+
+console.warning = console.alert;
+	// No this isn't a typo. The Bootstrap name is 'warning'.
+	// It should reflect the format of the custom method, not the default method.
+
+export default{
+	codes,
+	...codes,
+	br,
+	hr,
+	__desc,
+	__sntx,
+	__cmd,
+	__arg,
+};

package/util.console/interactive.api.js

@@ -0,0 +1,190 @@
+import uC, {__cmd} from './index.js';
+
+
+export const API = {
+	commands:{
+	//	=========================
+	//	<<<<<<<< methods >>>>>>>>
+	//	=========================
+		methods:{
+			description: 'Displays each type of console logging method',
+			syntax:[`${__cmd('methods')}`],
+			execute(){
+				console.log('\n\t Modified Console Methods:');
+				console.info('console.info()');
+				console.warn('console.warn()');
+				console.error('console.error()');
+				console.debug('console.debug()');
+
+				console.log('\n\t New Console Methods:')
+				console.alert('console.alert()');
+				console.danger('console.danger()');
+				console.success('console.success()');
+				console.help('console.help()');
+
+				return console.br();
+			}
+		},
+
+	//	======================
+	//	<<<<<<<< ansi >>>>>>>>
+	//	======================
+		ansi:{
+			description: 'Display how each ANSI code from 0-130 is rendered in the current terminal',
+			syntax:[`${__cmd('ansi')}`],
+			execute(){
+				for(let i=0; i<11; i++){
+					let str = '';
+					for(let j=0; j<10; j++){
+						let n = 10 * i + j;
+						if(n>130) break;
+						str += `\x1b[0\;${n}m${n.toString().padStart(3)}`;
+					}
+					console.log(str);
+					str = '';
+				}
+				return console.br();
+			}
+		},
+
+	//	==========================
+	//	<<<<<<<< keywords >>>>>>>>
+	//	==========================
+		keywords:{
+			description: 'Lists all available formatting and color keywords',
+			syntax:[`${__cmd('keywords')}`],
+			execute(){
+				for(let col in uC.codes){
+					console.log(`${uC.r}${col.padEnd(16,' ')}${uC.codes[col]}${col.padEnd(16,' ')}\\x1b${uC.codes[col].substring(1)}${uC.r}`);
+				}
+				return console.br();
+			}
+		},
+	//	=========================
+	//	<<<<<<<< formats >>>>>>>>
+	//	=========================
+		formats:{
+			description: 'Displays the effects of each formatting code',
+			syntax:[`${__cmd('formats')}`],
+			execute(){
+				//	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+				let testStr = `${uC.r}
+	${uC.b}bold/bright${uC.r}
+	${uC.f}faint/dim${uC.r}
+	${uC.i}italicized${uC.r}
+	${uC.u}underscore${uC.r}
+	${uC.blnk}blink${uC.r}
+	${uC.fblnk}fast blink${uC.r}
+	${uC.rev}reverse${uC.r}
+	${uC.hid}hidden${uC.r}<--(hidden)
+	${uC.str}strikethrough${uC.r}
+	${uC.du}double underscore${uC.r}\n`;
+				//	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+				return console.log(testStr);
+			}
+		},
+
+	//	========================
+	//	<<<<<<<< colors >>>>>>>>
+	//	========================
+		colors:{
+			description: 'Misc. color test 1',
+			syntax:[`${__cmd('colors')}`],
+			aliases:[
+				'colors0',
+				'colors1',
+			],
+			execute(){
+				//	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+				let testStr = `${uC.r}
+	${uC.b}${uC.red}red░█${uC.r}       ${uC.red}red░█${uC.r}       ${uC.f}${uC.red}red░█${uC.r}
+	${uC.b}${uC.yellow}yellow░█${uC.r}    ${uC.yellow}yellow░█${uC.r}    ${uC.f}${uC.yellow}yellow░█${uC.r}
+	${uC.b}${uC.green}green░█${uC.r}     ${uC.green}green░█${uC.r}     ${uC.f}${uC.green}green░█${uC.r}
+	${uC.b}${uC.cyan}cyan░█${uC.r}      ${uC.cyan}cyan░█${uC.r}      ${uC.f}${uC.cyan}cyan░█${uC.r}
+	${uC.b}${uC.blue}blue░█${uC.r}      ${uC.blue}blue░█${uC.r}      ${uC.f}${uC.blue}blue░█${uC.r}
+	${uC.b}${uC.magenta}magenta░█${uC.r}   ${uC.magenta}magenta░█${uC.r}   ${uC.f}${uC.magenta}magenta░█${uC.r}
+	${uC.b}${uC.black}black░█${uC.r}     ${uC.black}black░█${uC.r}     ${uC.f}${uC.black}black░█${uC.r}
+	${uC.b}${uC.white}white░█${uC.r}     ${uC.white}white░█${uC.r}     ${uC.f}${uC.white}white░█${uC.r}
+
+	${uC.b}${uC.bgred}BGred░█${uC.r}     ${uC.bgred}BGred░█${uC.r}     ${uC.f}${uC.bgred}BGred░█${uC.r}
+	${uC.b}${uC.bgyellow}BGyellow░█${uC.r}  ${uC.bgyellow}BGyellow░█${uC.r}  ${uC.f}${uC.bgyellow}BGyellow░█${uC.r}
+	${uC.b}${uC.bggreen}BGgreen░█${uC.r}   ${uC.bggreen}BGgreen░█${uC.r}   ${uC.f}${uC.bggreen}BGgreen░█${uC.r}
+	${uC.b}${uC.bgcyan}BGcyan░█${uC.r}    ${uC.bgcyan}BGcyan░█${uC.r}    ${uC.f}${uC.bgcyan}BGcyan░█${uC.r}
+	${uC.b}${uC.bgblue}BGblue░█${uC.r}    ${uC.bgblue}BGblue░█${uC.r}    ${uC.f}${uC.bgblue}BGblue░█${uC.r}
+	${uC.b}${uC.bgmagenta}BGmagenta░█${uC.r} ${uC.bgmagenta}BGmagenta░█${uC.r} ${uC.f}${uC.bgmagenta}BGmagenta░█${uC.r}
+	${uC.b}${uC.bgblack}BGblack░█${uC.r}   ${uC.bgblack}BGblack░█${uC.r}   ${uC.f}${uC.bgblack}BGblack░█${uC.r}
+	${uC.b}${uC.bgwhite}BGwhite░█${uC.r}   ${uC.bgwhite}BGwhite░█${uC.r}   ${uC.f}${uC.bgwhite}BGwhite░█${uC.r}\n`;
+				//	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+				return console.log(testStr);
+			}
+		},
+
+	//	=========================
+	//	<<<<<<<< colors2 >>>>>>>>
+	//	=========================
+		colors2:{
+			description: 'Misc. color test 2',
+			syntax:[`${__cmd('colors2')}`],
+			execute(){
+				//	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+				let testStr = `${uC.r}
+	${uC.b}${uC.red}░${uC.r}${uC.red}░${uC.r}${uC.f}${uC.red}░${uC.r}${uC.b}${uC.bgred}░${uC.r}${uC.bgred}░${uC.r}${uC.f}${uC.bgred}░${uC.r}${uC.b}${uC.reverse}${uC.red}░${uC.r}${uC.reverse}${uC.red}░${uC.r}${uC.f}${uC.reverse}${uC.red}░${uC.r}${uC.b}${uC.reverse}${uC.bgred}░${uC.r}${uC.reverse}${uC.bgred}░${uC.r}${uC.f}${uC.reverse}${uC.bgred}░${uC.r}
+	${uC.b}${uC.yellow}░${uC.r}${uC.yellow}░${uC.r}${uC.f}${uC.yellow}░${uC.r}${uC.b}${uC.bgyellow}░${uC.r}${uC.bgyellow}░${uC.r}${uC.f}${uC.bgyellow}░${uC.r}${uC.b}${uC.reverse}${uC.yellow}░${uC.r}${uC.reverse}${uC.yellow}░${uC.r}${uC.f}${uC.reverse}${uC.yellow}░${uC.r}${uC.b}${uC.reverse}${uC.bgyellow}░${uC.r}${uC.reverse}${uC.bgyellow}░${uC.r}${uC.f}${uC.reverse}${uC.bgyellow}░${uC.r}
+	${uC.b}${uC.green}░${uC.r}${uC.green}░${uC.r}${uC.f}${uC.green}░${uC.r}${uC.b}${uC.bggreen}░${uC.r}${uC.bggreen}░${uC.r}${uC.f}${uC.bggreen}░${uC.r}${uC.b}${uC.reverse}${uC.green}░${uC.r}${uC.reverse}${uC.green}░${uC.r}${uC.f}${uC.reverse}${uC.green}░${uC.r}${uC.b}${uC.reverse}${uC.bggreen}░${uC.r}${uC.reverse}${uC.bggreen}░${uC.r}${uC.f}${uC.reverse}${uC.bggreen}░${uC.r}
+	${uC.b}${uC.cyan}░${uC.r}${uC.cyan}░${uC.r}${uC.f}${uC.cyan}░${uC.r}${uC.b}${uC.bgcyan}░${uC.r}${uC.bgcyan}░${uC.r}${uC.f}${uC.bgcyan}░${uC.r}${uC.b}${uC.reverse}${uC.cyan}░${uC.r}${uC.reverse}${uC.cyan}░${uC.r}${uC.f}${uC.reverse}${uC.cyan}░${uC.r}${uC.b}${uC.reverse}${uC.bgcyan}░${uC.r}${uC.reverse}${uC.bgcyan}░${uC.r}${uC.f}${uC.reverse}${uC.bgcyan}░${uC.r}
+	${uC.b}${uC.blue}░${uC.r}${uC.blue}░${uC.r}${uC.f}${uC.blue}░${uC.r}${uC.b}${uC.bgblue}░${uC.r}${uC.bgblue}░${uC.r}${uC.f}${uC.bgblue}░${uC.r}${uC.b}${uC.reverse}${uC.blue}░${uC.r}${uC.reverse}${uC.blue}░${uC.r}${uC.f}${uC.reverse}${uC.blue}░${uC.r}${uC.b}${uC.reverse}${uC.bgblue}░${uC.r}${uC.reverse}${uC.bgblue}░${uC.r}${uC.f}${uC.reverse}${uC.bgblue}░${uC.r}
+	${uC.b}${uC.magenta}░${uC.r}${uC.magenta}░${uC.r}${uC.f}${uC.magenta}░${uC.r}${uC.b}${uC.bgmagenta}░${uC.r}${uC.bgmagenta}░${uC.r}${uC.f}${uC.bgmagenta}░${uC.r}${uC.b}${uC.reverse}${uC.magenta}░${uC.r}${uC.reverse}${uC.magenta}░${uC.r}${uC.f}${uC.reverse}${uC.magenta}░${uC.r}${uC.b}${uC.reverse}${uC.bgmagenta}░${uC.r}${uC.reverse}${uC.bgmagenta}░${uC.r}${uC.f}${uC.reverse}${uC.bgmagenta}░${uC.r}
+	${uC.b}${uC.black}░${uC.r}${uC.black}░${uC.r}${uC.f}${uC.black}░${uC.r}${uC.b}${uC.bgblack}░${uC.r}${uC.bgblack}░${uC.r}${uC.f}${uC.bgblack}░${uC.r}${uC.b}${uC.reverse}${uC.black}░${uC.r}${uC.reverse}${uC.black}░${uC.r}${uC.f}${uC.reverse}${uC.black}░${uC.r}${uC.b}${uC.reverse}${uC.bgblack}░${uC.r}${uC.reverse}${uC.bgblack}░${uC.r}${uC.f}${uC.reverse}${uC.bgblack}░${uC.r}
+	${uC.b}${uC.white}░${uC.r}${uC.white}░${uC.r}${uC.f}${uC.white}░${uC.r}${uC.b}${uC.bgwhite}░${uC.r}${uC.bgwhite}░${uC.r}${uC.f}${uC.bgwhite}░${uC.r}${uC.b}${uC.reverse}${uC.white}░${uC.r}${uC.reverse}${uC.white}░${uC.r}${uC.f}${uC.reverse}${uC.white}░${uC.r}${uC.b}${uC.reverse}${uC.bgwhite}░${uC.r}${uC.reverse}${uC.bgwhite}░${uC.r}${uC.f}${uC.reverse}${uC.bgwhite}░${uC.r}\n`;
+				//	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+				return console.log(testStr);
+			}
+		},
+
+	//	=========================
+	//	<<<<<<<< colors3 >>>>>>>>
+	//	=========================
+		colors3:{
+			description: 'Misc. color test 3 (same as #2 but with solid block characters)',
+			syntax:[`${__cmd('colors3')}`],
+			execute(){
+				//	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+				let testStr = `${uC.r}
+	${uC.b}${uC.red}█${uC.r}${uC.red}█${uC.r}${uC.f}${uC.red}█${uC.r}${uC.b}${uC.bgred}█${uC.r}${uC.bgred}█${uC.r}${uC.f}${uC.bgred}█${uC.r}${uC.b}${uC.reverse}${uC.red}█${uC.r}${uC.reverse}${uC.red}█${uC.r}${uC.f}${uC.reverse}${uC.red}█${uC.r}${uC.b}${uC.reverse}${uC.bgred}█${uC.r}${uC.reverse}${uC.bgred}█${uC.r}${uC.f}${uC.reverse}${uC.bgred}█${uC.r}
+	${uC.b}${uC.yellow}█${uC.r}${uC.yellow}█${uC.r}${uC.f}${uC.yellow}█${uC.r}${uC.b}${uC.bgyellow}█${uC.r}${uC.bgyellow}█${uC.r}${uC.f}${uC.bgyellow}█${uC.r}${uC.b}${uC.reverse}${uC.yellow}█${uC.r}${uC.reverse}${uC.yellow}█${uC.r}${uC.f}${uC.reverse}${uC.yellow}█${uC.r}${uC.b}${uC.reverse}${uC.bgyellow}█${uC.r}${uC.reverse}${uC.bgyellow}█${uC.r}${uC.f}${uC.reverse}${uC.bgyellow}█${uC.r}
+	${uC.b}${uC.green}█${uC.r}${uC.green}█${uC.r}${uC.f}${uC.green}█${uC.r}${uC.b}${uC.bggreen}█${uC.r}${uC.bggreen}█${uC.r}${uC.f}${uC.bggreen}█${uC.r}${uC.b}${uC.reverse}${uC.green}█${uC.r}${uC.reverse}${uC.green}█${uC.r}${uC.f}${uC.reverse}${uC.green}█${uC.r}${uC.b}${uC.reverse}${uC.bggreen}█${uC.r}${uC.reverse}${uC.bggreen}█${uC.r}${uC.f}${uC.reverse}${uC.bggreen}█${uC.r}
+	${uC.b}${uC.cyan}█${uC.r}${uC.cyan}█${uC.r}${uC.f}${uC.cyan}█${uC.r}${uC.b}${uC.bgcyan}█${uC.r}${uC.bgcyan}█${uC.r}${uC.f}${uC.bgcyan}█${uC.r}${uC.b}${uC.reverse}${uC.cyan}█${uC.r}${uC.reverse}${uC.cyan}█${uC.r}${uC.f}${uC.reverse}${uC.cyan}█${uC.r}${uC.b}${uC.reverse}${uC.bgcyan}█${uC.r}${uC.reverse}${uC.bgcyan}█${uC.r}${uC.f}${uC.reverse}${uC.bgcyan}█${uC.r}
+	${uC.b}${uC.blue}█${uC.r}${uC.blue}█${uC.r}${uC.f}${uC.blue}█${uC.r}${uC.b}${uC.bgblue}█${uC.r}${uC.bgblue}█${uC.r}${uC.f}${uC.bgblue}█${uC.r}${uC.b}${uC.reverse}${uC.blue}█${uC.r}${uC.reverse}${uC.blue}█${uC.r}${uC.f}${uC.reverse}${uC.blue}█${uC.r}${uC.b}${uC.reverse}${uC.bgblue}█${uC.r}${uC.reverse}${uC.bgblue}█${uC.r}${uC.f}${uC.reverse}${uC.bgblue}█${uC.r}
+	${uC.b}${uC.magenta}█${uC.r}${uC.magenta}█${uC.r}${uC.f}${uC.magenta}█${uC.r}${uC.b}${uC.bgmagenta}█${uC.r}${uC.bgmagenta}█${uC.r}${uC.f}${uC.bgmagenta}█${uC.r}${uC.b}${uC.reverse}${uC.magenta}█${uC.r}${uC.reverse}${uC.magenta}█${uC.r}${uC.f}${uC.reverse}${uC.magenta}█${uC.r}${uC.b}${uC.reverse}${uC.bgmagenta}█${uC.r}${uC.reverse}${uC.bgmagenta}█${uC.r}${uC.f}${uC.reverse}${uC.bgmagenta}█${uC.r}
+	${uC.b}${uC.black}█${uC.r}${uC.black}█${uC.r}${uC.f}${uC.black}█${uC.r}${uC.b}${uC.bgblack}█${uC.r}${uC.bgblack}█${uC.r}${uC.f}${uC.bgblack}█${uC.r}${uC.b}${uC.reverse}${uC.black}█${uC.r}${uC.reverse}${uC.black}█${uC.r}${uC.f}${uC.reverse}${uC.black}█${uC.r}${uC.b}${uC.reverse}${uC.bgblack}█${uC.r}${uC.reverse}${uC.bgblack}█${uC.r}${uC.f}${uC.reverse}${uC.bgblack}█${uC.r}
+	${uC.b}${uC.white}█${uC.r}${uC.white}█${uC.r}${uC.f}${uC.white}█${uC.r}${uC.b}${uC.bgwhite}█${uC.r}${uC.bgwhite}█${uC.r}${uC.f}${uC.bgwhite}█${uC.r}${uC.b}${uC.reverse}${uC.white}█${uC.r}${uC.reverse}${uC.white}█${uC.r}${uC.f}${uC.reverse}${uC.white}█${uC.r}${uC.b}${uC.reverse}${uC.bgwhite}█${uC.r}${uC.reverse}${uC.bgwhite}█${uC.r}${uC.f}${uC.reverse}${uC.bgwhite}█${uC.r}\n`;
+				//	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+				return console.log(testStr);
+			}
+		},
+
+	//	==============================
+	//	<<<<<<<< duplicateCmd >>>>>>>>
+	//	==============================
+		duplicateCmd:{
+			description: 'Both util.readline and util.console api files have a command with this name. The order you listed the APIs to use/merge will determine which one is kept and which will be overwritten.',
+			syntax:[`${__cmd('duplicateCmd')}`],
+			aliases:[
+				'duplicate',
+				'dupe',
+				'dupeCmd'
+			],
+			execute(){
+				console.log(uC.r);
+				console.info(`Both util.readline and util.console command API files include a command with this name.${uC.r}\n`);
+				console.info(`In the example script that uses both command APIs, the order in which the APIs are listed in the include/merge function will determine which one is kept and which will be overwritten.${uC.r}\n`);
+
+				console.log(`This version of the command originated from ${uC.bcyn}${uC.i}interactive.api.js${uC.r} in ${uC.bgrn}${uC.i}${uC.b}util.console${uC.r}.${uC.r}`);
+				console.log(`The version from ${uC.bmgt}${uC.i}interactive.api.js${uC.r} in ${uC.bred}${uC.i}util.readline${uC.r} either wasn't included or was overwritten by this version.${uC.r}\n`);
+			}
+		},
+	}
+};
+
+
+export default API;

package/util.console/interactive.js

@@ -0,0 +1,6 @@
+import {API as mainAPI}		from './interactive.api.js';
+import {initRL, useAPIs}	from '../index.js';
+
+let API = {moduleName:'Console Utils'};
+API = useAPIs(API, mainAPI);
+initRL(API);

package/util.readline/api.base.js

@@ -0,0 +1,74 @@
+import uC, {__desc, __sntx, __cmd, __arg} from '../util.console/index.js';
+
+
+export const API = {
+	get(arg){return this[arg];},
+
+	commands:{
+	//	======================
+	//	<<<<<<<< help >>>>>>>>
+	//	======================
+		help:{
+			description: 'Return a list of commands if no command name is specified.\n\tIf a command is specified, returns information about that command.',
+			syntax:[
+				`${__cmd('help')}`,
+				`${__cmd('help')} ${__arg('COMMAND')}`,
+			],
+			aliases:[
+				'-h',
+				'--help',
+			],
+			execute(cmdName){
+				let commands = API.get('commands');
+				let tab = API.get('tab');
+				let moduleName = API.get('moduleName');
+
+				if(cmdName){
+					let match = commands[Object.keys(commands).find(key => key.toLowerCase() === cmdName.toLowerCase())];
+					if(match){
+						if(!match.description) match.description = 'No description provided';
+						console.log(__desc(match.description));
+						console.log(`${tab()}${uC.cyan}${uC.u}Syntax${uC.xu}:${uC.r}`);
+						for(let line of match.syntax) console.log(`${tab()}${__sntx(line)}`);
+						console.br();
+						return;
+					}else{
+						return console.error(`ERROR: '${uC.u}${cmdName}${uC.xu}' is not a known command.`);
+					}
+				}
+
+				let line2 = 'Commands';
+
+				let width = Math.max(moduleName.length, line2.length);
+				for(let cmdName in commands) width = Math.max(width, cmdName.length);
+				width += 4;
+
+				const center = (str, lineWidth) => str.padStart(str.length + (Math.floor((lineWidth - str.length) / 2)), ' ');
+
+				const divider = `${tab()}${uC.lcyn}${''.padStart(width, '-')}${uC.r}`;
+
+				console.log(divider);
+				console.log(`${tab()}${uC.lgrn}${center(moduleName, width)}${uC.r}`);
+				console.log(`${tab()}${center(line2, width)}:`);
+				console.log(divider);
+				// for(let cmdName in commands) if(!commands[cmdName].alias) console.log(`${tab()}${uC.r}${uC.ylw}> ${uC.b}${cmdName}${uC.r}`);
+				for(let cmdName in commands) console.log(`${tab()}${uC.r}${uC.ylw}> ${uC.b}${cmdName}${uC.r}`);
+				console.log(divider);
+			},
+		},
+
+	//	=======================
+	//	<<<<<<<< clear >>>>>>>>
+	//	=======================
+		clear:{
+			description: 'Clears the console',
+			syntax:[`${__cmd('clear')}`,],
+			execute(){
+				console.clear();
+			}
+		},
+	}
+};
+
+
+export default API;

package/util.readline/index.js

@@ -0,0 +1,96 @@
+import readline			from 'node:readline';
+import process			from 'node:process';
+import fs				from 'node:fs';
+import path				from 'node:path';
+import uC				from '../util.console/index.js';
+import {API as BaseAPI}	from './api.base.js';
+import {resolveCommand}	from './resolveCommand.js';
+
+const tabSize = 4;
+
+
+const tab = () => ''.padStart(tabSize, ' ');
+
+const getPackageJSON = () => {
+	let cwd = process.cwd();
+	let filePath = path.join(cwd, 'package.json');
+	if(fs.existsSync(filePath)){
+		let packageJSON = JSON.parse(fs.readFileSync(filePath, 'utf8'));
+		if(packageJSON.config){
+			if(packageJSON.config.cli_name)		packageJSON.cli_name = packageJSON.config.cli_name;
+			if(packageJSON.config.cli_prefix)	packageJSON.cli_prefix = packageJSON.config.cli_prefix;
+		}
+		return packageJSON;
+	}
+	return {};
+};
+
+const getContexts = (ImportedAPI) => {
+	let packageJSON = getPackageJSON();
+
+	let moduleName =	ImportedAPI.moduleName	|| ImportedAPI.name		|| process.env.CLI_NAME	|| process.env.npm_package_config_cli_name	|| process.env.npm_package_name	|| packageJSON.cli_name		|| packageJSON.name	|| 'Name not found';
+	let prefix =		process.env.CLI_PREFIX	|| process.env.npm_package_config_cli_prefix	|| packageJSON.cli_prefix					|| '/';// || undefined;
+	if(prefix==='help') throw new Error(`ERROR: API prefixes cannot be ${uC.u}'help'${uC.xu}`);
+
+	return {moduleName, prefix};
+};
+
+
+export const initRL = (ImportedAPI) => {
+	console.log(uC.r);
+	if(ImportedAPI.commands.help || ImportedAPI.commands.clear || ImportedAPI.commands['-h'] || ImportedAPI.commands['--help']) throw new Error(`ERROR: Test API commands cannot be named ${uC.u}'help'${uC.xu} or ${uC.u}'clear'${uC.xu} or share their aliases`);
+
+	let {moduleName, prefix} = getContexts(ImportedAPI);
+
+	BaseAPI.tab = tab;
+	BaseAPI.moduleName = moduleName;
+	BaseAPI.commands = {
+		...BaseAPI.commands,
+		...ImportedAPI.commands,
+	};
+
+	const rl = readline.createInterface({
+		input: process.stdin,
+		output: process.stdout,
+		prompt: `${uC.r}${uC.lgrn}${moduleName}${uC.wht}:${uC.blu}~${uC.r}${uC.for}$ `,
+		terminal: true, tabSize
+	});
+	//rl.setPrompt(`${uC.r}${uC.lgrn}${moduleName}${uC.wht}:${uC.blu}~${uC.r}${uC.for}$ `);
+
+	rl.prompt();
+
+	rl.on('line', (line) => {
+		//	If there is a prefix, but the user does not use it (possibly because they don't know it), this will return a fallback message
+		if(prefix && line.startsWith('help'))	console.info(`Prefix lines with '${prefix}' to execute a command.\nFor a list of commands, enter "${uC.i}/help${uC.xi}".\nYou can also enter "${uC.i}/help ${uC.b}<COMMAND>${uC.xb}${uC.xi}" for info about a specific command.`);
+		resolveCommand(line, BaseAPI.commands, prefix);
+		rl.prompt();
+	})
+	.on('close', () => {
+		console.log(`Closing CLI...${uC.r}`);
+		if(ImportedAPI.overrideProcessExit!==false)	process.exit(0);
+	});
+
+	return rl;
+};
+
+
+export const useAPIs = (...APIsToInclude) => {
+	if(!Array.isArray(APIsToInclude)) APIsToInclude = [APIsToInclude];
+
+	const compiledAPI = {};
+
+	Object.assign(compiledAPI, ...APIsToInclude);
+	for(let API of APIsToInclude){
+		if(API.commands!==undefined) Object.assign(compiledAPI.commands, API.commands);
+	}
+
+	for(let cmdName in compiledAPI.commands){
+		let cmd = compiledAPI.commands[cmdName];
+		cmd.execute = cmd.execute.bind(compiledAPI);
+	};
+
+	return compiledAPI;
+};
+
+
+export default initRL;

package/util.readline/interactive.api.js

@@ -0,0 +1,45 @@
+import uC, {__cmd} from '../util.console/index.js';
+
+
+export const API = {
+	commands:{
+	//	============================
+	//	<<<<<<<< importTest >>>>>>>>
+	//	============================
+		importTest:{
+			description: 'Test function to see if this gets imported correctly',
+			syntax:[`${__cmd('importTest')}`],
+			execute(){
+				console.br();
+				console.line();
+				console.log('Command was imported successfully');
+				console.line();
+				console.br();
+			}
+		},
+
+	//	==============================
+	//	<<<<<<<< duplicateCmd >>>>>>>>
+	//	==============================
+		duplicateCmd:{
+			description: 'Both util.readline and util.console api files have a command with this name. The order you listed the APIs to use/merge will determine which one is kept and which will be overwritten.',
+			syntax:[`${__cmd('duplicateCmd')}`],
+			aliases:[
+				'duplicate',
+				'dupe',
+				'dupeCmd'
+			],
+			execute(){
+				console.log(uC.r);
+				console.info(`Both util.readline and util.console command API files include a command with this name.${uC.r}\n`);
+				console.info(`In the example script that uses both command APIs, the order in which the APIs are listed in the include/merge function will determine which one is kept and which will be overwritten.${uC.r}\n`);
+
+				console.log(`This version of the command originated from ${uC.bcyn}${uC.i}interactive.api.js${uC.r} in ${uC.bgrn}${uC.i}${uC.b}util.readline${uC.r}.${uC.r}`);
+				console.log(`The version from ${uC.bmgt}${uC.i}interactive.api.js${uC.r} in ${uC.bred}${uC.i}util.console${uC.r} either wasn't included or was overwritten by this version.${uC.r}\n`);
+			}
+		},
+	}
+};
+
+
+export default API;

package/util.readline/interactive.js

@@ -0,0 +1,6 @@
+import {API as exampleAPI}	from './interactive.api.js';
+import {initRL, useAPIs}	from '../index.js';
+
+let API = {moduleName:'Readline Utils'};
+API = useAPIs(API, exampleAPI);
+initRL(API);

package/util.readline/resolveCommand.js

@@ -0,0 +1,31 @@
+import uC from '../util.console/index.js';
+
+export const resolveCommand = (line, commands, prefix='') => {
+	//	If there is a prefix, remove it from the input before continuing
+	if(line.startsWith(prefix)){
+		let [cmd, ...args] = line.trim().substring(prefix.length).split(/\s+/);
+
+		// If cmd is blank, but there are args (i.e. if someone puts a space after the prefix), set cmd to the first arg and shift all args down one
+		if(cmd === '' && args.length){
+			cmd = args[0];
+			args.shift();
+		}
+
+		if(cmd){
+			let match = commands[
+				Object.keys(commands)
+				.find(key => {
+					return(
+						key.toLowerCase() === cmd.toLowerCase() ||
+						( commands[key].aliases && commands[key].aliases.find(alias => alias.toLowerCase() === cmd.toLowerCase()) )
+					)
+				})
+			];
+
+			if(match)	match.execute(...args);
+			else		console.error(`ERROR: '${uC.u}${cmd}${uC.xu}' is not a known command.`);
+		}
+	}
+};
+
+export default resolveCommand;