trailmix/utilities

Repository of utilities for deno written in typescript for trailmix🌤🦕🍣😼

CONTRIBUTE - learn how to help 🧪👉💩🙏 💯👆

Usage

🌈 Colors

Color string output easily with ANSI.

Simple

// import fns and style helpers
import {
  messageByFn,
  messageByFnSpread,
  messageByString,
  messageByStringSpread,
  random,
  randomOpts,
  randomStyleFn,
  randomStyleString,
  styles as s,
} from "https://deno.land/x/trailmix@1.0.5/mod.ts";

// random StyleFn Message Functions
console.log(messageByFn("hello", [s.cyan, s.bgRed])); // cyan text, red BG
console.log(messageByFnSpread("test", s.yellow, s.bgRed)); // yellow text, red BG
// random Style Functions
console.log(randomStyleFn("emphasis")); // get a random emphasis typeof StyleFn {(str:string) => string}
console.log(randomStyleString("color")); // get a random color string typeof Style
// random StyleString Message Functions
console.log(messageByString("hello", [randomStyleString("color")])); // random text color
console.log(messageByStringSpread("hello", randomStyleString("bgColor"))); // random background color
console.log(messageByFnSpread("hello", s[randomStyleString("emphasis")])); // call style list with random style fn
console.log(random("hello")); // get random style on this string (50% chance of color/bg/emphasis)
console.log(random("hello", { color: true })); // get random color on this string
console.log(random("hello", randomOpts({ color: true }))); // get random color 100%, (50% chance for others)

Complex

// import the class and style helpers
import {
  Color as C,
  stylesMap as sM,
} from "https://deno.land/x/trailmix@1.0.5/mod.ts";
import type { Style } from "https://deno.land/x/trailmix@1.0.5/mod.ts";

// you can use defined or anon functions
function test(str: string) {
  return str + "defined function";
}
const byFnConfAlpha = [
  C.randomStyleFn(), // randoms return a random text color by default
  test,
  C.randomStyleFn("bgColor"),
  (str: string) => {
    // anon functions can be used
    return str + C.random("anon function", { emphasis: true });
  },
];
const rConf = { color: true, bgColor: true, emphasis: false };
const byFnConfBeta = [
  sM.color.brightBlue, // stylesMap is ordered by color|bgColor|emphasis
  (str: string) => {
    return str + "anon function";
  },
  sM.color.yellow,
  sM.bgColor.bgBrightCyan,
  test,
  sM.emphasis.strikethrough,
  C.styleMap.dim, // styles is all in a map
  sM.bgColor.bgBrightYellow,
  test,
  (str: string) => {
    return "anon function" + str;
  },
  C.styleMap.bgBrightYellow,
];
const _sList: Style[] = ["cyan", "bgMagenta", "underline"]; // list of Style strings
console.log(C.messageByFnSpread("test", ...byFnConfAlpha)); // spread StyleFns
console.log(C.messageByFnSpread("test", ...byFnConfBeta));
console.log(
  C.messageByString("this is not a spring spread", [
    "cyan",
    "bgMagenta",
    "underline",
  ]),
); // no spread
console.log(
  C.messageByStringSpread(
    "a spring spread",
    "green",
    "bgBlack",
    "strikethrough",
  ),
); // spreading Style strings
console.log(
  C.messageByStringSpread("a spring spread again with a var", ..._sList),
);
console.log(C.random("test some string", rConf)); // random function

🔋 Config

Ingest configuration from env variables, file, or flags.

Simple

import {
  EnvConfig,
  FlagConfig,
} from "https://deno.land/x/trailmix@1.0.5/mod.ts";

