launch-unity 0.7.0 → 0.9.0

package/README.ja.md

@@ -15,27 +15,35 @@ npm install -g launch-unity
 npx launch-unity
 ```
 
-## 使用例
+## 使い方
 ```bash
-# NPX（推奨 / インストール不要）
-npx launch-unity                    # カレントディレクトリから3階層下までUnityプロジェクトを探索して開く
-npx launch-unity /path/to/Proj      # プロジェクトを指定
-npx launch-unity /path Android      # ビルドターゲットを指定
-npx -y launch-unity                 # npx の「Ok to proceed?」確認をスキップ
-
-# `--` 以降は Unity のコマンドライン引数をそのまま転送
-npx launch-unity . -- -batchmode -quit -nographics -logFile -
+# 構文
+launch-unity [OPTIONS] [PROJECT_PATH] [PLATFORM] [-- UNITY_ARGS...]
+
+# 引数
+#   PROJECT_PATH    Unityプロジェクトのディレクトリ（省略時は3階層下まで探索）
+#   PLATFORM        Unityの -buildTarget に渡す値（例: StandaloneOSX, Android, iOS）
+
+# オプション
+#   -h, --help      ヘルプを表示
+#   -r, --restart   Unityを再起動
+#   -a, -u, --add-unity-hub, --unity-hub-entry
+#                   Unity Hub に登録（Unityは起動しない）
+#   -f, --favorite  Unity Hub にお気に入りとして登録（Unityは起動しない）
+
+# 例
+npx launch-unity                   # プロジェクトを探索して開く
+npx launch-unity /path/to/Proj     # 指定プロジェクトを開く
+npx launch-unity /path Android     # ビルドターゲットを指定
+npx launch-unity -r                # Unityを再起動
+npx launch-unity -a                # Unity Hub に登録のみ（Unityは起動しない）
+npx launch-unity -f                # Unity Hub にお気に入り登録（Unityは起動しない）
+npx launch-unity . -- -batchmode -quit -nographics -logFile -  # Unity引数を渡す
 npx launch-unity /path Android -- -executeMethod My.Build.Entry
-
-# グローバルインストール後
-launch-unity
-launch-unity /path/to/MyUnityProject Android
-launch-unity . -- -buildTarget iOS -projectPath . # 上書きも可能
 ```
 
 指定した Unity プロジェクトの `ProjectSettings/ProjectVersion.txt` から必要な Unity Editor のバージョンを読み取り、
-Unity Hub でインストール済みの該当バージョンを起動する macOS/Windows 向け TypeScript 製 CLI です。`Temp/UnityLockfile` が
-存在する場合は、削除して続行するかをターミナル上で確認します。
+Unity Hub でインストール済みの該当バージョンを起動する macOS/Windows 向け TypeScript 製 CLI です。
 
 既定で想定する Unity のパス:
 - macOS: `/Applications/Unity/Hub/Editor/<version>/Unity.app/Contents/MacOS/Unity`

package/README.md

@@ -15,28 +15,36 @@ npm install -g launch-unity
 npx launch-unity
 ```
 
-## Usage Examples
+## Usage
 ```bash
-# NPX (recommended, zero install)
-npx launch-unity                   # Search up to 3 levels deep for a Unity project and open it
-npx launch-unity /path/to/Proj     # Open a specific project
-npx launch-unity /path Android     # Specify build target
-npx -y launch-unity                # Skip npx "Ok to proceed?" prompt
+# Syntax
+launch-unity [OPTIONS] [PROJECT_PATH] [PLATFORM] [-- UNITY_ARGS...]
 
-# Pass through Unity CLI args with --
-npx launch-unity . -- -batchmode -quit -nographics -logFile -
+# Arguments
+#   PROJECT_PATH    Unity project directory (searches up to 3 levels deep if omitted)
+#   PLATFORM        Passed to Unity as -buildTarget (e.g., StandaloneOSX, Android, iOS)
+
+# Options
+#   -h, --help      Show help
+#   -r, --restart   Kill running Unity and restart
+#   -a, -u, --add-unity-hub, --unity-hub-entry
+#                   Register to Unity Hub (does not launch Unity)
+#   -f, --favorite  Register to Unity Hub as favorite (does not launch Unity)
+
+# Examples
+npx launch-unity                   # Search for project and open
+npx launch-unity /path/to/Proj     # Open specific project
+npx launch-unity /path Android     # Specify build target
+npx launch-unity -r                # Restart Unity
+npx launch-unity -a                # Register to Unity Hub only (does not launch Unity)
+npx launch-unity -f                # Register as favorite (does not launch Unity)
+npx launch-unity . -- -batchmode -quit -nographics -logFile -  # Pass Unity args
 npx launch-unity /path Android -- -executeMethod My.Build.Entry
-
-# Installed globally
-launch-unity
-launch-unity /path/to/MyUnityProject Android
-launch-unity . -- -buildTarget iOS -projectPath . # You can override
 ```
 
 A TypeScript CLI for macOS and Windows that reads the required Unity Editor version from
 `ProjectSettings/ProjectVersion.txt`, launches the matching Unity installed via Unity Hub,
