kami-redis 2.0.0

package/dist/index.js

@@ -0,0 +1,240 @@
+// src/index.ts
+import meow from "meow";
+import pc2 from "picocolors";
+import { createClient } from "redis";
+
+// src/utils/clean-up.ts
+function cleanup() {
+  return console.clear();
+}
+
+// src/utils/graceful-exit.ts
+async function gracefulExit(code = 0) {
+  try {
+    if (process.stdin.isTTY) {
+      try {
+        process.stdin.setRawMode(false);
+      } catch {
+      }
+    }
+    try {
+      process.stdin.pause();
+    } catch {
+      await client.quit();
+    }
+  } catch {
+  } finally {
+    cleanup();
+    process.exit(code);
+  }
+}
+
+// src/utils/is-redis-url.ts
+function isRedisUrl(url2) {
+  let parsed;
+  try {
+    parsed = new URL(url2);
+  } catch {
+    return false;
+  }
+  if (parsed.protocol !== "redis:" && parsed.protocol !== "rediss:") {
+    return false;
+  }
+  if (!parsed.hostname) {
+    return false;
+  }
+  if (parsed.port && Number.isNaN(Number(parsed.port))) {
+    return false;
+  }
+  return true;
+}
+
+// src/utils/prompt-for-key.ts
+import inquirer from "inquirer";
+async function promptForKey() {
+  const keys = await client.keys("*");
+  if (keys.length === 0)
+    return null;
+  try {
+    const { selectedKey } = await inquirer.prompt({
+      type: "list",
+      name: "selectedKey",
+      message: "Select a key to view its value:",
+      choices: keys,
+      pageSize: 20,
+      theme: {
+        icon: {
+          cursor: ">"
+        },
+        prefix: "0_0"
+      }
+    });
+    return selectedKey;
+  } catch {
+    await gracefulExit(0);
+  }
+}
+
+// src/utils/view-key.ts
+import boxen from "boxen";
+import highlight from "cli-highlight";
+import clipboardy from "clipboardy";
+import readline from "readline";
+import pc from "picocolors";
+
+// src/utils/format-value.ts
+function formatValue(value) {
+  if (typeof value === "object" && value !== null) {
+    return JSON.stringify(value, null, 2);
+  }
+  if (typeof value === "string") {
+    try {
+      return JSON.stringify(JSON.parse(value), null, 2);
+    } catch {
+      return value;
+    }
+  }
+  return String(value);
+}
+
+// src/utils/get-value.ts
+async function getValue(selectedKey, type) {
+  switch (type) {
+    case "string":
+      return client.get(selectedKey);
+    case "hash":
+      return client.hGetAll(selectedKey);
+    case "list":
+      return client.lRange(selectedKey, 0, -1);
+    case "set":
+      return client.sMembers(selectedKey);
+    case "zset":
+      return client.zRangeWithScores(selectedKey, 0, -1);
+    default:
+      return "(unsupported type)";
+  }
+}
+
+// src/utils/view-key.ts
+async function viewKey(selectedKey) {
+  const type = await client.type(selectedKey);
+  const value = await getValue(selectedKey, type);
+  cleanup();
+  console.log(
+    boxen(highlight(formatValue(value), { language: "json", ignoreIllegals: true }), {
+      borderColor: "cyan",
+      padding: 1,
+      title: selectedKey,
+      borderStyle: "round"
+    })
+  );
+  console.log(pc.blue("Press 'd' to delete, 'c' to copy, \u2190 to go back, Ctrl+C to quit."));
+  readline.emitKeypressEvents(process.stdin);
+  try {
+    process.stdin.resume();
+  } catch {
+  }
+  if (process.stdin.isTTY) {
+    process.stdin.setRawMode(true);
+  }
+  return await new Promise((resolve) => {
+    const onKeypress = async (str, key) => {
+      if (!key) {
+        return;
+      }
+      if (key.name === "d" && !key.ctrl && !key.meta) {
+        try {
+          await client.del(selectedKey);
+        } catch {
+          console.error(pc.red("Delete failed:"));
+        }
+        cleanup();
+        resolve("deleted");
+        return;
+      }
+      if (key.name === "c" && !key.ctrl && !key.meta) {
+        try {
+          clipboardy.writeSync(formatValue(value));
+          cleanup();
+          resolve("back");
+        } catch (e) {
+          console.error(pc.red("Copy failed:"), e);
+        }
+        return;
+      }
+      if (key.name === "left") {
+        cleanup();
+        resolve("back");
+        return;
+      }
+      if (key.ctrl && key.name === "c" || key.sequence === "") {
+        cleanup();
+        resolve("quit");
+      }
+    };
+    const onData = async (chunk) => {
+      const s = chunk.toString();
+      if (s.includes("")) {
+        cleanup();
+        resolve("quit");
+      }
+    };
+    process.stdin.on("keypress", onKeypress);
+    process.stdin.on("data", onData);
+  });
+}
+
+// src/index.ts
+var cli = meow(
+  `
+	Usage
+	   foo <url>
+`,
+  {
+    importMeta: import.meta
+  }
+);
+var [url] = cli.input;
+if (!url) {
+  console.log(cli.help);
+  process.exit(1);
+}
+if (!isRedisUrl(url)) {
+  console.log(cli.help);
+  console.log(pc2.red("Provided URL is not a valid Redis URL"));
+  process.exit(1);
+}
+var client = createClient({ url });
+async function main() {
+  try {
+    cleanup();
+    await client.connect();
+    while (true) {
+      const selectedKey = await promptForKey();
+      if (!selectedKey) {
+        console.log("No keys in Redis!");
+        await client.quit();
+        process.exit(0);
+      }
+      const action = await viewKey(selectedKey);
+      if (action === "quit") {
+        await gracefulExit(0);
+      } else if (action === "deleted") {
+        continue;
+      } else if (action === "back") {
+        continue;
+      }
+    }
+  } catch (err) {
+    console.error(pc2.red("Unexpected error:"), err);
+    try {
+      await client.quit();
+    } catch {
+      process.exit(1);
+    }
+  }
+}
+main();
+export {
+  client
+};

