sketch: shapers and colors

Author: chase-moskal

s/colors/colorful.ts

@@ -0,0 +1,18 @@
+
+import {codes} from "./parts/codes.js"
+
+export type Colors = typeof colorful
+
+export const colorful = {
+	none: (s: string) => s,
+	...<{[key in keyof typeof codes]: (s: string) => string}>(
+		Object.fromEntries(
+			Object.entries(codes)
+				.map(([key, code]) => [
+					key,
+					(s: string) => `${code}${s}${codes.reset}`,
+				])
+		)
+	),
+}
+

s/colors/colorless.ts

@@ -0,0 +1,17 @@
+
+import {Colors} from "./colorful.js"
+import {codes} from "./parts/codes.js"
+
+export const colorless = {
+	none: (s: string) => s,
+	...<{[key in keyof typeof codes]: (s: string) => string}>(
+		Object.fromEntries(
+			Object.entries(codes)
+				.map(([key]) => [
+					key,
+					(s: string) => s,
+				])
+		)
+	),
+} as Colors
+

s/colors/parts/codes.ts

@@ -0,0 +1,56 @@
+
+export const codes = Object.freeze({
+
+	// regular colors
+	black: "\u001b[30m",
+	red: "\u001b[31m",
+	green: "\u001b[32m",
+	yellow: "\u001b[33m",
+	blue: "\u001b[34m",
+	magenta: "\u001b[35m",
+	cyan: "\u001b[36m",
+	white: "\u001b[37m",
+
+	// bright colors
+	brightBlack: "\u001b[90m",
+	brightRed: "\u001b[91m",
+	brightGreen: "\u001b[92m",
+	brightYellow: "\u001b[93m",
+	brightBlue: "\u001b[94m",
+	brightMagenta: "\u001b[95m",
+	brightCyan: "\u001b[96m",
+	brightWhite: "\u001b[97m",
+
+	// background colors
+	bgBlack: "\u001b[40m",
+	bgRed: "\u001b[41m",
+	bgGreen: "\u001b[42m",
+	bgYellow: "\u001b[43m",
+	bgBlue: "\u001b[44m",
+	bgMagenta: "\u001b[45m",
+	bgCyan: "\u001b[46m",
+	bgWhite: "\u001b[47m",
+
+	// bright background colors
+	bgBrightBlack: "\u001b[100m",
+	bgBrightRed: "\u001b[101m",
+	bgBrightGreen: "\u001b[102m",
+	bgBrightYellow: "\u001b[103m",
+	bgBrightBlue: "\u001b[104m",
+	bgBrightMagenta: "\u001b[105m",
+	bgBrightCyan: "\u001b[106m",
+	bgBrightWhite: "\u001b[107m",
+
+	// styles
+	bold: "\u001b[1m",
+	dim: "\u001b[2m",
+	italic: "\u001b[3m",
+	underline: "\u001b[4m",
+	inverse: "\u001b[7m",
+	hidden: "\u001b[8m",
+	strikethrough: "\u001b[9m",
+
+	// reset
+	reset: "\u001b[0m",
+})
+

s/colors/parts/color-fns.ts

@@ -0,0 +1,40 @@
+
+import {codes} from "./codes.js"
+
+export function uncolor(s: string) {
+	return s.replace(
+		/[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
+		"",
+	)
+}
+
+export function colorHex(hex: string) {
+	hex = hex.replace(/^#/, "")
+	let bigint: number
+	let r: number
+	let g: number
+	let b: number
+
+	if (hex.length === 3)
+		bigint = parseInt(hex.split('').map(c => c + c).join(''), 16)
+	else if (hex.length === 6)
+		bigint = parseInt(hex, 16)
+	else
+		throw new Error('Invalid hex color')
+
+	r = (bigint >> 16) & 255
+	g = (bigint >> 8) & 255
+	b = bigint & 255
+	return colorRgb(r, g, b)
+}
+
+export function colorRgb(r: number, g: number, b: number) {
+	const code = `\u001b[38;2;${r};${g};${b}m`
+	return (s: string) => `${code}${s}${codes.reset}`
+}
+
+export function colorBgRgb(r: number, g: number, b: number) {
+	const code = `\u001b[48;2;${r};${g};${b}m`
+	return (s: string) => `${code}${s}${codes.reset}`
+}
+

s/example.test.ts

@@ -32,20 +32,26 @@ await Science.run({
 		}),
 	}),
 
