Merge pull request #15 from udithavithanage/feature/saved-folders-remove-update

Add update and remove commands to CLI

Author: udithavithanage

README.md

@@ -44,7 +44,6 @@ thyra config api /var/www/company/api
 
 # Open instantly
 thyra open blog
-
 # See everything you saved
 thyra list
 
@@ -110,6 +109,34 @@ v1.0.5
 
 This shows the currently installed version of **thyra**.
 
+### Update a saved project
+
+```bash
+thyra update <name> <path>
+```
+
+Update the stored path for an existing alias. The folder must exist on disk.
+
+**Example**
+
+```bash
+thyra update blog ~/projects/personal-blog-v2
+```
+
+### Remove a saved project
+
+```bash
+thyra remove <name>
+```
+
+Remove an alias from your saved mappings. This cannot be undone except by re-running `thyra config`.
+
+**Example**
+
+```bash
+thyra remove api
+```
+
 ### Help
 
 ```bash

package.json

@@ -1,6 +1,6 @@
 {
   "name": "thyra",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Simple project folder opener CLI",
   "type": "module",
   "bin": {

src/cli.ts

@@ -3,6 +3,8 @@ import { runVersion } from "~/commands/version";
 import { runOpen } from "~/commands/open";
 import { runList } from "~/commands/list";
 import { runHelp } from "~/commands/help";
+import { runRemove } from "~/commands/remove";
+import { runUpdate as runUpdateCmd } from "~/commands/update";
 
 import { getConfigFilePath, ConfigStore } from "~/configStore";
 
@@ -32,6 +34,12 @@ import { getConfigFilePath, ConfigStore } from "~/configStore";
     case "open":
       runOpen(store, rest);
       break;
+    case "remove":
+      runRemove(store, rest);
+      break;
+    case "update":
+      runUpdateCmd(store, rest);
+      break;
     case "list":
       runList(store);
       break;

src/commands/config.ts

@@ -1,27 +1,5 @@
-import fs from "node:fs";
-import os from "node:os";
-import path from "node:path";
-
 import type { ConfigStore } from "~/configStore";
-
-function resolveFolderPath(inputPath: string): string {
-  let folderPath = inputPath.replace(/^~(?=$|[\\/])/, os.homedir());
-  folderPath = path.resolve(folderPath);
-  return folderPath;
-}
-
-function ensureDirectoryExists(folderPath: string): void {
-  if (!fs.existsSync(folderPath)) {
-    console.error(`Folder does not exist: ${folderPath}`);
-    process.exit(1);
-  }
-
-  const stat = fs.statSync(folderPath);
-  if (!stat.isDirectory()) {
-    console.error(`Path is not a directory: ${folderPath}`);
-    process.exit(1);
-  }
-}
+import { resolveFolderPath, ensureDirectoryExists } from "~/utils/path";
 
 export function runConfig(store: ConfigStore, args: string[]): void {
   const name = args[0];

src/commands/help.ts

@@ -5,8 +5,8 @@ import { colorize, printCommandTable } from "~/color-logs";
 export function runHelp(exitCode: number) {
   console.log(
     `\n${color.bold(color.cyan("thyra"))} ${color.dim(
-      "- Quick shortcut manager for project folders",
-    )}\n`,
+      "- Quick shortcut manager for project folders"
+    )}\n`
   );
 
   const rows = [
@@ -18,6 +18,14 @@ export function runHelp(exitCode: number) {
       Command: colorize("thyra open <name>"),
       Description: "Open folder in your editor",
     },
+    {
+      Command: colorize("thyra update <name> <folder_path>"),
+      Description: "Update an existing saved path",
+    },
+    {
+      Command: colorize("thyra remove <name>"),
+      Description: "Remove a saved path",
+    },
     { Command: colorize("thyra list"), Description: "Show all saved paths" },
     { Command: colorize("thyra --version"), Description: "Show CLI version" },
     { Command: colorize("thyra --help"), Description: "Show this help" },
@@ -27,15 +35,25 @@ export function runHelp(exitCode: number) {
 
   console.log(
     `\n${color.bold(color.underline("Examples:"))}
-  ${colorize("thyra config <name> <folder_path>")}   ${color.dim("# Save a path")}
+  ${colorize("thyra config <name> <folder_path>")}   ${color.dim(
+      "# Save a path"
+    )}
   ${colorize("thyra open <name>")}                   ${color.dim(
-    "# Open in editor",
-  )}
+      "# Open in editor"
+    )}
+  ${colorize("thyra update <name> <folder_path>")} ${color.dim(
+      "# Update an existing saved path"
+    )}
+  ${colorize("thyra remove <name>")}               ${color.dim(
+      "# Remove a saved path"
+    )}
   ${colorize("thyra --version")}
 
 ${color.bold(color.underline("Environment:"))}
-  ${color.cyan("THYRA_EDITOR")}  ${color.dim('Editor command (default: "code")')}
-`,
+  ${color.cyan("THYRA_EDITOR")}  ${color.dim(
+      'Editor command (default: "code")'
+    )}
+`
   );
 
   if (typeof exitCode === "number") process.exit(exitCode);

src/commands/open.ts

@@ -21,7 +21,7 @@ function openInEditor(folderPath: string) {
 
     if (error && editorCmd !== "explorer") {
       console.error(
-        `Failed to start editor "${editorCmd}". Is it installed and on your PATH?`,
+        `Failed to start editor "${editorCmd}". Is it installed and on your PATH?`
       );
       console.error(error.message);
       process.exit(1);
@@ -33,19 +33,7 @@ function openInEditor(folderPath: string) {
 }
 
 import type { ConfigStore } from "~/configStore";
-
-function ensureDirectoryExists(folderPath: string): void {
-  if (!fs.existsSync(folderPath)) {
-    console.error(`Folder does not exist: ${folderPath}`);
-    process.exit(1);
-  }
-
-  const stat = fs.statSync(folderPath);
-  if (!stat.isDirectory()) {
-    console.error(`Path is not a directory: ${folderPath}`);
-    process.exit(1);
-  }
-}
+import { ensureDirectoryExists } from "~/utils/path";
 
 export function runOpen(store: ConfigStore, args: string[]): void {
   const name = args[0];
@@ -57,7 +45,7 @@ export function runOpen(store: ConfigStore, args: string[]): void {
 
   if (!store.has(name)) {
     console.error(
-      `No folder found for name "${name}". Use 'thyra list' to see saved entries.`,
+      `No folder found for name "${name}". Use 'thyra list' to see saved entries.`
     );
     process.exit(1);
   }

src/commands/remove.ts

@@ -0,0 +1,21 @@
+import type { ConfigStore } from "~/configStore";
+
+export function runRemove(store: ConfigStore, args: string[]): void {
+  const name = args[0];
+
+  if (!name) {
+    console.error("Missing <name> argument for 'remove' command.");
+    console.log("Usage: thyra remove <name>");
+    process.exit(1);
+  }
+
+  if (!store.has(name)) {
+    console.error(
+      `No folder found for name "${name}". Use 'thyra list' to see saved entries.`
+    );
+    process.exit(1);
+  }
+
+  store.delete(name);
+  console.log(`Removed mapping: "${name}"`);
+}

src/commands/update.ts

@@ -0,0 +1,26 @@
+import type { ConfigStore } from "~/configStore";
+import { resolveFolderPath, ensureDirectoryExists } from "~/utils/path";
+
+export function runUpdate(store: ConfigStore, args: string[]): void {
+  const name = args[0];
+  const folderArg = args[1];
+
+  if (!name || !folderArg) {
+    console.error("Missing arguments for 'update' command.");
+    console.log("Usage: thyra update <name> <folder_path>");
+    process.exit(1);
+  }
+
+  if (!store.has(name)) {
+    console.error(
+      `No folder found for name "${name}". Use 'thyra list' to see saved entries.`
+    );
+    process.exit(1);
+  }
+
+  const folderPath = resolveFolderPath(folderArg);
+  ensureDirectoryExists(folderPath);
+
+  store.set(name, folderPath);
+  console.log(`Updated mapping: "${name}" -> ${folderPath}`);
+}

src/configStore.ts

@@ -73,7 +73,7 @@ export class ConfigStore {
       fs.writeFileSync(
         this.filePath,
         JSON.stringify(this.data, null, 2),
-        "utf8",
+        "utf8"
       );
     } catch (err) {
       const error = err as Error;
@@ -95,6 +95,13 @@ export class ConfigStore {
     return Object.prototype.hasOwnProperty.call(this.data, key);
   }
 
+  delete(key: string): void {
+    if (this.has(key)) {
+      delete this.data[key];
+      this.save();
+    }
+  }
+
   all(): Record<string, string> {
     return { ...this.data };
   }

src/utils/path.ts

@@ -0,0 +1,22 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
+export function resolveFolderPath(inputPath: string): string {
+  let folderPath = inputPath.replace(/^~(?=$|[\\/])/, os.homedir());
+  folderPath = path.resolve(folderPath);
+  return folderPath;
+}
+
+export function ensureDirectoryExists(folderPath: string): void {
+  if (!fs.existsSync(folderPath)) {
+    console.error(`Folder does not exist: ${folderPath}`);
+    process.exit(1);
+  }
+
+  const stat = fs.statSync(folderPath);
+  if (!stat.isDirectory()) {
+    console.error(`Path is not a directory: ${folderPath}`);
+    process.exit(1);
+  }
+}