brignano 1.0.0 → 1.1.0

package/readme.md

@@ -1,66 +1,81 @@
-# npx_brignano <a href="#"><img src="https://img.shields.io/badge/-npx%20brignano-white?style=flat-square&logo=npm&logoColor=grey" align="right" alt="npm Badge"></img></a>
-
-An interactive shell experience that renders my business card in your terminal.
-
-👇 just hit 
-```bash
-npx brignano
-```
-
-### DEMO
-
 # npx-brignano <a href="#"><img src="https://img.shields.io/badge/-npx%20brignano-white?style=flat-square&logo=npm&logoColor=grey" align="right" alt="npm Badge"></img></a>
 
-An interactive terminal business card for Anthony Brignano. Run it with `npx` to view a styled card in your terminal and choose quick actions like emailing or downloading a resume.
+An interactive terminal business card for Anthony Brignano. Run it with `npx` to get a gradient ASCII-art intro, a styled card with **live GitHub stats**, and quick actions — copy my email, open my socials, save my contact, or grab a scannable QR code.
 
-Quick start
+## Quick start
 
 ```bash
 npx brignano
 ```
 
-Demo
+![](demo.gif)
+
+## What it does
+
+- **Gradient ASCII banner** (`figlet` + `gradient-string`) with a smooth line-by-line reveal animation.
+- **Styled business card** (`boxen` + `chalk`) with name, role, and links.
+- **Live GitHub stats** — follower/repo counts and my latest repo, fetched fresh with a strict ~1.5s timeout. If the network is slow or offline, the card renders instantly and just omits the live line. It never hangs.
+- **Interactive menu** (`inquirer`) with quick actions:
+  - Copy my email to your clipboard
+  - Send me an email (`mailto:`)
+  - Open my GitHub / LinkedIn
+  - View my resume
+  - Save my contact as a `.vcf` (opens in Contacts)
+  - Show a scannable contact **QR code**
+  - Quit
 