-	"transforms": Science.suite({
+	"shapers": Science.suite({
 		"custom prefix": test(async() => {
 			const mock = new MockTarget()
 			const logger = new Logger()
 				.setTarget(mock)
-				.setPalette(Logger.palettes.plain())
-				.addTransform(() => ({
+				.addShaper(() => ({
 					stdout: items => ["stdout:", ...items],
 					stderr: items => ["stderr:", ...items],
 				}))
+
+			expect(mock.stdout.spy.calls.length).is(0)
+			expect(mock.stderr.spy.calls.length).is(0)
+
 			logger.log("hello world!")
-			console.log(mock.getSpyStdout(0))
 			expect(mock.stdout.spy.calls.length).is(1)
 			expect(mock.getSpyStdout(0)).is("stdout: hello world!")
+
+			logger.error("uh oh")
+			expect(mock.stderr.spy.calls.length).is(1)
+			expect(mock.getSpyStderr(0)).is("stderr: uh oh")
 		}),
 	}),
 })

s/logger.ts

@@ -1,44 +1,51 @@
 
 import {Target} from "./targets/target.js"
+import {Shaper} from "./shapers/shaper.js"
+import {denoTarget} from "./targets/deno.js"
 import {nodeTarget} from "./targets/node.js"
-import {Palette} from "./palettes/palette.js"
-import {plainPalette} from "./palettes/plain.js"
+import {colorless} from "./colors/colorless.js"
 import {consoleTarget} from "./targets/console.js"
-import {Transformer} from "./transforms/transform.js"
-import {timestampTransform} from "./transforms/timestamp.js"
+import {isColorSupported} from "./utils/supports.js"
+import {colorful, Colors} from "./colors/colorful.js"
+import {timestampShaper} from "./shapers/timestamp.js"
 
 export class Logger {
-	static palettes = {
-		plain: plainPalette,
-	}
-
 	static targets = {
+		deno: denoTarget,
 		node: nodeTarget,
 		console: consoleTarget,
 	}
 
-	static transforms = {
-		timestamp: timestampTransform,
+	static colors = {
+		colorful: () => colorful,
+		colorless: () => colorless,
+		auto: () => isColorSupported()
+			? colorful
+			: colorless,
+	}
+
+	static shapers = {
+		timestamp: timestampShaper,
 	}
 
-	palette: Palette = {}
+	colors: Colors = Logger.colors.auto()
 	target = consoleTarget()
-	transformers: Transformer[] = []
+	shapers: Shaper[] = []
 
 	log(...items: any[]) {
-		for (const transform of this.transformers)
+		for (const transform of this.shapers)
 			items = transform(this).stdout(items)
 		this.target.stdout(items)
 	}
 
 	error(...items: any[]) {
-		for (const transform of this.transformers)
+		for (const transform of this.shapers)
 			items = transform(this).stderr(items)
 		this.target.stderr(items)
 	}
 
-	setPalette(palette: Palette) {
-		this.palette = palette
+	setColors(colors: Colors) {
+		this.colors = colors
 		return this
 	}
 
@@ -47,8 +54,8 @@ export class Logger {
 		return this
 	}
 
-	addTransform(transformer: Transformer) {
-		this.transformers.push(transformer)
+	addShaper(shaper: Shaper) {
+		this.shapers.push(shaper)
 		return this
 	}
 }

s/palettes/palette.ts

@@ -0,0 +1,14 @@
+
+import {Colors} from "../colors/colorful.js"
+
+export type ShaperContext = {
+	colors: Colors
+}
+
+export type Shaper = (context: ShaperContext) => ShapeFns
+
+export type ShapeFns = {
+	stdout: (items: any[]) => any[]
+	stderr: (items: any[]) => any[]
+}
+