namejam 0.1.0

package/README.md

@@ -0,0 +1,97 @@
+# namejam
+
+Generate funny, unique usernames.
+
+```
+spooky-gremlin
+caffeinated-axolotl
+lurking-zephon
+flummoxed-mothman
+```
+
+## Install
+
+```sh
+npm install namejam
+# or
+yarn add namejam
+```
+
+Requires Node.js ≥ 22.6.0.
+
+## Library
+
+```ts
+import { generateName } from "namejam";
+
+generateName();
+// "chaotic-raccoon"
+
+generateName({ style: "adj-adj-noun", casing: "pascal" });
+// "UnhingedCursedGoblin"
+
+generateName({ style: "adj-tech", casing: "camel", suffix: 4 });
+// "bewilderedNexon8312"
+
+generateName({ style: "verb-noun", separator: "_", casing: "uppercase" });
+// "LURKING_WENDIGO"
+```
+
+### `generateName(options?)`
+
+Returns a `string`.
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `style` | `Style` | `"adj-noun"` | Word pattern |
+| `separator` | `string` | `"-"` | String placed between words |
+| `casing` | `Casing` | `"lowercase"` | Casing applied to the result |
+| `suffix` | `number` | — | Append N random digits |
+
+### Styles
+
+| Style | Example |
+|-------|---------|
+| `adj-noun` | `spooky-gremlin` |
+| `adj-adj-noun` | `cursed-feral-raccoon` |
+| `verb-noun` | `haunting-wombat` |
+| `noun-noun` | `pickle-warlock` |
+| `adj-tech` | `chaotic-nexon` |
+| `tech` | `zephon` |
+
+### Casings
+
+| Casing | Example |
+|--------|---------|
+| `lowercase` | `spooky-gremlin` |
+| `uppercase` | `SPOOKY-GREMLIN` |
+| `title` | `Spooky-Gremlin` |
+| `pascal` | `SpookyGremlin` |
+| `camel` | `spookyGremlin` |
+
+> For `pascal` and `camel`, `separator` is ignored — words are concatenated directly.
+
+## CLI
+
+```sh
+npx namejam
+npx namejam --style adj-adj-noun --casing pascal --count 5
+npx namejam --style verb-noun --separator _ --suffix 4
+npx namejam --style tech --count 10
+```
+
+```
+Usage: namejam [options]
+
+  --style <style>      adj-noun | adj-adj-noun | verb-noun | noun-noun | adj-tech | tech
+  --separator <sep>    Word separator string  (default: -)
+  --casing <casing>    lowercase | uppercase | camel | pascal | title  (default: lowercase)
+  --suffix <digits>    Append N random digits
+  --count <n>          Print N names, one per line  (default: 1)
+  -h, --help           Show help
+  -v, --version        Show version
+```
+
+## License
+
+MIT

package/dist/cli.js

