feat: ✨ allow users to configure delimiter, improve help output

Author: evertdespiegeleer

readme.md

@@ -33,6 +33,7 @@ Configuration can be provided in multiple ways. In decreasing order of precedenc
 
 ### Environment variables
 - `RED_CONNECTION_STRING`: The Redis connection string (e.g. `redis://localhost:6379`)
+- `RED_DELIMITER`: The delimiter used to group keys (default: `:`)
 
 ### Configuration file
 A configuration file can be placed either in the directory where Red is executed, or in any higher-level directory, up to the user's home directory. Lower level configuration files take precedence over higher-level ones.
@@ -53,7 +54,7 @@ Use the json schema as reference for the configuration file structure. Mind the
 Below is an example `.redrc.json` file:
 ```json
 {
-    "$schema": "https://github.com/evertdespiegeleer/red-cli/releases/download/v0.0.5/redrc.schema.json",
+    "$schema": "https://github.com/evertdespiegeleer/red-cli/releases/download/v0.0.8/redrc.schema.json",
     "connectionString": "redis://localhost:6379"
 }
 ```

src/components/functional/browser/browser.tsx

@@ -3,6 +3,7 @@ import { useKeyboard } from "@opentui/react";
 import { useQuery } from "@tanstack/react-query";
 import clipboard from "clipboardy";
 import { useEffect, useRef, useState } from "react";
+import { getConfig } from "../../../config";
 import { useRegisterKeyBind } from "../../../contexts/registered-keybinds";
 import { getRedis } from "../../../redis";
 import { useRoute } from "../../../routing/provider";
@@ -242,7 +243,9 @@ export function Browser(props: Props) {
 		}
 		if (key.name === "escape") {
 			key.preventDefault();
-			const newRoute = props.path.split(":").slice(0, -1).join(":");
+			// Go up one level
+			const { delimiter } = getConfig();
+			const newRoute = props.path.split(delimiter).slice(0, -1).join(delimiter);
 			setRoute(new BrowserRoute(newRoute));
 		}
 	});

src/config.ts

@@ -6,21 +6,12 @@ import yargs from "yargs/yargs";
 import { z } from "zod";
 import { version } from "./version.json";
 
-type ConfigOption = {
-	shorthand?: string;
-};
-
-const configOptions = {
-	connectionString: {},
-} satisfies Record<string, ConfigOption>;
-
-type ConfigOptionNames = keyof typeof configOptions;
-
 declare module "zod" {
 	interface GlobalMeta {
 		hideFromSchema?: boolean;
 		description?: string;
 		shorthand?: string;
+		default?: unknown;
 	}
 }
 
@@ -33,7 +24,11 @@ export const zConfig = z.object({
 		.meta({
 			description: "The Redis connection string",
 		}),
-} satisfies Record<ConfigOptionNames, z.ZodTypeAny>);
+	delimiter: z.string().nonempty().default(":").meta({
+		description: "The delimiter used to group keys",
+		shorthand: "d",
+	}),
+});
 
 type Config = z.infer<typeof zConfig>;
 
@@ -71,6 +66,8 @@ export const loadConfig = () => {
 	let argv = yargs(hideBin(process.argv))
 		.config(configFileConfig)
 		.version(version)
+		.help()
+		.wrap(Math.min(120, process.stdout.columns - 1))
 		.env("RED");
 
 	for (const [configName, configOption] of Object.entries(zConfig.shape) as [
@@ -82,6 +79,7 @@ export const loadConfig = () => {
 			alias: metadata?.shorthand,
 			describe: metadata?.description,
 			type: configOption.def.innerType.type,
+			default: configOption.def.defaultValue,
 		});
 	}
 	config = zConfig.parse(argv.argv);

src/util/redis-get-grouped-keys.ts

@@ -1,3 +1,4 @@
+import { getConfig } from "../config";
 import type { getRedis } from "../redis";
 
 export type KeyReturnType = {
@@ -8,30 +9,35 @@ export type KeyReturnType = {
 };
 
 export class RedisUtils {
+	private delimiter: string = ":";
+
 	constructor(
 		private redis: ReturnType<typeof getRedis>,
 		private path: string,
 	) {
-		if (path.endsWith(":")) {
-			throw new Error("Path should not end with a colon");
+		const { delimiter } = getConfig();
+		this.delimiter = delimiter;
+		if (path.endsWith(delimiter)) {
+			throw new Error(`Path should not end with delimiter ${this.delimiter}`);
 		}
 	}
 
 	getChildKeys = (params: { depth: number }) => {
 		const keys = new Set<KeyReturnType>();
 		const scanStream = this.redis.scanStream({
-			match: [this.path, "*"].filter(Boolean).join(":"),
+			match: [this.path, "*"].filter(Boolean).join(this.delimiter),
 		});
 
 		return new Promise<KeyReturnType[]>((resolve, reject) => {
 			scanStream.on("end", () => resolve(Array.from(keys)));
 			scanStream.on("error", (error) => reject(error));
 			scanStream.on("data", (bunchOfKeys: string[]) => {
 				for (const fullKey of bunchOfKeys) {
-					const pathPrefix = this.path.length > 0 ? `${this.path}:` : "";
+					const pathPrefix =
+						this.path.length > 0 ? `${this.path}${this.delimiter}` : "";
 					const relativeKey = fullKey.slice(pathPrefix.length);
 
-					const relativeKeySections = relativeKey.split(":");
+					const relativeKeySections = relativeKey.split(this.delimiter);
 
 					if (relativeKeySections.length <= params.depth) {
 						keys.add({
@@ -54,16 +60,20 @@ export class RedisUtils {
 		const relevantKeys = await this.getChildKeys({ depth: params.depth + 1 });
 		for (const key of relevantKeys) {
 			// Remove the last section to get the group name
-			const fullPath = key.fullPath.split(":").slice(0, -1).join(":");
-			const pathPrefix = this.path.length > 0 ? `${this.path}:` : "";
+			const fullPath = key.fullPath
+				.split(this.delimiter)
+				.slice(0, -1)
+				.join(this.delimiter);
+			const pathPrefix =
+				this.path.length > 0 ? `${this.path}${this.delimiter}` : "";
 			const relativePath = fullPath.slice(pathPrefix.length);
 			if (relativePath === "") {
 				continue;
 			}
 			groups.set(fullPath, {
 				fullPath,
 				relativePath,
-				baseName: relativePath.split(":").slice(-1)[0],
+				baseName: relativePath.split(this.delimiter).slice(-1)[0],
 				isGroup: true,
 			});
 		}