Deno.env.set("DEFAULT_TEST1", "val1"); // set example env var in DEFAULT namespace
// slurp up env vars
console.log(EnvConfig.parseEnv()); // should have { test1: "val1" }
// something more complex
Deno.env.set("DEFAULT_LOG_CONSOLE_LEVEL", "DEBUG"); // set log level in DEFAULT namespace
console.log(EnvConfig.parseEnv()); // should have { test1: "val1", log: { console: { level: "DEBUG" } } }
// this is good for cmd line arguments (--logConsoleLevel DEBUG)
console.log(FlagConfig.parseFlags({
  logConsoleLevel: "DEBUG",
  test1: "val1",
  test2: "true",
  test3: ["val1", "val2"],
  test4AB: "false",
  test5TestwordTestphraseAB: "hello",
})); // should have same as above

Complex

import {
  EnvConfig,
  FileConfig,
  FlagConfig,
} from "https://deno.land/x/trailmix@1.0.5/mod.ts";

// set env first is if it was there before runtime
Deno.env.set("TRILOM_LOG_CONSOLE_LEVEL", "DEBUG");
// lets use our own namespace with a config file
await Deno.writeFile(
  Deno.cwd() + "/trilom.config.ts",
  new TextEncoder().encode(
    'export default {log: {console: {format: "json"}}};',
  ),
);
// slurp flags
const flagCfg = new FlagConfig({
  namespace: "TRILOM",
  flags: { logConsoleColor: "false" },
});
// scope env vars
const envCfg = new EnvConfig(flagCfg);
// suck in file
const cfg = await new FileConfig(envCfg).parseFile();

console.log(flagCfg); // will give a log config with {console: { color: false } }
console.log(envCfg); // will give a log config with {console: { color: false, level: "DEBUG" } }
console.log(cfg); // will give a log config with {console: { color: false, level: "DEBUG", format: "json" } }

🪵 Log

make logging grape again with color

Simple

import { Log, random as r } from "https://deno.land/x/trailmix@1.0.5/mod.ts";
Log.error("basic britches👖"); // in red "[default] basic britches👖"
// pass any number of arguments
Log.success(
  "test",
  { error: "really?" },
  "s",
  20,
  90071992547409990071992547404545990n,
  true,
  null,
  undefined,
  Symbol("key"),
  new Error("test"),
  Log.success("noArgs"),
  Log.error("args", "failure"),
); // in green  "[default] success"
Log.error("error", "trust me, its 👌"); //
Log.success(
  "silly " + r("r") + r("a") + r("n") + r("d") + r("o") + r("m") + " strang",
);

Complex

import {
  EnvConfig,
  FlagConfig,
  Log,
} from "https://deno.land/x/trailmix@1.0.5/mod.ts";

// make a logger with flags
const l = await new Log(
  "default",
  new FlagConfig({
    flags: {
      logConsoleLevel: "DEBUG",
      logConsoleFormat: "json",
      logFileEnabled: true,
      logFilePath: ".",
      logFileLevel: "DEBUG",
      logFileFormat: "string",
    },
  }).log,
).init();
// now log, 5 console json messages, and 5 string file messages
l.success("success");
l.error("error");
l.warn("warn");
l.info("info");
l.debug("debug");

// make a test logger with env for deDEBUG
Deno.env.set("DEFAULT_LOG_CONSOLE_LEVEL", "DEBUG");
const lNew = await new Log(
  "test",
  new EnvConfig().log,
).init();
// now log, 6 console string messages
lNew.success("success");
lNew.error("error");
lNew.warn("warn");
lNew.info("info");
lNew.debug("debug");

🕰 Watch

Watch and react to changes of files.

🌐 common

a collection of micro-utilities

alphaBET

Use color, and table to build a table of 26 rows with 26 random styled letter in each row.

import {
  random as r,
  resetTable,
} from "https://deno.land/x/trailmix@1.0.5/mod.ts";
import type { Table } from "https://deno.land/x/trailmix@1.0.5/mod.ts";

const alpha = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
const tR: string[][] = [];
for (const a of Array(10).keys()) {
  let m = "";
  for (const _a of alpha) {
    m += r(_a);
  }
  tR.push([m + "\n"]);
}
resetTable({ table: tR as Table, maxColWidth: 100 }).render();