@@ -0,0 +1,419 @@
+#!/usr/bin/env -S node --strip-types
+//#region src/words/adjectives.ts
+const adjectives = [
+	"Accursed",
+	"Arcane",
+	"Befuddled",
+	"Bewildered",
+	"Blursed",
+	"Bogus",
+	"Caffeinated",
+	"Chaotic",
+	"Chunky",
+	"Cracked",
+	"Crunchy",
+	"Cryptic",
+	"Cursed",
+	"Damp",
+	"Deranged",
+	"Disheveled",
+	"Doomed",
+	"Elusive",
+	"Ethereal",
+	"Feral",
+	"Flummoxed",
+	"Flustered",
+	"Forbidden",
+	"Frantic",
+	"Furious",
+	"Glitchy",
+	"Gobsmacked",
+	"Goofy",
+	"Grumpy",
+	"Hapless",
+	"Haunted",
+	"Hollering",
+	"Invisible",
+	"Irate",
+	"Janky",
+	"Jittery",
+	"Klutzy",
+	"Lanky",
+	"Listless",
+	"Luminous",
+	"Lurking",
+	"Majestic",
+	"Maniacal",
+	"Manic",
+	"Mystical",
+	"Nefarious",
+	"Nervy",
+	"Notorious",
+	"Oblivious",
+	"Ominous",
+	"Ornery",
+	"Panicked",
+	"Peculiar",
+	"Phantom",
+	"Plucky",
+	"Prickly",
+	"Querulous",
+	"Rabid",
+	"Rambling",
+	"Reckless",
+	"Restless",
+	"Rogue",
+	"Scruffy",
+	"Smol",
+	"Sneaky",
+	"Snarky",
+	"Soggy",
+	"Spicy",
+	"Spooky",
+	"Suspicious",
+	"Tangled",
+	"Thunderous",
+	"Turbulent",
+	"Uncanny",
+	"Unhinged",
+	"Vexed",
+	"Volatile",
+	"Wacky",
+	"Wobbly",
+	"Zealous"
+];
+//#endregion
+//#region src/words/nouns.ts
+const nouns = [
+	"Armadillo",
+	"Axolotl",
+	"Banshee",
+	"Basilisk",
+	"Blobfish",
+	"Boggart",
+	"Capybara",
+	"Chimera",
+	"Coyote",
+	"Cryptid",
+	"Ferret",
+	"Fetch",
+	"Flamingo",
+	"Gargoyle",
+	"Gecko",
+	"Goblin",
+	"Gremlin",
+	"Hedgehog",
+	"Imp",
+	"Jackalope",
+	"Kelpie",
+	"Kraken",
+	"Lemur",
+	"Mantis",
+	"Mongoose",
+	"Mothman",
+	"Narwhal",
+	"Okapi",
+	"Opossum",
+	"Pangolin",
+	"Penguin",
+	"Platypus",
+	"Poltergeist",
+	"Porcupine",
+	"Quokka",
+	"Raccoon",
+	"Revenant",
+	"Salamander",
+	"Specter",
+	"Tapir",
+	"Tardigrade",
+	"Thunderbird",
+	"Toad",
+	"Vulture",
+	"Walrus",
+	"Wendigo",
+	"Wombat",
+	"Wraith",
+	"Wyrm",
+	"Yak",
+	"Anomaly",
+	"Artifact",
+	"Bandit",
+	"Bauble",
+	"Biscuit",
+	"Blender",
+	"Burrito",
+	"Carbuncle",
+	"Cassette",
+	"Cauldron",
+	"Chalice",
+	"Cipher",
+	"Cloak",
+	"Contraption",
+	"Doohickey",
+	"Dumpling",
+	"Enigma",
+	"Fiasco",
+	"Gizmo",
+	"Grimoire",
+	"Harbinger",
+	"Lantern",
+	"Maverick",
+	"Menace",
+	"Monocle",
+	"Muffin",
+	"Noodle",
+	"Paradox",
+	"Parchment",
+	"Pickle",
+	"Pretzel",
+	"Relic",
+	"Rogue",
+	"Ruckus",
+	"Scroll",
+	"Sigil",
+	"Spatula",
+	"Talisman",
+	"Thingamajig",
+	"Toaster",
+	"Vagrant",
+	"Waffle",
+	"Warlock",
+	"Widget",
+	"Wizard"
+];
+//#endregion
+//#region src/words/tech.ts
+const tech = [
+	"Axiom",
+	"Axton",
+	"Byton",
+	"Cipher",
+	"Cyron",
+	"Daxon",
+	"Dexon",
+	"Draxon",
+	"Exon",
+	"Hexar",
+	"Hexon",
+	"Helix",
+	"Ionex",
+	"Kryox",
+	"Kronos",
+	"Kronox",
+	"Lyron",
+	"Matrix",
+	"Naxon",
+	"Neoron",
+	"Nexar",
+	"Nexon",
+	"Nexus",
+	"Omicron",
+	"Phazon",
+	"Photex",
+	"Photon",
+	"Praxon",
+	"Proton",
+	"Pulsar",
+	"Quantum",
+	"Quasar",
+	"Synthex",
+	"Synthos",
+	"Tachyon",
+	"Vector",
+	"Vertex",
+	"Vexar",
+	"Vexon",
+	"Vorex",
+	"Vorton",
+	"Vortex",
+	"Xaeon",
+	"Xyron",
+	"Zenon",
+	"Zephon",
+	"Zeron",
+	"Zython"
+];
+//#endregion
+//#region src/words/verbs.ts
+const verbs = [
+	"Banishing",
+	"Bumbling",
+	"Careening",
+	"Conjuring",
+	"Devouring",
+	"Enchanting",
+	"Fleeing",
+	"Fumbling",
+	"Glitching",
+	"Haunting",
+	"Howling",
+	"Jinxing",
+	"Lumbering",
+	"Lurking",
+	"Menacing",
+	"Napping",
+	"Obliterating",
+	"Pillaging",
+	"Questing",
+	"Rambling",
+	"Rampaging",
+	"Scheming",
+	"Shambling",
+	"Stampeding",
+	"Stumbling",
+	"Tinkering",
+	"Unleashing",
+	"Vanishing",
+	"Wobbling",
+	"Yelling"
+];
+//#endregion
+//#region src/format.ts
+function titleCase(word) {
+	return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
+}
+function applyFormat(words, casing, separator, suffix) {
+	let result;
+	switch (casing) {
+		case "lowercase":
+			result = words.map((w) => w.toLowerCase()).join(separator);
+			break;
+		case "uppercase":
+			result = words.map((w) => w.toUpperCase()).join(separator);
+			break;
+		case "title":
+			result = words.map(titleCase).join(separator);
+			break;
+		case "pascal":
+			result = words.map(titleCase).join("");
+			break;
+		case "camel": {
+			const [first, ...rest] = words.map(titleCase);
+			result = (first ?? "").toLowerCase() + rest.join("");
+			break;
+		}
+	}
+	return result + suffix;
+}
+//#endregion
+//#region src/generate.ts
+function pickUnique(arr, n) {
+	const copy = [...arr];
+	for (let i = 0; i < n; i++) {
+		const j = i + Math.floor(Math.random() * (copy.length - i));
+		[copy[i], copy[j]] = [copy[j], copy[i]];
+	}
+	return copy.slice(0, n);
+}
+function buildWords(style) {
+	switch (style) {
+		case "adj-noun": return [pickUnique(adjectives, 1)[0], pickUnique(nouns, 1)[0]];
+		case "adj-adj-noun": {
+			const [adj1, adj2] = pickUnique(adjectives, 2);
+			return [
+				adj1,
+				adj2,
+				pickUnique(nouns, 1)[0]
+			];
+		}
+		case "verb-noun": return [pickUnique(verbs, 1)[0], pickUnique(nouns, 1)[0]];
+		case "noun-noun": return pickUnique(nouns, 2);
+		case "adj-tech": return [pickUnique(adjectives, 1)[0], pickUnique(tech, 1)[0]];
+		case "tech": return [pickUnique(tech, 1)[0]];
+	}
+}
+function buildSuffix(digits) {
+	if (!digits) return "";
+	let s = "";
+	for (let i = 0; i < digits; i++) s += Math.floor(Math.random() * 10).toString();
+	return s;
+}
+function generateName(options = {}) {
+	const { style = "adj-noun", separator = "-", casing = "lowercase", suffix } = options;
+	return applyFormat(buildWords(style), casing, separator, buildSuffix(suffix));
+}
+//#endregion
+//#region src/cli/index.ts
+const STYLES = [
+	"adj-noun",
+	"adj-adj-noun",
+	"verb-noun",
+	"noun-noun",
+	"adj-tech",
+	"tech"
+];
+const CASINGS = [
+	"lowercase",
+	"uppercase",
+	"camel",
+	"pascal",
+	"title"
+];
+const HELP = `
+namejam — generate funny, unique usernames
+
+Usage: namejam [options]
+
+Options:
+  --style <style>      Word pattern  (default: adj-noun)
+                       ${STYLES.join(" | ")}
+  --separator <sep>    Word separator string  (default: -)
+  --casing <casing>    Casing style  (default: lowercase)
+                       ${CASINGS.join(" | ")}
+  --suffix <digits>    Append N random digits
+  --count <n>          Print N names, one per line  (default: 1)
+  -h, --help           Show this help
+  -v, --version        Show version
+`.trim();
+function parseArgs(argv) {
+	const opts = {};
+	let count = 1;
+	let i = 0;
+	while (i < argv.length) {
+		const arg = argv[i];
+		if (arg === "-h" || arg === "--help") {
+			console.log(HELP);
+			process.exit(0);
+		}
+		if (arg === "-v" || arg === "--version") {
+			console.log("0.1.0");
+			process.exit(0);
+		}
+		const next = argv[i + 1];
+		if (arg === "--style") {
+			if (!next || !STYLES.includes(next)) die(`--style must be one of: ${STYLES.join(", ")}`);
+			opts.style = next;
+			i += 2;
+		} else if (arg === "--separator") {
+			if (next === void 0) die("--separator requires a value");
+			opts.separator = next;
+			i += 2;
+		} else if (arg === "--casing") {
+			if (!next || !CASINGS.includes(next)) die(`--casing must be one of: ${CASINGS.join(", ")}`);
+			opts.casing = next;
+			i += 2;
+		} else if (arg === "--suffix") {
+			const n = Number(next);
+			if (!next || !Number.isInteger(n) || n < 1) die("--suffix requires a positive integer");
+			opts.suffix = n;
+			i += 2;
+		} else if (arg === "--count") {
+			const n = Number(next);
+			if (!next || !Number.isInteger(n) || n < 1) die("--count requires a positive integer");
+			count = n;
+			i += 2;
+		} else die(`Unknown option: ${arg}`);
+	}
+	return {
+		opts,
+		count
+	};
+}
+function die(msg) {
+	console.error(`namejam: ${msg}\nRun 'namejam --help' for usage.`);
+	process.exit(1);
+}
+const { opts, count } = parseArgs(process.argv.slice(2));
+for (let i = 0; i < count; i++) console.log(generateName(opts));
+//#endregion
+export {};