[email protected] (#36)

- fix `unity-cli run` input args validation, and ability to run without specifying a project path.

Author: StephenHodgson

.github/workflows/unity-build.yml

@@ -116,8 +116,8 @@ jobs:
         timeout-minutes: 60
         shell: bash
         run: |
-          unity-cli run --log-name Validate -quit -nographics -batchmode -executeMethod Utilities.Editor.BuildPipeline.UnityPlayerBuildTools.ValidateProject -importTMProEssentialsAsset
-          unity-cli run --log-name Build -quit -nographics -batchmode -buildTarget ${{ matrix.build-target }} -executeMethod Utilities.Editor.BuildPipeline.UnityPlayerBuildTools.StartCommandLineBuild -sceneList Assets/Scenes/SampleScene.unity ${{ matrix.build-args }}
+          unity-cli run --log-name Validate -quit -executeMethod Utilities.Editor.BuildPipeline.UnityPlayerBuildTools.ValidateProject -importTMProEssentialsAsset
+          unity-cli run --log-name Build -buildTarget ${{ matrix.build-target }} -quit -executeMethod Utilities.Editor.BuildPipeline.UnityPlayerBuildTools.StartCommandLineBuild -sceneList Assets/Scenes/SampleScene.unity ${{ matrix.build-args }}
       - name: Uninstall Editor
         shell: bash
         run: |

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@rage-against-the-pixel/unity-cli",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "description": "A command line utility for the Unity Game Engine.",
   "author": "RageAgainstThePixel",
   "license": "MIT",
@@ -60,7 +60,7 @@
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",
-    "@types/node": "^24.9.0",
+    "@types/node": "^24.9.1",
     "@types/semver": "^7.7.1",
     "@types/update-notifier": "^6.0.8",
     "jest": "^30.2.0",

package.json

@@ -351,7 +351,7 @@ program.commandsGroup('Unity Editor:');
 program.command('run')
     .description('Run command line args directly to the Unity Editor.')
     .option('--unity-editor <unityEditor>', 'The path to the Unity Editor executable. If unspecified, --unity-project or the UNITY_EDITOR_PATH environment variable must be set.')
-    .option('--unity-project <unityProject>', 'The path to a Unity project. If unspecified, the UNITY_PROJECT_PATH environment variable or the current working directory will be used.')
+    .option('--unity-project <unityProject>', 'The path to a Unity project. If unspecified, the UNITY_PROJECT_PATH environment variable will be used, otherwise no project will be specified.')
     .option('--log-name <logName>', 'The name of the log file.')
     .option('--verbose', 'Enable verbose logging.')
     .allowUnknownOption(true)
@@ -367,20 +367,38 @@ program.command('run')
         const editorPath = options.unityEditor?.toString()?.trim() || process.env.UNITY_EDITOR_PATH || undefined;
 
         if (editorPath && editorPath.length > 0) {
-            unityEditor = new UnityEditor(editorPath);
+            try {
+                unityEditor = new UnityEditor(editorPath);
+            } catch {
+                Logger.instance.error(`The specified Unity Editor path is invalid: ${editorPath}. Use --unity-editor or set the UNITY_EDITOR_PATH environment variable.`);
+                process.exit(1);
+            }
         }
 
-        const projectPath = options.unityProject?.toString()?.trim() || process.env.UNITY_PROJECT_PATH || process.cwd();
-        const unityProject = await UnityProject.GetProject(projectPath);
+        let unityProject: UnityProject | undefined;
+        const projectPath = options.unityProject?.toString()?.trim() || process.env.UNITY_PROJECT_PATH || undefined;
 
-        if (!unityProject) {
-            Logger.instance.error(`The specified path is not a valid Unity project: ${projectPath}`);
-            process.exit(1);
-        }
+        if (projectPath && projectPath.length > 0) {
+            try {
+                unityProject = await UnityProject.GetProject(projectPath);
 
-        if (!unityEditor) {
-            const unityHub = new UnityHub();
-            unityEditor = await unityHub.GetEditor(unityProject.version);
+                if (!unityProject) {
+                    throw Error('Invalid Unity project path.');
+                }
+            } catch (error) {
+                Logger.instance.error(`The specified path is not a valid Unity project: ${projectPath}. Use --unity-project or set the UNITY_PROJECT_PATH environment variable.`);
+                process.exit(1);
+            }
+
+            if (!unityEditor) {
+                const unityHub = new UnityHub();
+                try {
+                    unityEditor = await unityHub.GetEditor(unityProject.version);
+                } catch {
+                    Logger.instance.error(`Could not find Unity Editor version ${unityProject.version.version} installed for project at ${unityProject.projectPath}. Please specify the editor path with --unity-editor or set the UNITY_EDITOR_PATH environment variable.`);
+                    process.exit(1);
+                }
+            }
         }
 
         if (!unityEditor) {
@@ -389,11 +407,12 @@ program.command('run')
         }
 
         if (!args.includes('-logFile')) {
-            const logPath = unityEditor.GenerateLogFilePath(unityProject.projectPath, options.logName);
+            const logPath = unityEditor.GenerateLogFilePath(unityProject?.projectPath, options.logName);
             args.push('-logFile', logPath);
         }
 
         await unityEditor.Run({
+            projectPath: unityProject?.projectPath,
             args: [...args]
         });
         process.exit(0);

src/cli.ts

@@ -19,7 +19,7 @@ import {
 
 export interface EditorCommand {
     args: string[];
-    projectPath?: string;
+    projectPath?: string | undefined;
 }
 
 export class UnityEditor {
@@ -212,22 +212,42 @@ export class UnityEditor {
                 throw Error('No command arguments provided for Unity execution');
             }
 
-            if (!command.args.includes(`-automated`)) {
-                command.args.push(`-automated`);
+            if (this.autoAddNoGraphics &&
+                !command.args.includes(`-nographics`) &&
+                !command.args.includes(`-force-graphics`)) {
+                command.args.unshift(`-nographics`);
             }
 
             if (!command.args.includes(`-batchmode`)) {
-                command.args.push(`-batchmode`);
+                command.args.unshift(`-batchmode`);
             }
 
-            if (this.autoAddNoGraphics &&
-                !command.args.includes(`-nographics`) &&
-                !command.args.includes(`-force-graphics`)) {
-                command.args.push(`-nographics`);
+            if (!command.args.includes(`-automated`)) {
+                command.args.unshift(`-automated`);
             }
 
             if (!command.args.includes('-logFile')) {
-                command.args.push('-logFile', this.GenerateLogFilePath(command.projectPath));
+                command.args.unshift('-logFile', this.GenerateLogFilePath(command.projectPath));
+            } else {
+                const existingLogPath = GetArgumentValueAsString('-logFile', command.args);
+                command.args.splice(command.args.indexOf(existingLogPath) - 1, 2);
+                command.args.unshift('-logFile', existingLogPath);
+            }
+
+            if (command.projectPath) {
+                if (!command.args.includes('-projectPath')) {
+                    command.args.unshift('-projectPath', command.projectPath);
+                } else {
+                    const existingPath = GetArgumentValueAsString('-projectPath', command.args);
+
+                    if (existingPath !== command.projectPath) {
+                        throw Error(`Conflicting project paths provided. Argument: "${existingPath}", Command: "${command.projectPath}"`);
+                    }
+
+                    // Ensure -projectPath is the first argument
+                    command.args.splice(command.args.indexOf(existingPath) - 1, 2);
+                    command.args.unshift('-projectPath', command.projectPath);
+                }
             }
 
             const logPath: string = GetArgumentValueAsString('-logFile', command.args);