package/eslint.config.js

@@ -0,0 +1,28 @@
+import antfu from "@antfu/eslint-config";
+
+export default antfu({
+  type: "app",
+  typescript: true,
+  formatters: true,
+  stylistic: {
+    indent: 2,
+    semi: true,
+    quotes: "double",
+  },
+}, {
+  rules: {
+    "ts/no-redeclare": "off",
+    "ts/consistent-type-definitions": ["error", "type"],
+    "no-console": ["off"],
+    "antfu/no-top-level-await": ["off"],
+    "node/prefer-global/process": ["off"],
+    "node/no-process-env": ["off"],
+    "perfectionist/sort-imports": ["error", {
+      tsconfigRootDir: ".",
+    }],
+    "unicorn/filename-case": ["error", {
+      case: "kebabCase",
+      ignore: ["README.md"],
+    }],
+  },
+});

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "kami-redis",
+  "type": "module",
+  "version": "2.0.0",
+  "description": "Browse, inspect, copy, and delete Redis keys from your CLI",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "dev": "bun run --watch src/index.ts",
+    "build": "tsup src/index.ts",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "release": "bun run build && changeset publish",
+    "change": "changeset"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "boxen": "^8.0.1",
+    "cli-highlight": "^2.1.11",
+    "clipboardy": "^5.0.0",
+    "inquirer": "^12.9.6",
+    "meow": "^14.0.0",
+    "picocolors": "^1.1.1",
+    "redis": "^5.8.2"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^5.4.1",
+    "@changesets/cli": "^2.29.7",
+    "@types/bun": "latest",
+    "eslint": "^9.36.0",
+    "eslint-plugin-format": "^1.0.2",
+    "tsup": "^8.5.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,74 @@
+/* eslint-disable style/no-tabs */
+import meow from "meow";
+import pc from "picocolors";
+import { createClient } from "redis";
+
+import { cleanup } from "./utils/clean-up";
+import { gracefulExit } from "./utils/graceful-exit";
+import { isRedisUrl } from "./utils/is-redis-url";
+import { promptForKey } from "./utils/prompt-for-key";
+import { viewKey } from "./utils/view-key";
+
+const cli = meow(
+  `
+	Usage
+	   foo <url>
+`,
+  {
+    importMeta: import.meta,
+  },
+);
+
+const [url] = cli.input;
+
+if (!url) {
+  console.log(cli.help);
+  process.exit(1);
+}
+
+if (!isRedisUrl(url)) {
+  console.log(cli.help);
+  console.log(pc.red("Provided URL is not a valid Redis URL"));
+  process.exit(1);
+}
+
+export const client = createClient({ url });
+
+async function main() {
+  try {
+    cleanup();
+    await client.connect();
+
+    while (true) {
+      const selectedKey = await promptForKey();
+      if (!selectedKey) {
+        console.log("No keys in Redis!");
+        await client.quit();
+        process.exit(0);
+      }
+
+      const action = await viewKey(selectedKey);
+
+      if (action === "quit") {
+        await gracefulExit(0);
+      }
+      else if (action === "deleted") {
+        continue;
+      }
+      else if (action === "back") {
+        continue;
+      }
+    }
+  }
+  catch (err) {
+    console.error(pc.red("Unexpected error:"), err);
+    try {
+      await client.quit();
+    }
+    catch {
+      process.exit(1);
+    }
+  }
+}
+
+main();

