unity-hub-cli 0.18.0 → 0.20.0

package/README.md

@@ -46,7 +46,7 @@ On standalone Git Bash (MinTTY), raw mode is not supported; use PowerShell/CMD/W
 | `i` | Launch external editor only |
 | `q` | Quit Unity for selected project |
 | `r` | Refresh project list |
-| `c` | Copy project path to clipboard |
+| `c` | Copy project path to clipboard (when launched via the `unity-hub` shell function, it will `cd` into the project directory and exit) |
 | `s` | Open sort settings panel |
 | `v` | Open visibility settings panel |
 | `Ctrl + C` | Exit |
@@ -60,6 +60,7 @@ The display includes Git branch (if present), Unity version, project path, and l
 - `--no-git-root-name`: Display Unity project titles instead of Git repository root folder names.
 - `--shell-init`: Install shell function for automatic `cd` integration (with confirmation prompt).
 - `--shell-init --dry-run`: Preview the shell function without installing.
+- `update`: Update the globally installed `unity-hub-cli` to the latest version (with a confirmation prompt). It runs: `npm install -g unity-hub-cli@latest --ignore-scripts --no-fund`.
 
 ## Shell Integration
 

package/dist/index.js

@@ -1,12 +1,13 @@
 #!/usr/bin/env node
 
 // src/index.tsx
-import { execSync } from "child_process";
+import { execSync, spawnSync } from "child_process";
 import { existsSync as existsSync3, mkdirSync, readFileSync, writeFileSync } from "fs";
 import { homedir } from "os";
 import { dirname as dirname2, join as join9 } from "path";
 import process3 from "process";
 import { createInterface as createInterface2 } from "readline";
+import { fileURLToPath } from "url";
 import chalk from "chalk";
 import { render } from "ink";
 
@@ -784,6 +785,38 @@ var MacUnityHubProjectsReader = class {
     };
     await writeFile(HUB_PROJECTS_PATH, JSON.stringify(json, void 0, 2), "utf8");
   }
+  async toggleFavorite(projectPath) {
+    let content;
+    try {
+      content = await readFile2(HUB_PROJECTS_PATH, "utf8");
+    } catch {
+      throw new Error(`Unity Hub project list not found (${HUB_PROJECTS_PATH}).`);
+    }
+    let json;
+    try {
+      json = JSON.parse(content);
+    } catch {
+      throw new Error("Unable to read the Unity Hub project list (permissions/format error).");
+    }
+    if (!json.data) {
+      return false;
+    }
+    const projectKey = Object.keys(json.data).find((key) => json.data?.[key]?.path === projectPath);
+    if (!projectKey) {
+      return false;
+    }
+    const original = json.data[projectKey];
+    if (!original) {
+      return false;
+    }
+    const newFavorite = original.isFavorite !== true;
+    json.data[projectKey] = {
+      ...original,
+      isFavorite: newFavorite
+    };
+    await writeFile(HUB_PROJECTS_PATH, JSON.stringify(json, void 0, 2), "utf8");
+    return newFavorite;
+  }
   async readCliArgs(projectPath) {
     const infoPath = `${process.env.HOME ?? ""}/Library/Application Support/UnityHub/projectsInfo.json`;
     let content;
@@ -915,6 +948,38 @@ var WinUnityHubProjectsReader = class {
     };
     await writeFile2(HUB_PROJECTS_PATH2, JSON.stringify(json, void 0, 2), "utf8");
   }
