unity-hub-cli 0.17.0 → 0.19.0

package/README.md

@@ -58,14 +58,53 @@ The display includes Git branch (if present), Unity version, project path, and l
 ## CLI Options
 
 - `--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.
+
+## Shell Integration
+
+You can add a shell function to automatically `cd` to the project directory after opening Unity.
+
+### Setup
+
+1. Install globally:
+```bash
+npm install -g unity-hub-cli
+```
+
+2. Run the shell init command (auto-detects your shell):
+```bash
+unity-hub-cli --shell-init
+```
+
+This automatically adds the `unity-hub` function to your shell config file (`.zshrc`, `.bashrc`, `config.fish`, or PowerShell profile).
+
+3. Reload your shell:
+```bash
+source ~/.zshrc  # or restart your terminal
+```
+
+### Usage
+
+Now you can use `unity-hub` to:
+1. Browse and select Unity projects
+2. Press `o` to launch Unity
+3. Your terminal automatically `cd`s to the project directory
+
+### Notes
+
+- Running `--shell-init` multiple times is safe - it updates the existing function using marker comments
+- The function uses absolute paths detected from your environment
+- **Windows**: Shell integration supports PowerShell only. CMD is not supported because it lacks shell functions required for automatic `cd` after launching Unity
 
 ## Security
 
 This project implements supply chain attack prevention measures:
 
 - **ignore-scripts**: Disables automatic script execution during `npm install`
+- **@lavamoat/allow-scripts**: Explicitly controls which packages can run install scripts
 - **Dependabot**: Automated weekly security updates
-- **Security audit CI**: Runs `npm audit` and `lockfile-lint` on every PR
+- **Security audit CI**: Runs `npm audit`, `lockfile-lint`, and OSV-Scanner on every PR
 - **Pinned versions**: All dependencies use exact versions (no `^` or `~`)
 
 ## License

package/dist/index.js

@@ -1,7 +1,14 @@
 #!/usr/bin/env node
 
 // src/index.tsx
+import { execSync } 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";
 
 // src/application/usecases.ts
@@ -778,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;
@@ -909,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;
@@ -1332,7 +1403,7 @@ var WinUnityProcessTerminator = class {
         ],
         { env: getMsysDisabledEnv() }
       );
-    } catch (error) {
+    } catch {
       if (!ensureProcessAlive2(unityProcess.pid)) {
         return { terminated: true, stage: "sigterm" };
       }
@@ -1358,7 +1429,7 @@ var WinUnityProcessTerminator = class {
         ],
         { env: getMsysDisabledEnv() }
       );
-    } catch (error) {
+    } catch {
       if (!ensureProcessAlive2(unityProcess.pid)) {
         return { terminated: true, stage: "sigkill" };
       }
@@ -1667,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);
@@ -1987,7 +2059,7 @@ 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 defaultHintMessage = `j/k Select \xB7 [o]pen [O]+Editor [i]de [q]uit [r]efresh [c]opy [f]av [s]ort [v]isibility \xB7 ^C Exit`;
 var getCopyTargetPath = (view) => {
   const root = view.repository?.root;
   return root && root.length > 0 ? root : view.project.path;
@@ -1999,7 +2071,10 @@ var App = ({
   onLaunchEditorOnly,
   onTerminate,
   onRefresh,
-  useGitRootName = true
+  onToggleFavorite,
+  useGitRootName = true,
+  outputPathOnExit = false,
+  onSetExitPath
 }) => {
   const { exit } = useApp();
   const { stdout } = useStdout2();
@@ -2196,20 +2271,14 @@ var App = ({
       return;
     }
     const { project } = projectView;
-    try {
-      const cdTarget = getCopyTargetPath(projectView);
-      const command = buildCdCommand(cdTarget);
-      clipboard.writeSync(command);
-    } catch (error) {
-      const message = error instanceof Error ? error.message : String(error);
-      setHint(`Failed to copy: ${message}`);
-      setTimeout(() => {
-        setHint(defaultHintMessage);
-      }, 3e3);
-      return;
-    }
+    const cdTarget = getCopyTargetPath(projectView);
     try {
       await onLaunch(project);
+      if (outputPathOnExit) {
+        onSetExitPath?.(cdTarget);
+        exit();
+        return;
+      }
       setLaunchedProjects((previous) => {
         const next = new Set(previous);
         next.add(project.id);
@@ -2229,6 +2298,11 @@ var App = ({
       }, 3e3);
     } catch (error) {
       if (error instanceof LaunchCancelledError) {
+        if (outputPathOnExit) {
+          onSetExitPath?.(cdTarget);
+          exit();
+          return;
+        }
         setHint("Launch cancelled");
         setTimeout(() => {
           setHint(defaultHintMessage);
@@ -2241,7 +2315,7 @@ var App = ({
         setHint(defaultHintMessage);
       }, 3e3);
     }
-  }, [index, onLaunch, sortedProjects]);
+  }, [exit, index, onLaunch, onSetExitPath, outputPathOnExit, sortedProjects]);
   const launchSelectedWithEditor = useCallback(async () => {
     if (!onLaunchWithEditor) {
       setHint("Launch with editor not available");
@@ -2259,20 +2333,14 @@ var App = ({
       return;
     }
     const { project } = projectView;
-    try {
-      const cdTarget = getCopyTargetPath(projectView);
-      const command = buildCdCommand(cdTarget);
-      clipboard.writeSync(command);
-    } catch (error) {
-      const message = error instanceof Error ? error.message : String(error);
-      setHint(`Failed to copy: ${message}`);
-      setTimeout(() => {
-        setHint(defaultHintMessage);
-      }, 3e3);
-      return;
-    }
+    const cdTarget = getCopyTargetPath(projectView);
     try {
       const result = await onLaunchWithEditor(project);
+      if (outputPathOnExit) {
+        onSetExitPath?.(cdTarget);
+        exit();
+        return;
+      }
       setLaunchedProjects((previous) => {
         const next = new Set(previous);
         next.add(project.id);
@@ -2292,6 +2360,11 @@ var App = ({
       }, 3e3);
     } catch (error) {
       if (error instanceof LaunchCancelledError) {
+        if (outputPathOnExit) {
+          onSetExitPath?.(cdTarget);
+          exit();
+          return;
+        }
         setHint("Launch cancelled");
         setTimeout(() => {
           setHint(defaultHintMessage);
@@ -2304,7 +2377,7 @@ var App = ({
         setHint(defaultHintMessage);
       }, 3e3);
     }
-  }, [index, onLaunchWithEditor, sortedProjects]);
+  }, [exit, index, onLaunchWithEditor, onSetExitPath, outputPathOnExit, sortedProjects]);
   const launchEditorOnly = useCallback(async () => {
     if (!onLaunchEditorOnly) {
       setHint("Launch editor only not available");
@@ -2437,6 +2510,43 @@ var App = ({
       setIsRefreshing(false);
     }
   }, [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);
+    }
+  }, [index, onToggleFavorite, sortedProjects]);
   useInput((input, key) => {
     if (isSortMenuOpen) {
       if (key.escape || input === "\x1B") {
@@ -2557,6 +2667,10 @@ var App = ({
     }
     if (input === "c") {
       copyProjectPath();
+      return;
+    }
+    if (input === "f" || input === "F") {
+      void toggleFavoriteSelected();
     }
   });
   const { startIndex, visibleProjects } = useMemo2(() => {
@@ -2634,7 +2748,196 @@ var App = ({
 
 // src/index.tsx
 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();
+  if (shell.includes("zsh")) {
+    return join9(home, ".zshrc");
+  }
+  if (shell.includes("bash")) {
+    const bashrcPath = join9(home, ".bashrc");
+    const profilePath = join9(home, ".bash_profile");
+    return existsSync3(bashrcPath) ? bashrcPath : profilePath;
+  }
+  if (shell.includes("fish")) {
+    return join9(home, ".config", "fish", "config.fish");
+  }
+  if (process3.platform === "win32") {
+    return join9(home, "Documents", "WindowsPowerShell", "Microsoft.PowerShell_profile.ps1");
+  }
+  return void 0;
+};
+var getShellInitScriptWithMarkers = () => {
+  const script = getShellInitScript();
+  return `${SHELL_INIT_MARKER_START}
+${script}
+${SHELL_INIT_MARKER_END}`;
+};
+var askConfirmation = (question) => {
+  const rl = createInterface2({
+    input: process3.stdin,
+    output: process3.stdout
+  });
+  return new Promise((resolve4) => {
+    rl.question(question, (answer) => {
+      rl.close();
+      resolve4(answer.toLowerCase() === "y" || answer.toLowerCase() === "yes");
+    });
+  });
+};
+var previewShellInit = () => {
+  const configPath = getShellConfigPath();
+  console.log("=== Shell Integration Preview ===\n");
+  console.log(`Target file: ${configPath ?? "Unknown (unsupported shell)"}
+`);
+  console.log("Content to be added:\n");
+  console.log(getShellInitScriptWithMarkers());
+};
+var installShellInit = () => {
+  const configPath = getShellConfigPath();
+  if (!configPath) {
+    return { success: false, message: "Unsupported shell. Please copy the function from the README into your shell config manually." };
+  }
+  const scriptWithMarkers = getShellInitScriptWithMarkers();
+  const markerPattern = new RegExp(
+    `${SHELL_INIT_MARKER_START}[\\s\\S]*?${SHELL_INIT_MARKER_END}`,
+    "g"
+  );
+  let content = "";
+  if (existsSync3(configPath)) {
+    content = readFileSync(configPath, "utf-8");
+  }
+  const existingMatch = content.match(markerPattern);
+  if (existingMatch && existingMatch[0] === scriptWithMarkers) {
+    return { success: true, message: `Shell integration is already up to date in ${configPath}` };
+  }
+  let newContent;
+  let action;
+  if (existingMatch) {
+    newContent = content.replace(markerPattern, scriptWithMarkers);
+    action = "updated";
+  } else {
+    newContent = content.trimEnd() + "\n\n" + scriptWithMarkers + "\n";
+    action = "installed";
+  }
+  mkdirSync(dirname2(configPath), { recursive: true });
+  writeFileSync(configPath, newContent, "utf-8");
+  return { success: true, message: `Shell integration ${action} in ${configPath}` };
+};
+var getNodePath = () => {
+  const isWindows = process3.platform === "win32";
+  const command = isWindows ? "where node" : "which node";
+  try {
+    const result = execSync(command, { encoding: "utf-8" }).trim().split("\n")[0];
+    if (result && existsSync3(result)) {
+      return result;
+    }
+  } catch {
+  }
+  return "node";
+};
+var getUnityHubCliPath = () => {
+  const isWindows = process3.platform === "win32";
+  try {
+    const prefix = execSync("npm config get prefix", { encoding: "utf-8" }).trim();
+    const binDir = isWindows ? prefix : `${prefix}/bin`;
+    const cliPath = isWindows ? `${binDir}/unity-hub-cli.cmd` : `${binDir}/unity-hub-cli`;
+    if (existsSync3(cliPath)) {
+      return cliPath;
+    }
+  } catch {
+  }
+  return "unity-hub-cli";
+};
+var getShellInitScript = () => {
+  const shell = process3.env["SHELL"] ?? "";
+  const isWindows = process3.platform === "win32";
+  const nodePath = getNodePath();
+  const cliPath = getUnityHubCliPath();
+  if (shell.includes("fish")) {
+    return `function unity-hub
+  set -l tmpfile (mktemp)
+  ${nodePath} ${cliPath} --output-path-on-exit > $tmpfile
+  set -l dir (cat $tmpfile)
+  rm -f $tmpfile
+  if test -n "$dir"
+    cd $dir
+  end
+end`;
+  }
+  if (shell.includes("bash") || shell.includes("zsh")) {
+    return `unity-hub() {
+  local tmpfile=$(mktemp)
+  ${nodePath} ${cliPath} --output-path-on-exit >| "$tmpfile"
+  local dir=$(cat "$tmpfile")
+  rm -f "$tmpfile"
+  if [ -n "$dir" ]; then
+    cd "$dir"
+  fi
+}`;
+  }
+  if (isWindows) {
+    return `function unity-hub {
+  $tmpfile = [System.IO.Path]::GetTempFileName()
+  & "${cliPath}" --output-path-on-exit > $tmpfile
+  $dir = Get-Content $tmpfile
+  Remove-Item $tmpfile
+  if ($dir) {
+    Set-Location $dir
+  }
+}`;
+  }
+  return `unity-hub() {
+  local tmpfile=$(mktemp)
+  ${nodePath} ${cliPath} --output-path-on-exit >| "$tmpfile"
+  local dir=$(cat "$tmpfile")
+  rm -f "$tmpfile"
+  if [ -n "$dir" ]; then
+    cd "$dir"
+  fi
+}`;
+};
 var bootstrap = async () => {
+  const args = process3.argv.slice(2);
+  if (args.includes("-v") || args.includes("--version")) {
+    console.log(getVersion());
+    return;
+  }
+  if (args.includes("--shell-init")) {
+    const isDryRun = args.includes("--dry-run");
+    if (isDryRun) {
+      previewShellInit();
+      return;
+    }
+    const configPath = getShellConfigPath();
+    if (!configPath) {
+      console.log("Unsupported shell. Please copy the function from the README into your shell config manually.");
+      process3.exitCode = 1;
+      return;
+    }
+    console.log(`This will install the unity-hub function to: ${configPath}
+`);
+    previewShellInit();
+    console.log("");
+    const confirmed = await askConfirmation("Proceed with installation? (y/n): ");
+    if (!confirmed) {
+      console.log("Installation cancelled.");
+      return;
+    }
+    const result = installShellInit();
+    console.log(result.message);
+    process3.exitCode = result.success ? 0 : 1;
+    return;
+  }
+  const outputPathOnExit = args.includes("--output-path-on-exit");
   const isWindows = process3.platform === "win32";
   const unityHubReader = isWindows ? new WinUnityHubProjectsReader() : new MacUnityHubProjectsReader();
   const gitRepositoryInfoReader = new GitRepositoryInfoReader();
@@ -2694,8 +2997,13 @@ var bootstrap = async () => {
       process3.exitCode = 1;
       return;
     }
+    if (outputPathOnExit && process3.stderr.isTTY) {
+      chalk.level = 3;
+    }
     const theme = await detectTerminalTheme();
+    let lastOpenedPath;
     const projects = await listProjectsUseCase.execute();
+    const renderOptions = outputPathOnExit ? { stdout: process3.stderr, stdin: process3.stdin } : void 0;
     const { waitUntilExit } = render(
       /* @__PURE__ */ jsx7(ThemeProvider, { theme, children: /* @__PURE__ */ jsx7(
         App,
@@ -2706,12 +3014,25 @@ var bootstrap = async () => {
           onLaunchEditorOnly: (project) => launchEditorOnlyUseCase.execute(project),
           onTerminate: (project) => terminateProjectUseCase.execute(project),
           onRefresh: () => listProjectsUseCase.execute(),
-          useGitRootName
+          onToggleFavorite: (project) => unityHubReader.toggleFavorite(project.path),
+          useGitRootName,
+          outputPathOnExit,
+          onSetExitPath: (path) => {
+            lastOpenedPath = path;
+          }
         }
-      ) })
+      ) }),
+      renderOptions
     );
     await waitUntilExit();
-    process3.stdout.write("\x1B[2J\x1B[3J\x1B[H");
+    if (outputPathOnExit) {
+      process3.stderr.write("\x1B[2J\x1B[3J\x1B[H");
+      if (lastOpenedPath) {
+        process3.stdout.write(lastOpenedPath);
+      }
+    } else {
+      process3.stdout.write("\x1B[2J\x1B[3J\x1B[H");
+    }
   } catch (error) {
     const message = error instanceof Error ? error.message : String(error);
     console.error(message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unity-hub-cli",
-  "version": "0.17.0",
+  "version": "0.19.0",
   "description": "A CLI tool that reads Unity Hub's projects and launches Unity Editor with an interactive TUI",
   "main": "dist/index.js",
   "scripts": {
@@ -8,10 +8,11 @@
     "dev": "tsx src/index.ts",
     "build": "tsup",
     "start": "node dist/index.js",
-    "lint": "eslint . --ext .ts,.tsx",
-    "lint:fix": "eslint . --ext .ts,.tsx --fix",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "format": "prettier --write .",
-    "typecheck": "tsc -noEmit"
+    "typecheck": "tsc -noEmit",
+    "allow-scripts": "allow-scripts"
   },
   "repository": {
     "type": "git",
@@ -36,26 +37,38 @@
     "dist"
   ],
   "dependencies": {
-    "clipboardy": "4.0.0",
-    "ink": "4.4.1",
-    "react": "18.3.1"
+    "chalk": "5.6.2",
+    "clipboardy": "5.0.1",
+    "ink": "6.5.1",
+    "react": "19.2.1"
   },
   "engines": {
     "node": ">=18"
   },
+  "lavamoat": {
+    "allowScripts": {
+      "eslint-import-resolver-typescript>unrs-resolver": false,
+      "tsup>bundle-require>esbuild": false,
+      "tsup>esbuild": false,
+      "tsx>esbuild": false
+    }
+  },
   "devDependencies": {
-    "@types/node": "20.19.20",
-    "@types/react": "18.3.26",
-    "@typescript-eslint/eslint-plugin": "7.18.0",
-    "@typescript-eslint/parser": "7.18.0",
-    "eslint": "8.57.0",
-    "eslint-config-prettier": "9.1.2",
-    "eslint-import-resolver-typescript": "3.10.1",
+    "@eslint/js": "^9.39.1",
+    "@lavamoat/allow-scripts": "3.4.1",
+    "@types/node": "24.10.1",
+    "@types/react": "19.2.7",
+    "@typescript-eslint/eslint-plugin": "8.48.1",
+    "@typescript-eslint/parser": "8.48.1",
+    "eslint": "9.39.1",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-import-resolver-typescript": "4.4.4",
     "eslint-plugin-import": "2.32.0",
-    "prettier": "3.6.2",
-    "tsup": "8.5.0",
-    "tsx": "4.20.6",
+    "prettier": "3.7.4",
+    "tsup": "8.5.1",
+    "tsx": "4.21.0",
     "typescript": "5.9.3",
-    "vitest": "4.0.14"
+    "typescript-eslint": "^8.48.1",
+    "vitest": "4.0.15"
   }
 }