reverentgeek 2.2.1 → 3.0.1

package/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(node:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

package/AGENTS.md

@@ -0,0 +1,16 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+The CLI entry point remains `bin/card.js`, now focused on orchestration: it imports palette helpers (`bin/colors.js`), layout formatters (`bin/render-info.js`, `bin/text.js`), and profile data in `config/profile.js`. Adjust CLI content by editing the profile file; the renderer already handles centered headings, wrapped bios, and multi-line values. ASCII art lives in `art/` and is addressed through `art/index.js`, keeping individual assets (`avatar.js`, `banner.js`) easy to swap. Root-level configs (`package.json`, `eslint.config.js`) continue to hold metadata, lint rules, and script aliases.
+
+## Build, Test, and Development Commands
+Install dependencies with `npm install` (or `pnpm install` if you prefer pnpm). Run `npm run lint` to apply the repository ESLint profile across `bin/*.js` and `art/*.js`. During manual checks, execute `node bin/card.js` to preview the card locally, or `npx .` to simulate the published package without installing it globally.
+
+## Coding Style & Naming Conventions
+We use modern ESM everywhere. Keep indentation as tabs, match the existing double-quote style, and favor `const`. New helpers should sit with their peers (`bin/` for runtime logic, `config/` for data). If you extend value styling, add the formatter in `bin/colors.js` and reference it by name in `config/profile.js`. When profile entries need multiple lines, prefer arrays (`value: ["Role", "URL"]`) instead of embedding `\n`.
+
+## Testing Guidelines
+There is no automated test suite today. Before opening a PR, run `npm run lint` and execute `node bin/card.js` to confirm the output renders without ANSI errors. Validate spacing and color choices in a terminal that supports truecolor, and capture a screenshot or paste output snippets in the PR if you alter visual elements. If you add automated checks, colocate them with the feature and document the new command.
+
+## Commit & Pull Request Guidelines
+Existing commits favor short, present-tense summaries such as `updates dependencies`. Follow that style: a single concise line describing what changes, optionally followed by wrapped details. PRs should explain the intent, call out impacted modules (`bin/card.js`, `art/banner.js`, etc.), and mention manual verification steps taken. Link issues when applicable and include visuals whenever you change the rendered card.

package/CLAUDE.md

@@ -0,0 +1,47 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is a terminal calling card application built with Node.js that displays formatted personal information in a terminal box. Users run `npx reverentgeek` to see the author's contact info and bio in an ASCII art-styled terminal card.
+
+## Commands
+
+- **Development preview**: `node bin/card.js` - Run the card locally to preview output
+- **Linting**: `npm run lint` - Run ESLint on all JavaScript files in bin/ and art/ directories
+- **Installation**: Users install/run via `npx reverentgeek`
+
+## Architecture
+
+### Core Components
+
+- **bin/card.js**: Main entry point that orchestrates the entire card rendering
+- **config/profile.js**: Contains all personal information, contact links, and art rendering order
+- **bin/colors.js**: Defines color palette and gradient configurations using chalk and gradient-string
+- **bin/text.js**: Text utilities for centering and wrapping text within specified widths
+- **bin/render-info.js**: Handles formatting of info sections with labels and values
+- **art/**: Directory containing ASCII art modules (avatar, banner, etc.)
+
+### Data Flow
+
+1. **card.js** imports profile data and art assets
+2. Applies color styling to profile sections using colors defined in **colors.js**
+3. Uses **text.js** utilities to format bio text and center headings
+4. Uses **render-info.js** to format contact information sections
+5. Loads and applies gradients to ASCII art from **art/** directory
+6. Combines all elements and renders in a boxen-styled terminal box
+
+### Customization Points
+
+- **Profile data**: Edit `config/profile.js` to change name, bio, contact info, and art order
+- **Colors/gradients**: Modify `bin/colors.js` for different color schemes
+- **ASCII art**: Add new art files in `art/` directory and register in `art/index.js`
+- **Styling**: Each info section supports style properties (orange, gradient, lightBlue, yellow)
+
+### Key Patterns
+
+- Profile sections can have string or array values for multi-line entries
+- Art assets are loaded dynamically based on `artOrder` array in profile config
+- Color styling is applied through a centralized `styleValue` function
+- Text wrapping respects the horizontal rule width for consistent formatting

package/README.md

@@ -8,6 +8,25 @@ In case you ever need my information and all you have is a terminal and `npm`.
 npx reverentgeek
 ```
 
+## Make It Yours
+
+Clone this repo (or create a new one) and adjust the profile and art assets to build your own terminal calling card:
+
+- Edit `config/profile.js` with your name, biography, and contact links. Each entry in `infoSections` can be a string or an array if you want multiple lines under one label.
+- Update colors or gradients by tweaking `bin/colors.js`, then reference any new styles by name from the profile file.
+- Swap ASCII art by editing the files under `art/` or adding new modules and registering them in `art/index.js`. The `artOrder` export in `config/profile.js` controls the render sequence.
+- Run `npm run lint` for style checks and `node bin/card.js` to preview the box output locally before publishing.
+
+Want to publish it so others can view it with `npx`?
+
+- Update `package.json` and change the name, version, and other fields to make it yours.
+- Push your code to a new public repository.
+- [Sign up for an npm account](https://www.npmjs.com/signup), if you don't have one.
+- Authenticate with `npm login`.
+- Publish your package using `npm publish` from the project root.
+
+For more info, check out the [official npm publish guide](https://docs.npmjs.com/cli/v11/commands/npm-publish).
+
 ## Credit
 
-Completely *borrowed* this idea from [Tierney](https://github.com/bnb/bitandbang) :)
+Completely *borrowed* this idea from [Tierney](https://github.com/bnb/bitandbang) :)

package/art/index.js

@@ -0,0 +1,19 @@
+import avatar from "./avatar.js";
+import banner from "./banner.js";
+
+const assets = {
+	avatar,
+	banner
+};
+
+export const loadArt = ( name ) => {
+	const art = assets[name];
+
+	if ( !art ) {
+		throw new Error( `Unknown art asset: ${ name }` );
+	}
+
+	return art;
+};
+
+export const availableArt = () => Object.keys( assets );

package/bin/card.js

@@ -2,32 +2,13 @@
 // 👆 Used to tell Node.js that this is a CLI tool
 
 // Pull in our modules
-import chalk from "chalk";
 import boxen from "boxen";
-import gs from "gradient-string";
 
-// Some sweet ascii art
-import avatar from "../art/avatar.js";
-import banner from "../art/banner.js";
-
-// define custom colors
-const colors = {
-	blue: "#00A3FF",
-	blueSky: "#51D2FB",
-	mintGreen: "#42F0CD",
-	inkyBlue: "#130f25",
-	lightBlue: "#99DAFF",
-	orange: "#ff7b01",
-	pink: "#ff1675",
-	yellow: "#ffc942"
-};
-
-// set up chalk and gradients
-const yellowChalk = chalk.hex( colors.yellow );
-const lbChalk = chalk.hex( colors.lightBlue );
-const blueChalk = chalk.hex( colors.blue );
-const orangeChalk = chalk.hex( colors.orange );
-const gradient = gs( [ colors.mintGreen, colors.blueSky ] );
+import { availableArt, loadArt } from "../art/index.js";
+import { artOrder, profile } from "../config/profile.js";
+import { colors, gradient, palette } from "./colors.js";
+import { renderInfoSections } from "./render-info.js";
+import { centerText, wrapText } from "./text.js";
 
 const newline = "\n";
 
@@ -40,73 +21,48 @@ const options = {
 	backgroundColor: colors.inkyBlue
 };
 
-// Text + chalk definitions
-const data = {
-	name: yellowChalk.bold( "                   DAVID NEAL" ),
-	handle: yellowChalk( "reverentgeek" ),
-	work: gradient( "Developer Relations Engineer" ),
-	workUrl: gradient( " https://plaid.com" ),
-	twitter: yellowChalk( "https://x.com/reverentgeek" ),
-	instagram: yellowChalk( "https://instagram.com/reverentgeek" ),
-	mastodon: yellowChalk( "@reverentgeek@reverentgeek.com" ),
-	bluesky: yellowChalk( "@reverentgeek.com" ),
-	threads: yellowChalk( "@reverentgeek" ),
-	github: yellowChalk( "https://github.com/reverentgeek" ),
-	linkedin: yellowChalk( "https://linkedin.com/in/davidneal" ),
-	web: yellowChalk( "https://reverentgeek.com" ),
-	email: yellowChalk( "david@reverentgeek.com" ),
-	npx: orangeChalk( "npx reverentgeek" ),
-	labelWork: blueChalk( "       Work:" ),
-	labelWorkUrl: blueChalk( "           " ),
-	labelTwitter: blueChalk( "          X:" ),
-	labelInstagram: blueChalk( "  Instagram:" ),
-	labelMastodon: blueChalk( "   Mastodon:" ),
-	labelBluesky: blueChalk( "    BlueSky:" ),
-	labelThreads: blueChalk( "    Threads:" ),
-	labelGitHub: blueChalk( "     GitHub:" ),
-	labelLinkedIn: blueChalk( "   LinkedIn:" ),
-	labelWeb: blueChalk( "        Web:" ),
-	labelCard: blueChalk( "       Card:" ),
-	labelEmail: blueChalk( "      Email:" ),
-	bio: lbChalk( `David is a family man, geek, musician, illustrator, 
-speaker, software developer, and Microsoft MVP
-living in North GA. He runs on a high-octane
-mixture of caffeine and JavaScript, and
-is entirely made of bacon.` )
-// msg: greenChalk( `If there's anything I can help you with,
-// reach out anytime!` )
+const valueStylers = {
+	orange: value => palette.orange( value ),
+	gradient: value => gradient( value ),
+	lightBlue: value => palette.lightBlue( value ),
+	yellow: value => palette.yellow( value )
+};
+
+const styleValue = ( { value, style } ) => {
+	const values = Array.isArray( value ) ? value : [ value ];
+	const formatter = valueStylers[style];
+
+	if ( !formatter ) {
+		return values;
+	}
+
+	return values.map( entry => formatter( entry ) );
 };
 
+const styledInfoSections = profile.infoSections.map( section => ( {
+	...section,
+	value: styleValue( section )
+} ) );
+
 // Actual strings we're going to output
-const hr = gradient( "----------~~~~~~~~~==========~~~~~~~~~-----------" );
-const heading = data.name;
-const working = `\n${ data.labelWork }  ${ data.work }`;
-const workingUrl = `${ data.labelWorkUrl }  ${ data.workUrl }`;
-const twittering = `${ data.labelTwitter }  ${ data.twitter }`;
-const instagramming = `${ data.labelInstagram }  ${ data.instagram }`;
-const tooting = `${ data.labelMastodon }  ${ data.mastodon }`;
-const skeeting = `${ data.labelBluesky }  ${ data.bluesky }`;
-const threading = `${ data.labelThreads }  ${ data.threads }`;
-const githubing = `${ data.labelGitHub }  ${ data.github }`;
-const linkedining = `${ data.labelLinkedIn }  ${ data.linkedin }`;
-const webing = `${ data.labelWeb }  ${ data.web }`;
-const emailing = `${ data.labelEmail }  ${ data.email }`;
-const carding = `\n${ data.labelCard }  ${ data.npx }`;
-const bio = `\n${ data.bio }`;
-// const msg = `\n${ data.msg }`;
+const hrText = "----------~~~~~~~~~==========~~~~~~~~~-----------";
+const hr = gradient( hrText );
+const heading = palette.yellow.bold( centerText( profile.name, hrText.length ) );
+const formattedInfo = renderInfoSections( styledInfoSections, {
+	labelColor: palette.blue
+} );
+
+const bioLines = wrapText( profile.bio, hrText.length );
+const bio = `\n${ bioLines.map( line => palette.lightBlue( line ) ).join( newline ) }`;
+
+const artAssets = artOrder.length > 0 ? artOrder : availableArt();
+const art = artAssets.map( name => gradient.multiline( loadArt( name ) ) );
 
 const card = [
-	gradient.multiline( avatar ), gradient.multiline( banner ),
+	...art,
 	hr, heading, hr,
-	working, workingUrl,
-	webing, emailing,
-	linkedining,
-	githubing,
-	instagramming,
-	tooting, skeeting, threading,
-	twittering,
-	carding, bio
-	// , msg
+	...formattedInfo,
+	bio
 ];
 
 // Put all our output together into a single variable so we can use boxen effectively

package/bin/colors.js

@@ -0,0 +1,22 @@
+import chalk from "chalk";
+import gs from "gradient-string";
+
+export const colors = {
+	blue: "#00A3FF",
+	blueSky: "#51D2FB",
+	mintGreen: "#42F0CD",
+	inkyBlue: "#130f25",
+	lightBlue: "#99DAFF",
+	orange: "#ff7b01",
+	pink: "#ff1675",
+	yellow: "#ffc942"
+};
+
+export const palette = {
+	blue: chalk.hex( colors.blue ),
+	lightBlue: chalk.hex( colors.lightBlue ),
+	orange: chalk.hex( colors.orange ),
+	yellow: chalk.hex( colors.yellow )
+};
+
+export const gradient = gs( [ colors.mintGreen, colors.blueSky ] );

package/bin/render-info.js

@@ -0,0 +1,31 @@
+const defaultOptions = {
+	labelColor: text => text,
+	leadingNewlineChar: "\n"
+};
+
+export const renderInfoSections = ( sections, options = defaultOptions ) => {
+	const { labelColor, leadingNewlineChar } = { ...defaultOptions, ...options };
+
+	const labelWidth = sections.reduce( ( max, { label } ) => Math.max( max, label.length ), 0 );
+
+	const formatLabel = ( label ) => {
+		if ( label.length === 0 ) {
+			return labelColor( "".padStart( labelWidth + 1 ) );
+		}
+
+		const baseLabel = `${ label.padStart( labelWidth ) }:`;
+
+		return labelColor( baseLabel );
+	};
+
+	return sections.flatMap( ( { label, value, leadingNewline = false } ) => {
+		const values = Array.isArray( value ) ? value : [ value ];
+
+		return values.map( ( entry, index ) => {
+			const prefix = leadingNewline && index === 0 ? leadingNewlineChar : "";
+			const formattedLabel = formatLabel( index === 0 ? label : "" );
+
+			return `${ prefix }${ formattedLabel }  ${ entry }`;
+		} );
+	} );
+};

package/bin/text.js

@@ -0,0 +1,35 @@
+export const centerText = ( text, width ) => {
+	const textLength = text.length;
+	const paddingTotal = Math.max( width - textLength, 0 );
+	const paddingLeft = Math.floor( paddingTotal / 2 );
+	const paddingRight = paddingTotal - paddingLeft;
+
+	return `${ " ".repeat( paddingLeft ) }${ text }${ " ".repeat( paddingRight ) }`;
+};
+
+export const wrapText = ( text, width ) => {
+	const words = text.split( /\s+/ );
+	const lines = [];
+	let currentLine = "";
+
+	words.forEach( ( word ) => {
+		const candidate = currentLine.length === 0 ? word : `${ currentLine } ${ word }`;
+
+		if ( candidate.length <= width ) {
+			currentLine = candidate;
+			return;
+		}
+
+		if ( currentLine.length > 0 ) {
+			lines.push( currentLine );
+		}
+
+		currentLine = word;
+	} );
+
+	if ( currentLine.length > 0 ) {
+		lines.push( currentLine );
+	}
+
+	return lines;
+};

package/config/profile.js

@@ -0,0 +1,21 @@
+export const artOrder = [ "avatar", "banner" ];
+
+export const profile = {
+	name: "DAVID NEAL",
+	handle: "reverentgeek",
+	bio: "David is a family man, geek, musician, illustrator, speaker, software developer, and Microsoft MVP living in North GA. He runs on a high-octane mixture of caffeine and JavaScript, and is entirely made of bacon.",
+	infoSections: [
+		{ label: "Work", value: [ "Developer Relations Engineer", "https://plaid.com" ], style: "gradient", leadingNewline: true },
+		{ label: "Handle", value: "reverentgeek", style: "yellow" },
+		{ label: "Portfolio", value: "https://reverentgeek.com", style: "yellow" },
+		{ label: "Email", value: "david@reverentgeek.com", style: "yellow" },
+		{ label: "LinkedIn", value: "https://linkedin.com/in/davidneal", style: "yellow" },
+		{ label: "GitHub", value: "https://github.com/reverentgeek", style: "yellow" },
+		{ label: "Instagram", value: "https://instagram.com/reverentgeek", style: "yellow" },
+		{ label: "Mastodon", value: "@reverentgeek@reverentgeek.com", style: "yellow" },
+		{ label: "BlueSky", value: "@reverentgeek.com", style: "yellow" },
+		{ label: "Threads", value: "@reverentgeek", style: "yellow" },
+		{ label: "X", value: "https://x.com/reverentgeek", style: "yellow" },
+		{ label: "Card", value: "npx reverentgeek", style: "orange", leadingNewline: true }
+	]
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "reverentgeek",
-	"version": "2.2.1",
+	"version": "3.0.1",
 	"description": "My personal calling card.",
 	"main": "./bin/card.js",
 	"bin": {
@@ -27,7 +27,7 @@
 		"gradient-string": "^3.0.0"
 	},
 	"devDependencies": {
-		"eslint": "^9.36.0",
-		"eslint-config-reverentgeek": "^6.3.0"
+		"eslint": "^9.39.0",
+		"eslint-config-reverentgeek": "^6.3.2"
 	}
-}
+}