+  async toggleFavorite(projectPath) {
+    let content;
+    try {
+      content = await readFile3(HUB_PROJECTS_PATH2, "utf8");
+    } catch {
+      throw new Error(`Unity Hub project list not found (${HUB_PROJECTS_PATH2}).`);
+    }
+    let json;
+    try {
+      json = JSON.parse(content);
+    } catch {
+      throw new Error("Unable to read the Unity Hub project list (permissions/format error).");
+    }
+    if (!json.data) {
+      return false;
+    }
+    const projectKey = Object.keys(json.data).find((key) => json.data?.[key]?.path === projectPath);
+    if (!projectKey) {
+      return false;
+    }
+    const original = json.data[projectKey];
+    if (!original) {
+      return false;
+    }
+    const newFavorite = original.isFavorite !== true;
+    json.data[projectKey] = {
+      ...original,
+      isFavorite: newFavorite
+    };
+    await writeFile2(HUB_PROJECTS_PATH2, JSON.stringify(json, void 0, 2), "utf8");
+    return newFavorite;
+  }
   async readCliArgs(projectPath) {
     const infoPath = join6(HUB_DIR, "projectsInfo.json");
     let content;
@@ -1673,7 +1738,8 @@ var ProjectList = ({
       const rowIndex = startIndex + offset;
       const isSelected = rowIndex === selectedIndex;
       const selectionBar = isSelected ? "\u2503" : " ";
-      const projectName = formatProjectName(project.title, repository, useGitRootName);
+      const baseName = formatProjectName(project.title, repository, useGitRootName);
+      const projectName = project.favorite ? `\u2B51 ${baseName}` : baseName;
       const versionLabel = `(${project.version.value})`;
       const updatedText = formatUpdatedText(project.lastModified);
       const pathLine = shortenHomePath(project.path);
@@ -1993,11 +2059,11 @@ var extractRootFolder2 = (repository) => {
   return base || void 0;
 };
 var minimumVisibleProjectCount = 4;
-var defaultHintMessage = `j/k Select \xB7 [o]pen [O]+Editor [i]de [q]uit [r]efresh [c]opy [s]ort [v]isibility \xB7 ^C Exit`;
-var getCopyTargetPath = (view) => {
-  const root = view.repository?.root;
-  return root && root.length > 0 ? root : view.project.path;
+var buildDefaultHintMessage = (outputPathOnExit) => {
+  const cLabel = outputPathOnExit ? "cd" : "copy";
+  return `j/k Select \xB7 [o]pen [O]+Editor [i]de [q]uit [r]efresh [c]${cLabel} [f]av [s]ort [v]isibility \xB7 ^C Exit`;
 };
+var getCopyTargetPath = (view) => view.project.path;
 var App = ({
   projects,
   onLaunch,
@@ -2005,6 +2071,7 @@ var App = ({
   onLaunchEditorOnly,
   onTerminate,
   onRefresh,
+  onToggleFavorite,
   useGitRootName = true,
   outputPathOnExit = false,
   onSetExitPath
@@ -2012,6 +2079,10 @@ var App = ({
   const { exit } = useApp();
   const { stdout } = useStdout2();
   const colors = useThemeColors();
+  const defaultHintMessage = useMemo2(
+    () => buildDefaultHintMessage(outputPathOnExit),
+    [outputPathOnExit]
+  );
   const [projectViews, setProjectViews] = useState4(projects);
   const [isSortMenuOpen, setIsSortMenuOpen] = useState4(false);
   const [isVisibilityMenuOpen, setIsVisibilityMenuOpen] = useState4(false);
@@ -2172,15 +2243,21 @@ var App = ({
     });
   }, [index, limit, sortedProjects.length]);
   const copyProjectPath = useCallback(() => {
+    const actionLabel = outputPathOnExit ? "cd" : "copy";
     const projectView = sortedProjects[index];
     const projectPath = projectView ? getCopyTargetPath(projectView) : void 0;
     if (!projectPath) {
-      setHint("No project to copy");
+      setHint(`No project to ${actionLabel}`);
       setTimeout(() => {
         setHint(defaultHintMessage);
       }, 2e3);
       return;
     }
+    if (outputPathOnExit) {
+      onSetExitPath?.(projectPath);
+      exit();
+      return;
+    }
     try {
       const command = buildCdCommand(projectPath);
       clipboard.writeSync(command);
@@ -2193,7 +2270,7 @@ var App = ({
     setTimeout(() => {
       setHint(defaultHintMessage);
     }, 2e3);
-  }, [index, sortedProjects]);
+  }, [defaultHintMessage, exit, index, onSetExitPath, outputPathOnExit, sortedProjects]);
   const launchSelected = useCallback(async () => {
     const projectView = sortedProjects[index];
     if (!projectView) {
@@ -2248,7 +2325,7 @@ var App = ({
         setHint(defaultHintMessage);
       }, 3e3);
     }
-  }, [exit, index, onLaunch, onSetExitPath, outputPathOnExit, sortedProjects]);
+  }, [defaultHintMessage, exit, index, onLaunch, onSetExitPath, outputPathOnExit, sortedProjects]);
   const launchSelectedWithEditor = useCallback(async () => {
     if (!onLaunchWithEditor) {
       setHint("Launch with editor not available");
@@ -2310,7 +2387,7 @@ var App = ({
         setHint(defaultHintMessage);
       }, 3e3);
     }
-  }, [exit, index, onLaunchWithEditor, onSetExitPath, outputPathOnExit, sortedProjects]);
+  }, [defaultHintMessage, exit, index, onLaunchWithEditor, onSetExitPath, outputPathOnExit, sortedProjects]);
   const launchEditorOnly = useCallback(async () => {
     if (!onLaunchEditorOnly) {
       setHint("Launch editor only not available");
@@ -2341,7 +2418,7 @@ var App = ({
         setHint(defaultHintMessage);
       }, 3e3);
     }
-  }, [index, onLaunchEditorOnly, sortedProjects]);
+  }, [defaultHintMessage, index, onLaunchEditorOnly, sortedProjects]);
   const terminateSelected = useCallback(async () => {
     const projectView = sortedProjects[index];
     if (!projectView) {
@@ -2384,7 +2461,7 @@ var App = ({
         setHint(defaultHintMessage);
       }, 3e3);
     }
-  }, [index, onTerminate, sortedProjects]);
+  }, [defaultHintMessage, index, onTerminate, sortedProjects]);
   useEffect4(() => {
     setProjectViews(projects);
     setReleasedProjects(/* @__PURE__ */ new Set());
@@ -2442,7 +2519,44 @@ var App = ({
     } finally {
       setIsRefreshing(false);
     }
-  }, [isRefreshing, onRefresh, sortedProjects]);
+  }, [defaultHintMessage, isRefreshing, onRefresh, sortedProjects]);
+  const toggleFavoriteSelected = useCallback(async () => {
+    if (!onToggleFavorite) {
+      setHint("Toggle favorite not available");
+      setTimeout(() => {
+        setHint(defaultHintMessage);
+      }, 2e3);
+      return;
+    }
+    const projectView = sortedProjects[index];
+    if (!projectView) {
+      setHint("No project to toggle favorite");
+      setTimeout(() => {
+        setHint(defaultHintMessage);
+      }, 2e3);
+      return;
+    }
+    const { project } = projectView;
+    try {
+      const newFavorite = await onToggleFavorite(project);
+      setProjectViews(
+        (prev) => prev.map(
+          (pv) => pv.project.id === project.id ? { ...pv, project: { ...pv.project, favorite: newFavorite } } : pv
+        )
+      );
+      const status = newFavorite ? "added to" : "removed from";
+      setHint(`${project.title} ${status} favorites`);
+      setTimeout(() => {
+        setHint(defaultHintMessage);
+      }, 2e3);
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+      setHint(`Failed to toggle favorite: ${message}`);
+      setTimeout(() => {
+        setHint(defaultHintMessage);
+      }, 3e3);
+    }
+  }, [defaultHintMessage, index, onToggleFavorite, sortedProjects]);
   useInput((input, key) => {
     if (isSortMenuOpen) {
       if (key.escape || input === "\x1B") {
@@ -2563,6 +2677,10 @@ var App = ({
     }
     if (input === "c") {
       copyProjectPath();
+      return;
+    }
+    if (input === "f" || input === "F") {
+      void toggleFavoriteSelected();
     }
   });
   const { startIndex, visibleProjects } = useMemo2(() => {
@@ -2642,6 +2760,12 @@ var App = ({
 import { jsx as jsx7 } from "react/jsx-runtime";
 var SHELL_INIT_MARKER_START = "# >>> unity-hub-cli >>>";
 var SHELL_INIT_MARKER_END = "# <<< unity-hub-cli <<<";
+var getVersion = () => {
+  const currentDir = dirname2(fileURLToPath(import.meta.url));
+  const packageJsonPath = join9(currentDir, "..", "package.json");
+  const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+  return packageJson.version;
+};
 var getShellConfigPath = () => {
   const shell = process3.env["SHELL"] ?? "";
   const home = homedir();
@@ -2743,6 +2867,139 @@ var getUnityHubCliPath = () => {
   }
   return "unity-hub-cli";
 };
+var getNpmCommand = () => {
+  return process3.platform === "win32" ? "npm.cmd" : "npm";
+};
+var NPM_VIEW_TIMEOUT_MS = 3e4;
+var NPM_INSTALL_TIMEOUT_MS = 10 * 6e4;
+var parseSemver = (version) => {
+  const trimmed = version.trim().replace(/^v/i, "");
+  const match = /^(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?(?:\+([0-9A-Za-z.-]+))?$/.exec(trimmed);
+  if (!match) {
+    return void 0;
+  }
+  const major = Number(match[1]);
+  const minor = Number(match[2]);
+  const patch = Number(match[3]);
+  if (!Number.isFinite(major) || !Number.isFinite(minor) || !Number.isFinite(patch)) {
+    return void 0;
+  }
+  const prereleaseRaw = match[4];
+  const prerelease = prereleaseRaw ? prereleaseRaw.split(".").map((identifier) => {
+    const numeric = /^[0-9]+$/.test(identifier) ? Number(identifier) : void 0;
+    return typeof numeric === "number" && Number.isFinite(numeric) ? numeric : identifier;
+  }) : [];
+  return { major, minor, patch, prerelease };
+};
+var compareSemverIdentifiers = (a, b) => {
+  if (typeof a === "number" && typeof b === "number") {
+    return a === b ? 0 : a < b ? -1 : 1;
+  }
+  if (typeof a === "number" && typeof b === "string") {
+    return -1;
+  }
+  if (typeof a === "string" && typeof b === "number") {
+    return 1;
+  }
+  const aStr = String(a);
+  const bStr = String(b);
+  if (aStr === bStr) {
+    return 0;
+  }
+  return aStr < bStr ? -1 : 1;
+};
+var compareSemver = (a, b) => {
+  if (a.major !== b.major) {
+    return a.major < b.major ? -1 : 1;
+  }
+  if (a.minor !== b.minor) {
+    return a.minor < b.minor ? -1 : 1;
+  }
+  if (a.patch !== b.patch) {
+    return a.patch < b.patch ? -1 : 1;
+  }
+  const aHasPre = a.prerelease.length > 0;
+  const bHasPre = b.prerelease.length > 0;
+  if (!aHasPre && !bHasPre) {
+    return 0;
+  }
+  if (!aHasPre && bHasPre) {
+    return 1;
+  }
+  if (aHasPre && !bHasPre) {
+    return -1;
+  }
+  const length = Math.max(a.prerelease.length, b.prerelease.length);
+  for (let i = 0; i < length; i += 1) {
+    const aId = a.prerelease[i];
+    const bId = b.prerelease[i];
+    if (aId === void 0 && bId === void 0) {
+      return 0;
+    }
+    if (aId === void 0) {
+      return -1;
+    }
+    if (bId === void 0) {
+      return 1;
+    }
+    const cmp = compareSemverIdentifiers(aId, bId);
+    if (cmp !== 0) {
+      return cmp;
+    }
+  }
+  return 0;
+};
+var readLatestVersionFromNpm = () => {
+  const npmCommand = getNpmCommand();
+  const result = spawnSync(npmCommand, ["view", "unity-hub-cli", "version"], {
+    encoding: "utf-8",
+    stdio: ["ignore", "pipe", "pipe"],
+    timeout: NPM_VIEW_TIMEOUT_MS
+  });
+  if (result.signal) {
+    return { ok: false, reason: "timeout" };
+  }
+  if (result.error) {
+    const errorCode = result.error.code;
+    if (errorCode === "ETIMEDOUT") {
+      return { ok: false, reason: "timeout" };
+    }
+    return { ok: false, reason: "spawn_failed" };
+  }
+  if (typeof result.status === "number" && result.status !== 0) {
+    return { ok: false, reason: "nonzero_exit" };
+  }
+  const version = result.stdout.trim();
+  if (!version) {
+    return { ok: false, reason: "empty_output" };
+  }
+  return { ok: true, version };
+};
+var installLatestVersionGlobally = () => {
+  const npmCommand = getNpmCommand();
+  const result = spawnSync(
+    npmCommand,
+    ["install", "-g", "unity-hub-cli@latest", "--ignore-scripts", "--no-fund"],
+    {
+      stdio: "inherit",
+      timeout: NPM_INSTALL_TIMEOUT_MS
+    }
+  );
+  if (result.signal) {
+    return { ok: false, reason: "timeout" };
+  }
+  if (result.error) {
+    const errorCode = result.error.code;
+    if (errorCode === "ETIMEDOUT") {
+      return { ok: false, reason: "timeout" };
+    }
+    return { ok: false, reason: "spawn_failed" };
+  }
+  if (typeof result.status === "number" && result.status !== 0) {
+    return { ok: false, reason: "nonzero_exit" };
+  }
+  return { ok: true };
+};
 var getShellInitScript = () => {
   const shell = process3.env["SHELL"] ?? "";
   const isWindows = process3.platform === "win32";
@@ -2793,6 +3050,73 @@ end`;
 };
 var bootstrap = async () => {
   const args = process3.argv.slice(2);
+  if (args.includes("-v") || args.includes("--version")) {
+    console.log(getVersion());
+    return;
+  }
+  if (args[0] === "update") {
+    const currentVersion = getVersion();
+    const latestVersionResult = readLatestVersionFromNpm();
+    if (!latestVersionResult.ok) {
+      if (latestVersionResult.reason === "timeout") {
+        console.error("Failed to read the latest version from npm (timeout). Please check your network/proxy settings and try again.");
+      } else if (latestVersionResult.reason === "spawn_failed") {
+        console.error("Failed to run npm. Please ensure npm is installed and available in your PATH.");
+      } else {
+        console.error("Failed to read the latest version from npm. Please ensure you can access the npm registry.");
+      }
+      process3.exitCode = 1;
+      return;
+    }
+    const latestVersion = latestVersionResult.version;
+    const parsedCurrent = parseSemver(currentVersion);
+    const parsedLatest = parseSemver(latestVersion);
+    if (parsedCurrent && parsedLatest) {
+      const cmp = compareSemver(parsedLatest, parsedCurrent);
+      if (cmp <= 0) {
+        console.log(`Already up to date: ${currentVersion}`);
+        if (cmp < 0) {
+          console.log(`Current version is newer than npm latest: ${latestVersion}`);
+        }
+        return;
+      }
+    } else if (latestVersion === currentVersion) {
+      console.log(`Already up to date: ${currentVersion}`);
+      return;
+    }
+    console.log(`Current version: ${currentVersion}`);
+    console.log(`Latest version:  ${latestVersion}`);
+    console.log("This will update the global installation via npm: npm install -g unity-hub-cli@latest --ignore-scripts --no-fund");
+    console.log("");
+    if (!process3.stdin.isTTY) {
+      console.error("Interactive confirmation is not available in this environment (stdin is not a TTY).");
+      process3.exitCode = 1;
+      return;
+    }
+    if (!parsedCurrent || !parsedLatest) {
+      console.log("Warning: could not compare versions reliably; proceeding may downgrade your installation.");
+      console.log("");
+    }
+    const confirmed = await askConfirmation("Proceed with update? (y/n): ");
+    if (!confirmed) {
+      console.log("Update cancelled.");
+      return;
+    }
+    const installResult = installLatestVersionGlobally();
+    if (!installResult.ok) {
+      if (installResult.reason === "timeout") {
+        console.error("Update failed (timeout). Please check your network/proxy settings and try again.");
+      } else if (installResult.reason === "spawn_failed") {
+        console.error("Failed to run npm. Please ensure npm is installed and available in your PATH.");
+      } else {
+        console.error("Update failed. Please check the npm output above.");
+      }
+      process3.exitCode = 1;
+      return;
+    }
+    console.log(`Updated to: ${latestVersion}`);
+    return;
+  }
   if (args.includes("--shell-init")) {
     const isDryRun = args.includes("--dry-run");
     if (isDryRun) {
@@ -2809,6 +3133,11 @@ var bootstrap = async () => {
 `);
     previewShellInit();
     console.log("");
+    if (!process3.stdin.isTTY) {
+      console.error("Interactive confirmation is not available in this environment (stdin is not a TTY).");
+      process3.exitCode = 1;
+      return;
+    }
     const confirmed = await askConfirmation("Proceed with installation? (y/n): ");
     if (!confirmed) {
       console.log("Installation cancelled.");
@@ -2896,6 +3225,7 @@ var bootstrap = async () => {
           onLaunchEditorOnly: (project) => launchEditorOnlyUseCase.execute(project),
           onTerminate: (project) => terminateProjectUseCase.execute(project),
           onRefresh: () => listProjectsUseCase.execute(),
+          onToggleFavorite: (project) => unityHubReader.toggleFavorite(project.path),
           useGitRootName,
           outputPathOnExit,
           onSetExitPath: (path) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unity-hub-cli",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "description": "A CLI tool that reads Unity Hub's projects and launches Unity Editor with an interactive TUI",
   "main": "dist/index.js",
   "scripts": {
@@ -64,7 +64,7 @@
     "eslint-config-prettier": "10.1.8",
     "eslint-import-resolver-typescript": "4.4.4",
     "eslint-plugin-import": "2.32.0",
-    "prettier": "3.7.3",
+    "prettier": "3.7.4",
     "tsup": "8.5.1",
     "tsx": "4.21.0",
     "typescript": "5.9.3",