-and opens the project. If `Temp/UnityLockfile` exists, it asks in the terminal whether to
-delete it before continuing.
+and opens the project.
 
 Default Unity paths assumed:
 - macOS: `/Applications/Unity/Hub/Editor/<version>/Unity.app/Contents/MacOS/Unity`
@@ -47,20 +55,6 @@ Default Unity paths assumed:
   - `C:\\Program Files\\Unity\\Hub\\Editor\\<version>\\Editor\\Unity.exe`
 
 
-## Detailed Usage
-```bash
-# Basic syntax
-launch-unity [PROJECT_PATH] [PLATFORM]
-
-# Arguments
-# - PROJECT_PATH (optional): Unity project directory. Defaults to current directory
-# - PLATFORM     (optional): Passed to Unity as -buildTarget (e.g., StandaloneOSX, Android, iOS)
-
-# Flags
-# -h, --help  Show help
-```
-
-
 ## Troubleshooting
 - Error: `ProjectVersion.txt not found`
   - The provided directory is not a Unity project. Point to the project root.

package/dist/launch.js

@@ -6,9 +6,10 @@
 import { execFile, spawn } from "node:child_process";
 import { existsSync, readFileSync, readdirSync, lstatSync, realpathSync } from "node:fs";
 import { rm } from "node:fs/promises";
-import { join, resolve } from "node:path";
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
 import { promisify } from "node:util";
-import { updateLastModifiedIfExists } from "./unityHub.js";
+import { ensureProjectEntryAndUpdate, updateLastModifiedIfExists } from "./unityHub.js";
 const execFileAsync = promisify(execFile);
 const UNITY_EXECUTABLE_PATTERN_MAC = /Unity\.app\/Contents\/MacOS\/Unity/i;
 const UNITY_EXECUTABLE_PATTERN_WINDOWS = /Unity\.exe/i;