-![](https://raw.githubusercontent.com/brignano/npx_brignano/main/demo.gif)
+The animation, network fetch, and prompt are all skipped automatically when output isn't a TTY (piped, CI, or `--no-prompt`), so it stays fast and never blocks scripts.
 
-What it does
+## CLI
 
-- Renders a boxed, colored business card in the terminal using `boxen` and `chalk`.
-- Presents a small interactive menu (via `inquirer`) with actions:
-	- Send an email (opens your mail client with `mailto:`)
-	- Download the resume (fetches a resume HTML and opens it locally)
-	- Quit
+Run `npx brignano --help` to see this list.
 
-Files
+| Flag | Description |
+|------|-------------|
+| `-h, --help` | Show help and exit. |
+| `-v, --view` | Open my resume in your default browser (`https://brignano.io/resume`). |
+| `-e, --email` | Open your mail client with a new message to `hi@brignano.io`. |
+| `--qr` | Print a scannable QR code to my website and exit. |
+| `--vcard` / `--save-contact` | Save my contact card (`.vcf`) and open it. |
+| `--no-animation` | Render the full card instantly, skipping the reveal animation. |
+| `--no-prompt` | Show the card only and exit (non-interactive). |
+| `-d, --download` | Deprecated alias for `--view`. |
 
-- `card.js` — main CLI script: prints the card and runs the interactive menu.
-- `package.json` — project metadata and `bin` entry used by `npx`.
+### Examples
 
-Usage
+```bash
+npx brignano              # full interactive experience
+npx brignano --view       # jump straight to my resume
+npx brignano --qr         # print a QR code to my site
+npx brignano --vcard      # save my contact card
+npx brignano --no-prompt  # card only (useful in CI/scripts)
+```
 
-- Run directly with `npx brignano` (no install required).
-- Or clone and run locally:
+## Local development
 
 ```bash
-git clone https://github.com/brignano/npx_brignano.git
+git clone https://github.com/brignano/npx-brignano.git
 cd npx-brignano
 npm install
-node card.js
+npm run build
+node dist/card.js
 ```
 
-Prerequisites
+Source lives in `src/` (split into small modules — `card.ts` is the entry/`bin` target) and compiles to `dist/` via `tsc`.
+
+## Prerequisites
 
-- Node.js (tested with Node 14+). `npx` is included with npm.
+- Node.js **>=20** (`npx` ships with npm).
 
-Notes
+## Notes
 
-- When you choose "Download my Resume" the script requests the resume URL and writes `anthony-brignano.html` into the current working directory, then opens it.
-- Links printed in the card may be cmd/ctrl+clickable in supported terminals.
+- Links printed in the card are cmd/ctrl+clickable in supported terminals.
+- The `--download` flag is deprecated and now opens the resume in your browser instead of writing a local file.
 
-Credits
+## Credits
 
-This project is inspired by and credited to [anmol098/npx_card](https://github.com/anmol098/npx_card).
+Inspired by [anmol098/npx_card](https://github.com/anmol098/npx_card).
 
-License
+## License
 
-See `package.json` for license information.
+See `package.json` for license information.

package/src/banner.ts

@@ -0,0 +1,66 @@
+import figlet from 'figlet';
+import gradient from 'gradient-string';
+import { sleep } from './reveal.js';
+
+// Brand palette — matches brignano.io's electric indigo/violet accent
+// (violet-700 → violet-500 → violet-400). Reads well on a dark terminal.
+const BRAND = ['#6d28d9', '#8b5cf6', '#a78bfa'];
+
+// A longer ramp with a bright crest (violet-300) used for the shimmer sweep.
+const SHIMMER = [
+  '#5b21b6',
+  '#6d28d9',
+  '#7c3aed',
+  '#8b5cf6',
+  '#a78bfa',
+  '#c4b5fd',
+  '#a78bfa',
+  '#8b5cf6',
+  '#7c3aed',
+  '#6d28d9',
+];
+
+function bannerArt(text: string): string {
+  try {
+    return figlet.textSync(text, { font: 'ANSI Shadow' });
+  } catch {
+    return text.toUpperCase();
+  }
+}
+
+function paint(colors: string[], art: string): string {
+  try {
+    return gradient(colors).multiline(art);
+  } catch {
+    return art;
+  }
+}
+
+// Static gradient banner (used for the non-animated path).
+export function renderBanner(text = 'brignano'): string {
+  return paint(BRAND, bannerArt(text));
+}
+
+// Animated splash: a violet highlight sweeps across the letters, then settles on
+// the static brand gradient. Redraws in place via ANSI cursor moves, so it must
+// only be called on a TTY (the caller gates this behind `shouldAnimate`).
+export async function animateBanner(
+  text = 'brignano',
+  frames = 14,
+  frameMs = 70,
+): Promise<void> {
+  const art = bannerArt(text);
+  const lineCount = art.split('\n').length;
+
+  for (let i = 0; i < frames; i++) {
+    const offset = i % SHIMMER.length;
+    const rotated = SHIMMER.slice(offset).concat(SHIMMER.slice(0, offset));
+    if (i > 0) process.stdout.write(`\u001b[${lineCount}A`);
+    process.stdout.write(`\r${paint(rotated, art)}\n`);
+    await sleep(frameMs);
+  }
+
+  // Settle on the canonical brand gradient.
+  process.stdout.write(`\u001b[${lineCount}A`);
+  process.stdout.write(`${renderBanner(text)}\n`);
+}

package/src/card.ts

@@ -1,133 +1,98 @@
 #!/usr/bin/env node
 
-import boxen from 'boxen';
 import chalk from 'chalk';
 import inquirer from 'inquirer';
-import open from 'open';
+import { animateBanner, renderBanner } from './banner.js';
+import { renderCard } from './cardBox.js';
+import { funFacts, pick, profile, taglines } from './data.js';
+import {
+  clearConsole,
+  isInteractive,
+  parseFlags,
+  shouldAnimate,
+  shouldFetchLive,
+} from './env.js';
+import { fetchLive } from './live.js';
+import { buildChoices, sendEmail, viewResume } from './menu.js';
+import { renderQr } from './qrcode.js';
+import { reveal, sleep } from './reveal.js';
+import { writeAndOpenVCard } from './vcard.js';
 
-function clearConsole(): void {
-  if (typeof (process.stdout as any).clear === 'function') {
-    try { (process.stdout as any).clear(); } catch (e) { /* ignore */ }
-  }
-  if (process.stdout.isTTY) {
-    process.stdout.write('\u001b[2J\u001b[0f');
-  }
+function printHelp(): void {
+  console.log('\nUsage: npx brignano [options]\n');
+  console.log('Options:');
+  console.log('  -h, --help        Show this help');
+  console.log('  -v, --view        Open my resume in your browser');
+  console.log('  -e, --email       Open your mail client to email me');
+  console.log('      --qr          Print a scannable QR code to my website');
+  console.log('      --vcard       Save my contact card (.vcf) and open it');
+  console.log('      --no-animation  Render instantly, skip the reveal animation');
+  console.log('      --no-prompt   Show the card only (non-interactive)');
+  console.log('  -d, --download    Deprecated alias for --view\n');
 }
 
-clearConsole();
+async function main(): Promise<void> {
+  const argv = process.argv.slice(2);
+  const flags = parseFlags(argv);
 
-const prompt = inquirer.createPromptModule();
+  // Direct-action flags short-circuit the full experience.
+  if (flags.help) return printHelp();
+  if (flags.view || flags.download) {
+    if (flags.download) {
+      console.warn('Note: --download is deprecated; opening the resume instead.');
+    }
+    return viewResume();
+  }
+  if (flags.email) return sendEmail();
+  if (flags.qr) {
+    console.log(await renderQr(profile.website));
+    console.log(chalk.gray(`  ${profile.website}\n`));
+    return;
+  }
+  if (flags.vcard) return writeAndOpenVCard();
 
-const questions = [
-  {
-    type: 'list',
-    name: 'action',
-    message: 'What you want to do?',
-    choices: [
-      {
-        name: `Send me an ${chalk.green.bold('Email')}.`,
-        value: () => sendEmail(),
-      },
-      {
-        name: `View my ${chalk.magentaBright.bold('Resume')}.`,
-        value: () => viewResume(),
-      },
-      {
-        name: 'Just quit.',
-        value: () => {
-          console.log('Have a good day!\n');
-        },
-      },
-    ],
-  },
-];
+  const animate = shouldAnimate(flags);
+  const interactive = isInteractive(flags);
 
-function sendEmail(): void {
-  open('mailto:hi@brignano.io')
-    .then(() => {
-      console.log('\nDone, see you soon at inbox.\n');
-    })
-    .catch((err: any) => {
-      console.error('Failed to open mail client:', err && err.message ? err.message : err);
-    });
-}
+  // Kick off the live fetch early (don't await yet) so its timeout budget
+  // overlaps the banner render. Skipped entirely when non-interactive/CI.
+  const livePromise = shouldFetchLive(flags) ? fetchLive() : Promise.resolve(null);
 
-function viewResume(): void {
-  const resumeUrl = 'https://brignano.io/resume';
-  open(resumeUrl)
-    .then(() => {
-      console.log(`\nOpened resume: ${resumeUrl}\n`);
-    })
-    .catch((err: any) => {
-      console.error('Failed to open resume URL:', err && err.message ? err.message : err);
-    });
-}
+  clearConsole();
 
-const data = {
-  name: chalk.bold.green('             Anthony Brignano'),
-  handle: chalk.white('@brignano'),
-  work: `Senior Staff Software Engineer ${chalk.white('at')} ${chalk.hex('#3A5A78').bold('The Hartford')}`,
-  github: chalk.gray('https://github.com/') + chalk.green('brignano'),
-  linkedin: chalk.gray('https://linkedin.com/in/') + chalk.blue('brignano'),
-  web: chalk.cyan('https://brignano.io'),
-  npx: chalk.red('npx') + ' ' + chalk.white('brignano'),
+  // Banner first: an animated violet shimmer when we can animate, otherwise the
+  // static gradient.
+  if (animate) {
+    await animateBanner();
+    await sleep(120);
+  } else {
+    console.log(renderBanner());
+  }
 
-  labelWork: chalk.white.bold('       Work:'),
-  labelGitHub: chalk.white.bold('     GitHub:'),
-  labelLinkedIn: chalk.white.bold('   LinkedIn:'),
-  labelWeb: chalk.white.bold('        Website:'),
-  labelCard: chalk.white.bold('       Card:'),
-};
+  // Card, enriched with whatever the (bounded) live fetch returned.
+  const live = await livePromise;
+  const tagline = pick(taglines);
+  await reveal(renderCard({ live, tagline }), 30, animate);
 
-const me = boxen(
-  [
-    `${data.name}`,
-    '',
-    `${data.labelWork}  ${data.work}`,
-    '',
-    `${data.labelGitHub}  ${data.github}`,
-    `${data.labelLinkedIn}  ${data.linkedin}`,
-    `${data.labelWeb}  ${data.web}`,
-    '',
-    `${data.labelCard}  ${data.npx}`,
-    '',
-    `${chalk.italic("My inbox is always open. Whether you have a")}`,
-    `${chalk.italic("question or just want to say hi, I will try")}`,
-    `${chalk.italic("my best to get back to you! :)")}`,
-  ].join('\n'),
-  {
-    margin: 1,
-    float: 'center' as const,
-    padding: 1,
-    borderStyle: 'single',
-    borderColor: 'green',
-  }
-);
+  console.log(`Tip: ${chalk.cyanBright.bold('cmd/ctrl + click')} the links above.`);
+  console.log(chalk.gray(`     ${pick(funFacts)}\n`));
 
-console.log(me);
-const tip = [`Tip: Try ${chalk.cyanBright.bold('cmd/ctrl + click')} on the links above`, ''].join('\n');
-console.log(tip);
+  if (!interactive) return;
 
-// Simple argument parsing
-const argv = process.argv.slice(2);
-if (argv.includes('--help') || argv.includes('-h')) {
-  console.log('\nUsage: npx brignano [options]\n');
-  console.log('Options:');
-  console.log('  -h, --help       Show this help');
-  console.log('  -v, --view       Open resume in browser (https://brignano.io/resume)');
-  console.log('  -d, --download   Deprecated: previously downloaded resume — now opens resume in browser');
-  console.log('  -e, --email      Open mail client to email me');
-  console.log('  --no-prompt      Show card only (non-interactive)\n');
-} else if (argv.includes('--view') || argv.includes('-v')) {
-  viewResume();
-} else if (argv.includes('--download') || argv.includes('-d')) {
-  console.warn('Warning: `--download` is deprecated and now opens the resume in your browser.');
-  viewResume();
-} else if (argv.includes('--email') || argv.includes('-e')) {
-  sendEmail();
-} else if (argv.includes('--no-prompt') || argv.includes('--quiet')) {
-  console.log('\nExiting in non-interactive mode (--no-prompt).');
-} else {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  prompt(questions as any).then((answer: any) => answer.action());
+  const prompt = inquirer.createPromptModule();
+  const { action } = await prompt([
+    {
+      type: 'list',
+      name: 'action',
+      message: 'What would you like to do?',
+      choices: buildChoices(),
+    },
+  ]);
+  await action();
 }
+
+main().catch((err: unknown) => {
+  const message = err instanceof Error ? err.message : String(err);
+  console.error(`Something went wrong: ${message}`);
+  process.exitCode = 1;
+});

package/src/cardBox.ts

@@ -0,0 +1,64 @@
+import boxen from 'boxen';
+import chalk from 'chalk';
+import { profile } from './data.js';
+import type { LiveData } from './live.js';
+
+// Right-aligns labels to a common width so the values line up cleanly.
+const LABEL_WIDTH = 10;
+function label(text: string): string {
+  return chalk.white.bold(text.padStart(LABEL_WIDTH) + ':');
+}
+
+interface CardOptions {
+  live?: LiveData | null;
+  tagline: string;
+}
+
+// Builds the boxen business card. `live` is optional — when absent the live
+// line is simply omitted, so the card looks intentional with or without network.
+export function renderCard({ live, tagline }: CardOptions): string {
+  // Violet accent matches brignano.io (violet-400 #a78bfa on dark).
+  const accent = chalk.hex('#a78bfa');
+  const lines = [
+    accent.bold(profile.fullName) + '  ' + chalk.gray(profile.handle),
+    '',
+    `${label('Work')}  ${profile.title} ${chalk.gray('at')} ${chalk
+      .hex('#3A5A78')
+      .bold(profile.org)}`,
+    '',
+    `${label('GitHub')}  ${chalk.gray('https://github.com/')}${chalk.green(
+      profile.username,
+    )}`,
+    `${label('LinkedIn')}  ${chalk.gray('https://linkedin.com/in/')}${chalk.blue(
+      profile.username,
+    )}`,
+    `${label('Website')}  ${chalk.cyan(profile.website)}`,
+  ];
+
+  if (live) {
+    lines.push('');
+    const parts = [
+      `${chalk.yellow('★')} ${chalk.bold(live.followers)} followers`,
+      `${chalk.bold(live.publicRepos)} repos`,
+    ];
+    if (live.latestRepo) {
+      parts.push(`latest: ${chalk.green(live.latestRepo.name)}`);
+    }
+    lines.push(`${label('Live')}  ${chalk.gray(parts.join(' · '))}`);
+  }
+
+  lines.push(
+    '',
+    `${label('Card')}  ${chalk.red('npx')} ${chalk.white('brignano')}`,
+    '',
+    chalk.italic(tagline),
+  );
+
+  return boxen(lines.join('\n'), {
+    margin: 1,
+    float: 'center',
+    padding: 1,
+    borderStyle: 'round',
+    borderColor: 'gray',
+  });
+}

package/src/data.ts

@@ -0,0 +1,38 @@
+// Single source of truth for everything the card, vCard, QR and live modules need.
+// Plain (uncolored) values live here; chalk styling is applied at render time.
+
+export const profile = {
+  firstName: 'Anthony',
+  lastName: 'Brignano',
+  fullName: 'Anthony Brignano',
+  handle: '@brignano',
+  username: 'brignano',
+  title: 'Senior Staff Software Engineer',
+  org: 'The Hartford',
+  email: 'hi@brignano.io',
+  website: 'https://brignano.io',
+  resume: 'https://brignano.io/resume',
+  github: 'https://github.com/brignano',
+  linkedin: 'https://linkedin.com/in/brignano',
+} as const;
+
+// Rotating taglines — one is picked per run so repeat visitors see variety.
+export const taglines: string[] = [
+  'My inbox is always open. Ask a question or just say hi — I read everything.',
+  'Building reliable systems, mentoring engineers, and shipping things that last.',
+  "If it's worth automating, it's worth a clean abstraction. Let's build.",
+  'Self-hoster, spec-driven, and unreasonably fond of a tidy terminal.',
+  'Good engineering is mostly good taste applied consistently. Say hello.',
+];
+
+// Small easter-egg facts, shown occasionally below the card.
+export const funFacts: string[] = [
+  'This card is open source — `npx brignano --help` shows every trick.',
+  'Tip: scan the QR with your phone to save my contact instantly.',
+  'The live stats above are pulled fresh from GitHub (with a strict timeout).',
+];
+
+// Deterministic-enough pick without Math.random (kept simple + dependency-free).
+export function pick<T>(items: readonly T[], seed = Date.now()): T {
+  return items[Math.floor(seed / 1000) % items.length];
+}

package/src/env.ts

@@ -0,0 +1,69 @@
+// Environment + capability detection. Keeps the render logic free of scattered
+// `process.stdout.isTTY` checks and guarantees CI / piped output never hangs.
+
+export interface Flags {
+  help: boolean;
+  view: boolean;
+  download: boolean;
+  email: boolean;
+  qr: boolean;
+  vcard: boolean;
+  noPrompt: boolean;
+  noAnimation: boolean;
+}
+
+export function hasFlag(argv: string[], names: string[]): boolean {
+  return names.some((n) => argv.includes(n));
+}
+
+export function parseFlags(argv: string[]): Flags {
+  return {
+    help: hasFlag(argv, ['--help', '-h']),
+    view: hasFlag(argv, ['--view', '-v']),
+    download: hasFlag(argv, ['--download', '-d']),
+    email: hasFlag(argv, ['--email', '-e']),
+    qr: hasFlag(argv, ['--qr']),
+    vcard: hasFlag(argv, ['--vcard', '--save-contact']),
+    noPrompt: hasFlag(argv, ['--no-prompt', '--quiet']),
+    noAnimation: hasFlag(argv, ['--no-animation']),
+  };
+}
+
+const isCI = (): boolean => Boolean(process.env.CI);
+
+// True only when we can safely show an interactive inquirer prompt.
+export function isInteractive(flags: Flags): boolean {
+  return Boolean(
+    process.stdout.isTTY && process.stdin.isTTY && !isCI() && !flags.noPrompt,
+  );
+}
+
+// True only when the reveal animation should play.
+export function shouldAnimate(flags: Flags): boolean {
+  return Boolean(
+    process.stdout.isTTY &&
+      !isCI() &&
+      !flags.noPrompt &&
+      !flags.noAnimation &&
+      !process.env.NO_COLOR,
+  );
+}
+
+// True only when we should spend time on a live network fetch.
+export function shouldFetchLive(flags: Flags): boolean {
+  return isInteractive(flags);
+}
+
+export function clearConsole(): void {
+  const out = process.stdout as NodeJS.WriteStream & { clear?: () => void };
+  if (typeof out.clear === 'function') {
+    try {
+      out.clear();
+    } catch {
+      /* ignore */
+    }
+  }
+  if (process.stdout.isTTY) {
+    process.stdout.write('\u001b[2J\u001b[0f');
+  }
+}

package/src/live.ts

@@ -0,0 +1,58 @@
+import { profile } from './data.js';
+
+export interface LiveData {
+  followers: number;
+  publicRepos: number;
+  latestRepo?: { name: string; url: string };
+}
+
+const API = 'https://api.github.com';
+const HEADERS = {
+  'User-Agent': 'npx-brignano',
+  Accept: 'application/vnd.github+json',
+};
+
+// Fetches live GitHub stats with a hard timeout. ANY failure (timeout, offline,
+// non-200, rate-limit, parse error) resolves to null — this never throws and
+// never blocks the card for longer than `timeoutMs`.
+export async function fetchLive(timeoutMs = 1500): Promise<LiveData | null> {
+  const controller = new AbortController();
+  const timer = setTimeout(() => controller.abort(), timeoutMs);
+  try {
+    const [userRes, reposRes] = await Promise.all([
+      fetch(`${API}/users/${profile.username}`, {
+        headers: HEADERS,
+        signal: controller.signal,
+      }),
+      fetch(
+        `${API}/users/${profile.username}/repos?sort=updated&per_page=1`,
+        { headers: HEADERS, signal: controller.signal },
+      ),
+    ]);
+
+    if (!userRes.ok || !reposRes.ok) return null;
+
+    const user = (await userRes.json()) as {
+      followers?: number;
+      public_repos?: number;
+    };
+    const repos = (await reposRes.json()) as Array<{
+      name?: string;
+      html_url?: string;
+    }>;
+
+    const latest = Array.isArray(repos) ? repos[0] : undefined;
+    return {
+      followers: user.followers ?? 0,
+      publicRepos: user.public_repos ?? 0,
+      latestRepo:
+        latest?.name && latest?.html_url
+          ? { name: latest.name, url: latest.html_url }
+          : undefined,
+    };
+  } catch {
+    return null;
+  } finally {
+    clearTimeout(timer);
+  }
+}