package/src/utils/clean-up.ts

@@ -0,0 +1,3 @@
+export function cleanup() {
+  return console.clear();
+}

package/src/utils/format-value.ts

@@ -0,0 +1,16 @@
+export function formatValue(value: unknown): string {
+  if (typeof value === "object" && value !== null) {
+    return JSON.stringify(value, null, 2);
+  }
+
+  if (typeof value === "string") {
+    try {
+      return JSON.stringify(JSON.parse(value), null, 2);
+    }
+    catch {
+      return value;
+    }
+  }
+
+  return String(value);
+}

package/src/utils/get-value.ts

@@ -0,0 +1,18 @@
+import { client } from "..";
+
+export async function getValue(selectedKey: string, type: string): Promise<unknown> {
+  switch (type) {
+    case "string":
+      return client.get(selectedKey);
+    case "hash":
+      return client.hGetAll(selectedKey);
+    case "list":
+      return client.lRange(selectedKey, 0, -1);
+    case "set":
+      return client.sMembers(selectedKey);
+    case "zset":
+      return client.zRangeWithScores(selectedKey, 0, -1);
+    default:
+      return "(unsupported type)";
+  }
+}

package/src/utils/graceful-exit.ts

@@ -0,0 +1,24 @@
+import { client } from "..";
+import { cleanup } from "./clean-up";
+
+export async function gracefulExit(code = 0) {
+  try {
+    if (process.stdin.isTTY) {
+      try {
+        process.stdin.setRawMode(false);
+      }
+      catch {}
+    }
+    try {
+      process.stdin.pause();
+    }
+    catch {
+      await client.quit();
+    }
+  }
+  catch {}
+  finally {
+    cleanup();
+    process.exit(code);
+  }
+}

package/src/utils/is-redis-url.ts

@@ -0,0 +1,23 @@
+export function isRedisUrl(url: string): boolean {
+  let parsed;
+  try {
+    parsed = new URL(url);
+  }
+  catch {
+    return false;
+  }
+
+  if (parsed.protocol !== "redis:" && parsed.protocol !== "rediss:") {
+    return false;
+  }
+
+  if (!parsed.hostname) {
+    return false;
+  }
+
+  if (parsed.port && Number.isNaN(Number(parsed.port))) {
+    return false;
+  }
+
+  return true;
+}