@@ -26,16 +27,33 @@ function parseArgs(argv) {
     const positionals = [];
     let maxDepth = 3; // default 3; -1 means unlimited
     let restart = false;
+    let addUnityHub = false;
+    let favoriteUnityHub = false;
     for (let i = 0; i < cliArgs.length; i++) {
         const arg = cliArgs[i] ?? "";
         if (arg === "--help" || arg === "-h") {
             printHelp();
             process.exit(0);
         }
+        if (arg === "--version" || arg === "-v") {
+            console.log(getVersion());
+            process.exit(0);
+        }
         if (arg === "-r" || arg === "--restart") {
             restart = true;
             continue;
         }
+        if (arg === "-u" ||
+            arg === "-a" ||
+            arg === "--unity-hub-entry" ||
+            arg === "--add-unity-hub") {
+            addUnityHub = true;
+            continue;
+        }
+        if (arg === "-f" || arg === "--favorite") {
+            favoriteUnityHub = true;
+            continue;
+        }
         if (arg.startsWith("--max-depth")) {
             const parts = arg.split("=");
             if (parts.length === 2) {
@@ -84,7 +102,7 @@ function parseArgs(argv) {
         projectPath = resolve(positionals[0] ?? "");
         platform = String(positionals[1] ?? "");
     }
-    const options = { unityArgs, searchMaxDepth: maxDepth, restart };
+    const options = { unityArgs, searchMaxDepth: maxDepth, restart, addUnityHub, favoriteUnityHub };
     if (projectPath !== undefined) {
         options.projectPath = projectPath;
     }
@@ -93,6 +111,13 @@ function parseArgs(argv) {
     }
     return options;
 }
+function getVersion() {
+    const currentFilePath = fileURLToPath(import.meta.url);
+    const currentDir = dirname(currentFilePath);
+    const packageJsonPath = join(currentDir, "..", "package.json");
+    const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8"));
+    return packageJson.version;
+}
 function printHelp() {
     const help = `
 Usage: launch-unity [PROJECT_PATH] [PLATFORM] -- [UNITY_ARGS...]
@@ -109,8 +134,12 @@ Forwarding:
 
 Flags:
   -h, --help          Show this help message
+  -v, --version       Show version number
   -r, --restart       Kill running Unity and restart
   --max-depth <N>     Search depth when PROJECT_PATH is omitted (default 3, -1 unlimited)
+  -u, -a, --unity-hub-entry, --add-unity-hub
+                      Add to Unity Hub if missing and update lastModified (does not launch Unity)
+  -f, --favorite      Add to Unity Hub as favorite (does not launch Unity)
 `;
     process.stdout.write(help);
 }
@@ -538,8 +567,7 @@ function findUnityProjectBfs(rootDir, maxDepth) {
     return undefined;
 }
 function launch(opts) {
-    const { projectPath, platform, unityArgs } = opts;
-    const unityVersion = getUnityVersion(projectPath);
+    const { projectPath, platform, unityArgs, unityVersion } = opts;
     const unityPath = getUnityPath(unityVersion);
     console.log(`Detected Unity version: ${unityVersion}`);
     if (!existsSync(unityPath)) {
@@ -577,6 +605,23 @@ async function main() {
         resolvedProjectPath = found;
     }
     ensureProjectPath(resolvedProjectPath);
+    const unityVersion = getUnityVersion(resolvedProjectPath);
+    // Unity Hub only mode: -a or -f flags skip launching Unity
+    const unityHubOnlyMode = options.addUnityHub || options.favoriteUnityHub;
+    if (unityHubOnlyMode) {
+        console.log(`Detected Unity version: ${unityVersion}`);
+        console.log(`Project Path: ${resolvedProjectPath}`);
+        const now = new Date();
+        try {
+            await ensureProjectEntryAndUpdate(resolvedProjectPath, unityVersion, now, options.favoriteUnityHub);
+            console.log("Unity Hub entry updated.");
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            console.warn(`Failed to update Unity Hub: ${message}`);
+        }
+        return;
+    }
     if (options.restart) {
         await killRunningUnity(resolvedProjectPath);
     }
@@ -594,11 +639,13 @@ async function main() {
         projectPath: resolvedProjectPath,
         platform: options.platform,
         unityArgs: options.unityArgs,
+        unityVersion,
     };
     launch(resolved);
     // Best-effort update of Unity Hub's lastModified timestamp.
+    const now = new Date();
     try {
-        await updateLastModifiedIfExists(resolvedProjectPath, new Date());
+        await updateLastModifiedIfExists(resolvedProjectPath, now);
     }
     catch (error) {
         const message = error instanceof Error ? error.message : String(error);

package/dist/unityHub.js

@@ -1,5 +1,6 @@
 import { readFile, writeFile } from "node:fs/promises";
-import { join, resolve } from "node:path";
+import { realpathSync } from "node:fs";
+import { basename, dirname, join, resolve } from "node:path";
 const resolveUnityHubProjectFiles = () => {
     if (process.platform === "darwin") {
         const home = process.env.HOME;
@@ -30,12 +31,91 @@ const normalizePath = (target) => {
     const resolvedPath = resolve(target);
     return removeTrailingSeparators(resolvedPath);
 };
+const resolvePathWithActualCase = (target) => {
+    try {
+        return removeTrailingSeparators(realpathSync.native(target));
+    }
+    catch {
+        return normalizePath(target);
+    }
+};
 const toComparablePath = (value) => {
     return value.replace(/\\/g, "/").toLocaleLowerCase();
 };
 const pathsEqual = (left, right) => {
     return toComparablePath(normalizePath(left)) === toComparablePath(normalizePath(right));
 };
+const safeParseProjectsJson = (content) => {
+    try {
+        return JSON.parse(content);
+    }
+    catch {
+        return undefined;
+    }
+};
+const logDebug = (message) => {
+    if (process.env["LAUNCH_UNITY_DEBUG"] === "1") {
+        console.log(`[unityHub] ${message}`);
+    }
+};
+export const ensureProjectEntryAndUpdate = async (projectPath, version, when, setFavorite = false) => {
+    const canonicalProjectPath = resolvePathWithActualCase(projectPath);
+    const projectTitle = basename(canonicalProjectPath);
+    const containingFolderPath = dirname(canonicalProjectPath);
+    const candidates = resolveUnityHubProjectFiles();
+    if (candidates.length === 0) {
+        logDebug("No Unity Hub project files found.");
+        return;
+    }
+    for (const path of candidates) {
+        logDebug(`Trying Unity Hub file: ${path}`);
+        const content = await readFile(path, "utf8").catch(() => undefined);
+        if (!content) {
+            logDebug("Read failed or empty content, skipping.");
+            continue;
+        }
+        const json = safeParseProjectsJson(content);
+        if (!json) {
+            logDebug("Parse failed, skipping.");
+            continue;
+        }
+        const data = { ...(json.data ?? {}) };
+        const existingKey = Object.keys(data).find((key) => {
+            const entryPath = data[key]?.path;
+            return entryPath ? pathsEqual(entryPath, projectPath) : false;
+        });
+        const targetKey = existingKey ?? canonicalProjectPath;
+        const existingEntry = existingKey ? data[existingKey] : undefined;
+        logDebug(existingKey
+            ? `Found existing entry for project (key=${existingKey}). Updating lastModified.`
+            : `No existing entry. Adding new entry (key=${targetKey}).`);
+        const updatedEntry = {
+            ...existingEntry,
+            path: existingEntry?.path ?? canonicalProjectPath,
+            containingFolderPath: existingEntry?.containingFolderPath ?? containingFolderPath,
+            version: existingEntry?.version ?? version,
+            title: existingEntry?.title ?? projectTitle,
+            lastModified: when.getTime(),
+            isFavorite: setFavorite ? true : (existingEntry?.isFavorite ?? false),
+        };
+        const updatedJson = {
+            ...json,
+            data: {
+                ...data,
+                [targetKey]: updatedEntry,
+            },
+        };
+        try {
+            await writeFile(path, JSON.stringify(updatedJson, undefined, 2), "utf8");
+            logDebug("Write succeeded.");
+        }
+        catch (error) {
+            logDebug(`Write failed: ${error instanceof Error ? error.message : String(error)}`);
+            // Ignore write errors to avoid breaking CLI flow
+        }
+        return;
+    }
+};
 export const updateLastModifiedIfExists = async (projectPath, when) => {
     const candidates = resolveUnityHubProjectFiles();
     if (candidates.length === 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "launch-unity",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Open a Unity project with the matching Editor version (macOS/Windows)",
   "type": "module",
   "main": "dist/launch.js",
@@ -39,15 +39,15 @@
   },
   "devDependencies": {
     "@types/node": "24.10.1",
-    "@typescript-eslint/eslint-plugin": "8.48.0",
-    "@typescript-eslint/parser": "8.48.0",
+    "@typescript-eslint/eslint-plugin": "8.48.1",
+    "@typescript-eslint/parser": "8.48.1",
     "eslint": "9.39.1",
     "eslint-config-prettier": "10.1.8",
-    "prettier": "3.7.3",
+    "prettier": "3.7.4",
     "typescript": "5.9.3"
   },
   "dependencies": {
-    "typescript-eslint": "8.48.0"
+    "typescript-eslint": "8.48.1"
   },
   "overrides": {
     "js-yaml": "4.1.1"