Merge pull request #13 from snelusha/feat/migrate-ts

udithavithanage · web-flow · commit 810d6c66928c · 2025-11-29T10:45:24.000+05:30
feat: migrate to TypeScript
diff --git a/bin/thyra.js b/bin/thyra.js
diff --git a/bun.lock b/bun.lock
diff --git a/package.json b/package.json
@@ -4,12 +4,17 @@
   "description": "Simple project folder opener CLI",
   "type": "module",
   "bin": {
-    "thyra": "./bin/thyra.js"
+    "thyra": "dist/cli.js"
   },
   "scripts": {
-    "start": "node ./bin/thyra.js",
+    "build": "bun build ./src/cli.ts --outdir ./dist --target node --banner '#!/usr/bin/env node' --minify",
+    "start": "node ./dist/cli.js",
     "lint": "eslint ."
   },
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "engines": {
     "node": ">=18.0.0"
   },
@@ -29,5 +34,10 @@
   "bugs": {
     "url": "https://github.com/udithavithanage/thyra/issues"
   },
-  "homepage": "https://github.com/udithavithanage/thyra#readme"
+  "homepage": "https://github.com/udithavithanage/thyra#readme",
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "bun": "^1.3.3",
+    "typescript": "^5.9.3"
+  }
 }
diff --git a/src/cli.ts b/src/cli.ts
@@ -1,10 +1,10 @@
-import { ConfigStore } from "./configStore.js";
-import { runConfig } from "./commands/config.js";
-import { runVersion } from "./commands/version.js";
-import { runOpen } from "./commands/open.js";
-import { runList } from "./commands/list.js";
-import { runHelp } from "./commands/help.js";
-import { getConfigFilePath } from "./configStore.js";
+import { runConfig } from "~/commands/config";
+import { runVersion } from "~/commands/version";
+import { runOpen } from "~/commands/open";
+import { runList } from "~/commands/list";
+import { runHelp } from "~/commands/help";
+
+import { getConfigFilePath, ConfigStore } from "~/configStore";
 
 (function run() {
   const [, , command, ...rest] = process.argv;
diff --git a/src/commands/config.ts b/src/commands/config.ts
@@ -2,13 +2,15 @@ import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
 
-function resolveFolderPath(inputPath) {
+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) {
+function ensureDirectoryExists(folderPath: string): void {
   if (!fs.existsSync(folderPath)) {
     console.error(`Folder does not exist: ${folderPath}`);
     process.exit(1);
@@ -21,7 +23,7 @@ function ensureDirectoryExists(folderPath) {
   }
 }
 
-export function runConfig(store, args) {
+export function runConfig(store: ConfigStore, args: string[]): void {
   const name = args[0];
   const folderArg = args[1];
 
diff --git a/src/commands/help.ts b/src/commands/help.ts
@@ -1,4 +1,4 @@
-export function runHelp(exitCode) {
+export function runHelp(exitCode?: number): void {
   console.log(`
 thyra - Quick shortcut manager for project folders
 `);
diff --git a/src/commands/list.ts b/src/commands/list.ts
@@ -1,4 +1,6 @@
-export function runList(store) {
+import type { ConfigStore } from "~/configStore";
+
+export function runList(store: ConfigStore): void {
   const all = store.all();
   const keys = Object.keys(all);
 
diff --git a/src/commands/open.ts b/src/commands/open.ts
@@ -1,7 +1,9 @@
 import fs from "node:fs";
-import { openInEditor } from "../editor.js";
+import { openInEditor } from "~/editor.js";
 
-function ensureDirectoryExists(folderPath) {
+import type { ConfigStore } from "~/configStore";
+
+function ensureDirectoryExists(folderPath: string): void {
   if (!fs.existsSync(folderPath)) {
     console.error(`Folder does not exist: ${folderPath}`);
     process.exit(1);
@@ -14,7 +16,7 @@ function ensureDirectoryExists(folderPath) {
   }
 }
 
-export function runOpen(store, args) {
+export function runOpen(store: ConfigStore, args: string[]): void {
   const name = args[0];
   if (!name) {
     console.error("Missing <name> argument for 'open' command.");
@@ -24,12 +26,17 @@ export function runOpen(store, args) {
 
   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);
   }
 
   const folderPath = store.get(name);
+  if (!folderPath) {
+    console.error(`Invalid folder path for name "${name}".`);
+    process.exit(1);
+  }
+
   ensureDirectoryExists(folderPath);
   openInEditor(folderPath);
 }
diff --git a/src/commands/version.js b/src/commands/version.js
diff --git a/src/commands/version.ts b/src/commands/version.ts
@@ -0,0 +1,5 @@
+import { version } from "package" assert { type: "json" };
+
+export function runVersion(): void {
+  console.log(`v${version}`);
+}
diff --git a/src/configStore.ts b/src/configStore.ts
@@ -5,15 +5,15 @@ import path from "node:path";
 const CONFIG_FILE_NAME = "thyra.json";
 const APP_DIR_NAME = "thyra";
 
-export function getConfigFilePath() {
+export function getConfigFilePath(): string {
   const homeDir = os.homedir();
 
   if (!homeDir) {
     console.error("Could not determine home directory.");
     process.exit(1);
   }
 
-  let baseConfigDir;
+  let baseConfigDir: string;
 
   if (process.platform === "win32") {
     baseConfigDir =
@@ -33,12 +33,15 @@ export function getConfigFilePath() {
 }
 
 export class ConfigStore {
-  constructor(filePath) {
+  private filePath: string;
+  private data: Record<string, string>;
+
+  constructor(filePath: string) {
     this.filePath = filePath;
     this.data = this.load();
   }
 
-  load() {
+  private load(): Record<string, string> {
     if (!fs.existsSync(this.filePath)) {
       return {};
     }
@@ -52,38 +55,40 @@ export class ConfigStore {
       console.warn("Config file is not an object. Resetting.");
       return {};
     } catch (err) {
-      console.warn("Failed to read config file. Resetting.", err.message);
+      const error = err as Error;
+      console.warn("Failed to read config file. Resetting.", error.message);
       return {};
     }
   }
 
-  save() {
+  private save(): void {
     try {
       fs.writeFileSync(
         this.filePath,
         JSON.stringify(this.data, null, 2),
         "utf8"
       );
     } catch (err) {
-      console.error("Failed to save config file:", err.message);
+      const error = err as Error;
+      console.error("Failed to save config file:", error.message);
       process.exit(1);
     }
   }
 
-  set(key, value) {
+  set(key: string, value: string): void {
     this.data[key] = value;
     this.save();
   }
 
-  get(key) {
+  get(key: string): string | undefined {
     return this.data[key];
   }
 
-  has(key) {
+  has(key: string): boolean {
     return Object.prototype.hasOwnProperty.call(this.data, key);
   }
 
-  all() {
+  all(): Record<string, string> {
     return { ...this.data };
   }
 }
diff --git a/src/editor.ts b/src/editor.ts
@@ -1,6 +1,6 @@
 import { exec } from "node:child_process";
 
-export function openInEditor(folderPath) {
+export function openInEditor(folderPath: string): void {
   const editorCmd = process.env.THYRA_EDITOR || "code";
   let safePath = folderPath;
   if (editorCmd.trim() != "explorer") {
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "lib": ["ES2022"],
+    "moduleResolution": "node",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "baseUrl": ".",
+    "paths": {
+      "~/*": ["src/*"],
+      "package": ["package.json"]
+    },
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "types": ["node"],
+    "preserveConstEnums": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-export function runHelp(exitCode) {`
	`1`	`+export function runHelp(exitCode?: number): void {`
`2`	`2`	console.log(`
`3`	`3`	`thyra - Quick shortcut manager for project folders`
`4`	`4`	`);