@dheerajsom/pinhub 0.1.2 → 0.2.0

package/dist/status.d.ts

@@ -0,0 +1,28 @@
+type Environment = Record<string, string | undefined>;
+export type SignalPulseContext = {
+    stdoutIsTTY: boolean;
+    stderrIsTTY: boolean;
+    /** Width of the stream that receives the pulse, when the TTY exposes it. */
+    stderrColumns?: number;
+    env: Environment;
+};
+export type SignalPulseStream = {
+    write(chunk: string): unknown;
+};
+export declare const MIN_SIGNAL_PULSE_COLUMNS = 28;
+export declare function hasNoColor(env: Environment): boolean;
+export declare function isCiEnvironment(env: Environment): boolean;
+/** Pure capability check kept separate from the deterministic runCli API. */
+export declare function shouldAnimateSignalPulse(argv: string[], context: SignalPulseContext): boolean;
+export declare function signalPulseLabel(argv: string[]): string;
+/**
+ * A deliberately brief, color-cycling pulse. It writes only to an explicitly
+ * approved TTY stream and erases itself before normal CLI output is emitted.
+ */
+export declare function playSignalPulse(stream: SignalPulseStream, options: {
+    ascii: boolean;
+    label: string;
+    intervalMs?: number;
+    sleep?: (milliseconds: number) => Promise<void>;
+}): Promise<void>;
+export {};

package/dist/status.js

@@ -0,0 +1,63 @@
+import { setTimeout as delay } from "node:timers/promises";
+import { makeChalk } from "./render/theme.js";
+// The longest built-in pulse is 24 cells (glyph, space, and label). Keep a
+// small margin so terminals that eagerly wrap in their final column never
+// leave a ghost line behind.
+export const MIN_SIGNAL_PULSE_COLUMNS = 28;
+export function hasNoColor(env) {
+    return Object.prototype.hasOwnProperty.call(env, "NO_COLOR");
+}
+export function isCiEnvironment(env) {
+    const value = env.CI;
+    if (value !== undefined && value !== "" && !/^(?:0|false)$/i.test(value))
+        return true;
+    return Boolean(env.GITHUB_ACTIONS || env.BUILDKITE || env.TF_BUILD || env.TEAMCITY_VERSION);
+}
+/** Pure capability check kept separate from the deterministic runCli API. */
+export function shouldAnimateSignalPulse(argv, context) {
+    if (!context.stdoutIsTTY || !context.stderrIsTTY || argv.length === 0)
+        return false;
+    if (context.stderrColumns !== undefined &&
+        (!Number.isFinite(context.stderrColumns) || context.stderrColumns < MIN_SIGNAL_PULSE_COLUMNS)) {
+        return false;
+    }
+    if (isCiEnvironment(context.env) || context.env.TERM?.toLowerCase() === "dumb")
+        return false;
+    if (hasNoColor(context.env) || context.env.PINHUB_NO_MOTION || context.env.NO_MOTION)
+        return false;
+    const disablesMotion = argv.some((argument) => ["help", "-h", "--help", "-v", "-V", "--version", "--json", "--no-motion", "--no-color"].includes(argument));
+    return !disablesMotion;
+}
+export function signalPulseLabel(argv) {
+    switch (argv[0]) {
+        case "list":
+            return "Scanning board catalog";
+        case "search":
+            return "Tuning board search";
+        case "info":
+            return "Reading board signals";
+        default:
+            return "Mapping pin signals";
+    }
+}
+/**
+ * A deliberately brief, color-cycling pulse. It writes only to an explicitly
+ * approved TTY stream and erases itself before normal CLI output is emitted.
+ */
+export async function playSignalPulse(stream, options) {
+    const c = makeChalk(true);
+    const frames = options.ascii ? [".", "o", "O", "o"] : ["◇", "◈", "◆", "◈"];
+    const colors = [c.cyan, c.blueBright, c.magentaBright, c.yellowBright];
+    const sleep = options.sleep ?? ((milliseconds) => delay(milliseconds));
+    const intervalMs = options.intervalMs ?? 45;
+    const clear = "\r\u001b[2K";
+    try {
+        for (let index = 0; index < frames.length; index += 1) {
+            stream.write(`${clear}${colors[index](frames[index])} ${c.dim(options.label)}`);
+            await sleep(intervalMs);
+        }
+    }
+    finally {
+        stream.write(clear);
+    }
+}

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-/** Generated from package.json by npm version. */
-export declare const VERSION = "0.1.2";
+/** The installed package version, read from the package manifest. */
+export declare const VERSION: string;

package/dist/version.js

@@ -1,2 +1,5 @@
-/** Generated from package.json by npm version. */
-export const VERSION = "0.1.2";
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+const packageJson = require("../package.json");
+/** The installed package version, read from the package manifest. */
+export const VERSION = packageJson.version;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dheerajsom/pinhub",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Hardware board pinout diagrams in your terminal. `ph rpi5` and go.",
   "keywords": [
     "pinout",
@@ -14,6 +14,15 @@
     "terminal"
   ],
   "license": "MIT",
+  "homepage": "https://github.com/Dheerajsom/PinHub#readme",
+  "bugs": {
+    "url": "https://github.com/Dheerajsom/PinHub/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Dheerajsom/PinHub.git",
+    "directory": "cli"
+  },
   "type": "module",
   "bin": {
     "ph": "dist/cli.js"
@@ -25,6 +34,7 @@
   },
   "files": [
     "dist",
+    "CLI.md",
     "SETUP.md"
   ],
   "engines": {
@@ -33,16 +43,17 @@
   "scripts": {
     "dev": "tsx src/cli.ts",
     "generate:boards": "tsx scripts/generate-boards.ts",
+    "check:boards": "tsx scripts/generate-boards.ts --check",
     "build": "tsc -p tsconfig.json",
     "test": "vitest run",
     "lint": "eslint .",
     "package:check": "npm pack --dry-run",
-    "version": "node scripts/sync-version.mjs && git add src/version.ts",
-    "prepublishOnly": "npm run lint && npm run test && npm run build"
+    "prepublishOnly": "npm run check:boards && npm run lint && npm run test && npm run build"
   },
   "dependencies": {
     "chalk": "^5.4.1",
-    "commander": "^13.1.0"
+    "commander": "^13.1.0",
+    "string-width": "^7.2.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.20.0",
@@ -51,6 +62,7 @@
     "tsx": "^4.19.0",
     "typescript": "^5.7.3",
     "typescript-eslint": "^8.24.0",
-    "vitest": "^3.0.5"
+    "vite": "6.4.3",
+    "vitest": "3.2.7"
   }
 }