package/src/utils/prompt-for-key.ts

@@ -0,0 +1,30 @@
+import inquirer from "inquirer";
+
+import { client } from "..";
+import { gracefulExit } from "./graceful-exit";
+
+export async function promptForKey() {
+  const keys = await client.keys("*");
+  if (keys.length === 0)
+    return null;
+
+  try {
+    const { selectedKey } = await inquirer.prompt({
+      type: "list",
+      name: "selectedKey",
+      message: "Select a key to view its value:",
+      choices: keys,
+      pageSize: 20,
+      theme: {
+        icon: {
+          cursor: ">",
+        },
+        prefix: "0_0",
+      },
+    });
+    return selectedKey;
+  }
+  catch {
+    await gracefulExit(0);
+  }
+}

package/src/utils/view-key.ts

@@ -0,0 +1,95 @@
+import type { Buffer } from "node:buffer";
+
+import boxen from "boxen";
+import highlight from "cli-highlight";
+import clipboardy from "clipboardy";
+import readline from "node:readline";
+import pc from "picocolors";
+
+import { client } from "..";
+import { cleanup } from "./clean-up";
+import { formatValue } from "./format-value";
+import { getValue } from "./get-value";
+
+export async function viewKey(selectedKey: string): Promise<"back" | "deleted" | "quit"> {
+  const type = await client.type(selectedKey);
+
+  const value = await getValue(selectedKey, type);
+
+  cleanup();
+
+  console.log(
+    boxen(highlight(formatValue(value), { language: "json", ignoreIllegals: true }), {
+      borderColor: "cyan",
+      padding: 1,
+      title: selectedKey,
+      borderStyle: "round",
+    }),
+  );
+  console.log(pc.blue("Press 'd' to delete, 'c' to copy, ← to go back, Ctrl+C to quit."));
+
+  readline.emitKeypressEvents(process.stdin);
+
+  try {
+    process.stdin.resume();
+  }
+
+  catch {}
+  if (process.stdin.isTTY) {
+    process.stdin.setRawMode(true);
+  }
+
+  return await new Promise((resolve) => {
+    const onKeypress = async (str: string, key: readline.Key) => {
+      if (!key) {
+        return;
+      }
+
+      if (key.name === "d" && !key.ctrl && !key.meta) {
+        try {
+          await client.del(selectedKey);
+        }
+        catch {
+          console.error(pc.red("Delete failed:"));
+        }
+        cleanup();
+        resolve("deleted");
+        return;
+      }
+
+      if (key.name === "c" && !key.ctrl && !key.meta) {
+        try {
+          clipboardy.writeSync(formatValue(value));
+          cleanup();
+          resolve("back");
+        }
+        catch (e) {
+          console.error(pc.red("Copy failed:"), e);
+        }
+        return;
+      }
+
+      if (key.name === "left") {
+        cleanup();
+        resolve("back");
+        return;
+      }
+
+      if ((key.ctrl && key.name === "c") || key.sequence === "\u0003") {
+        cleanup();
+        resolve("quit");
+      }
+    };
+
+    const onData = async (chunk: Buffer | string) => {
+      const s = chunk.toString();
+      if (s.includes("\u0003")) {
+        cleanup();
+        resolve("quit");
+      }
+    };
+
+    process.stdin.on("keypress", onKeypress);
+    process.stdin.on("data", onData);
+  });
+}

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "jsx": "react-jsx",
+
+    "lib": ["ESNext"],
+    "moduleDetection": "force",
+    "module": "Preserve",
+
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "allowJs": true,
+
+    "strict": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+
+    "noPropertyAccessFromIndexSignature": false,
+    "noUncheckedIndexedAccess": true,
+
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noEmit": true,
+    "verbatimModuleSyntax": true,
+    "skipLibCheck": true
+  }
+}

package/tsup.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  outDir: "dist",
+  clean: true,
+  format: ["esm"],
+  dts: true,
+});