Enforce ProjectPath being absolute

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.4.1
+
+- Fix: Relative project paths are now handled correctly (e.g. `gm-cli ./some/project.yyp` works as intended)
+
 # 1.4.0
 
 - Fix: `gm-cli package` now works correctly on Linux.

package.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/YoYoGames/gm-cli"
   },
   "type": "module",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "files": [
     "dist",
     "NOTICE"

src/commands/cache/command.ts

@@ -21,7 +21,7 @@ import { findProjectFile, parseProjectPath } from "~/project";
 export const FLAGS = {
   project: {
     kind: "parsed",
-    parse: parseProjectPath,
+    parse: String,
     brief: "Path to the project .yyp file",
     optional: true,
   },
@@ -79,7 +79,8 @@ export async function setupCache(
   if (flags.cacheDir) {
     cacheType = { type: "absolute", path: flags.cacheDir };
   } else if (flags.project) {
-    cacheType = { type: "infer", projectDir: ctx.path.dirname(flags.project) };
+    const projectPath = parseProjectPath(ctx, flags.project);
+    cacheType = { type: "infer", projectDir: ctx.path.dirname(projectPath) };
   } else {
     // Try inferring from cwd.
     const projectPath = await findProjectFile(ctx, ctx.process.cwd());

src/commands/compile/command.ts

@@ -16,7 +16,6 @@
 
 import { buildCommand } from "@stricli/core";
 import { TARGETS, TargetSchema } from "~/target";
-import { parseProjectPath } from "~/project";
 import { parseToolchainVersion } from "~/toolchain";
 
 export const compileProjectCommand = buildCommand({
@@ -28,7 +27,7 @@ export const compileProjectCommand = buildCommand({
         {
           brief: "Path to the project .yyp file",
           placeholder: "project",
-          parse: parseProjectPath,
+          parse: String,
           optional: true,
         },
       ],

src/commands/compile/impl.ts

@@ -15,13 +15,18 @@
  */
 
 import type { Context } from "~/context";
-import type { ProjectPath } from "~/project";
+import { parseProjectPath } from "~/project";
 import { runBuildPipeline, type CommonCliBuildFlags } from "~/build-pipeline";
 
 export default async function (
   this: Context,
   flags: CommonCliBuildFlags,
-  project?: ProjectPath,
+  project?: string,
 ): Promise<void> {
-  await runBuildPipeline(this, flags, project, { type: "compile" });
+  await runBuildPipeline(
+    this,
+    flags,
+    project ? parseProjectPath(this, project) : undefined,
+    { type: "compile" },
+  );
 }

src/commands/gxgames/command.ts

@@ -15,12 +15,11 @@
  */
 
 import { buildCommand, buildRouteMap } from "@stricli/core";
-import { parseProjectPath } from "~/project";
 
 const projectParam = {
   brief: "Path to the project .yyp file (defaults to current directory)",
   placeholder: "project",
-  parse: parseProjectPath,
+  parse: String,
   optional: true as const,
 };
 

src/commands/gxgames/commands/link-impl.ts

@@ -17,7 +17,7 @@
 import * as p from "@clack/prompts";
 import type { Context } from "~/context";
 import { KnownError } from "~/error";
-import type { ProjectPath } from "~/project";
+import { parseProjectPath } from "~/project";
 
 import { createAuthManager } from "../auth";
 import { apiUserErrorMessage, getApiClient } from "../api";
@@ -26,11 +26,12 @@ import { LinkStorage } from "../api";
 export default async function (
   this: Context,
   flags: { studioid?: string; gameid?: string },
-  project?: ProjectPath,
+  project?: string,
 ): Promise<void> {
   let studioId = flags.studioid;
   let gameId = flags.gameid;
-  const projectDir = project ? this.path.dirname(project) : undefined;
+  const projectPath = project ? parseProjectPath(this, project) : undefined;
+  const projectDir = projectPath ? this.path.dirname(projectPath) : undefined;
 
   if (!studioId || !gameId) {
     const api = getApiClient(this, createAuthManager(this, projectDir));

src/commands/gxgames/commands/meta-impl.ts

@@ -16,7 +16,7 @@
 
 import type { Context } from "~/context";
 import { KnownError } from "~/error";
-import type { ProjectPath } from "~/project";
+import { parseProjectPath } from "~/project";
 
 import { apiUserErrorMessage, LinkStorage } from "../api";
 import { createAuthManager } from "../auth";
@@ -39,9 +39,10 @@ interface MetaFlags {
 export default async function (
   this: Context,
   flags: MetaFlags,
-  project?: ProjectPath,
+  project?: string,
 ): Promise<void> {
-  const projectDir = project ? this.path.dirname(project) : undefined;
+  const projectPath = project ? parseProjectPath(this, project) : undefined;
+  const projectDir = projectPath ? this.path.dirname(projectPath) : undefined;
   const link = await new LinkStorage(this, projectDir).read();
   const api = getApiClient(this, createAuthManager(this, projectDir));
 

src/commands/gxgames/commands/publish-impl.ts

@@ -17,7 +17,7 @@
 import type { Context } from "~/context";
 import chalk from "chalk";
 import { KnownError } from "~/error";
-import type { ProjectPath } from "~/project";
+import { parseProjectPath } from "~/project";
 
 import { apiUserErrorMessage, LinkStorage } from "../api";
 import { createAuthManager } from "../auth";
@@ -26,9 +26,10 @@ import { getApiClient } from "../api";
 export default async function (
   this: Context,
   _flags: Record<never, never>,
-  project?: ProjectPath,
+  project?: string,
 ): Promise<void> {
-  const projectDir = project ? this.path.dirname(project) : undefined;
+  const projectPath = project ? parseProjectPath(this, project) : undefined;
+  const projectDir = projectPath ? this.path.dirname(projectPath) : undefined;
   const link = await new LinkStorage(this, projectDir).read();
   const api = getApiClient(this, createAuthManager(this, projectDir));
 

src/commands/gxgames/commands/upload-impl.ts

@@ -20,7 +20,7 @@ import chalk from "chalk";
 import { apiUserErrorMessage, getApiClient } from "../api";
 import { createAuthManager } from "../auth";
 import { KnownError } from "~/error";
-import type { ProjectPath } from "~/project";
+import { parseProjectPath } from "~/project";
 
 import { LinkStorage } from "../api";
 
@@ -33,9 +33,10 @@ const validateVersion = (v: string | undefined): string | undefined =>
 export default async function (
   this: Context,
   flags: { file: string; version?: string },
-  project?: ProjectPath,
+  project?: string,
 ): Promise<void> {
-  const projectDir = project ? this.path.dirname(project) : undefined;
+  const projectPath = project ? parseProjectPath(this, project) : undefined;
+  const projectDir = projectPath ? this.path.dirname(projectPath) : undefined;
   const link = await new LinkStorage(this, projectDir).read();
 
   const api = getApiClient(this, createAuthManager(this, projectDir));

src/commands/package/command.ts

@@ -16,7 +16,6 @@
 
 import { buildCommand } from "@stricli/core";
 import { TARGETS, TargetSchema } from "~/target";
-import { parseProjectPath } from "~/project";
 import { parseToolchainVersion } from "~/toolchain";
 
 export const packageCommand = buildCommand({
@@ -28,7 +27,7 @@ export const packageCommand = buildCommand({
         {
           brief: "Path to the project .yyp file",
           placeholder: "project",
-          parse: parseProjectPath,
+          parse: String,
           optional: true,
         },
       ],

src/commands/package/impl.ts

@@ -15,16 +15,21 @@
  */
 
 import type { Context } from "~/context";
-import type { ProjectPath } from "~/project";
+import { parseProjectPath } from "~/project";
 import { runBuildPipeline, type CommonCliBuildFlags } from "~/build-pipeline";
 
 export default async function (
   this: Context,
   flags: CommonCliBuildFlags & { output?: string },
-  project?: ProjectPath,
+  project?: string,
 ): Promise<void> {
-  await runBuildPipeline(this, flags, project, {
-    type: "package",
-    outputPath: flags.output,
-  });
+  await runBuildPipeline(
+    this,
+    flags,
+    project ? parseProjectPath(this, project) : undefined,
+    {
+      type: "package",
+      outputPath: flags.output,
+    },
+  );
 }

src/commands/resourcetool/command.ts

@@ -15,7 +15,6 @@
  */
 
 import { buildCommand, buildRouteMap } from "@stricli/core";
-import { parseProjectPath, type ProjectPath } from "~/project";
 import type { Context } from "~/context";
 import type { CommonFlags } from "./impl";
 
@@ -31,7 +30,7 @@ const commonFlags = {
 const projectParam = {
   brief: "Path to the project .yyp file",
   placeholder: "project",
-  parse: parseProjectPath,
+  parse: String,
   optional: true as const,
 };
 
@@ -44,7 +43,7 @@ export const resourcetoolCommand = buildRouteMap({
           default: async function (
             this: Context,
             flags: CommonFlags,
-            project?: ProjectPath,
+            project?: string,
           ) {
             return run(this, flags, project, { mode: "mcp" });
           },
@@ -64,7 +63,7 @@ export const resourcetoolCommand = buildRouteMap({
             this: Context,
             flags: CommonFlags,
             command: string,
-            project?: ProjectPath,
+            project?: string,
           ) {
             return run(this, flags, project, { mode: "command", command });
           },
@@ -93,7 +92,7 @@ export const resourcetoolCommand = buildRouteMap({
           default: async function (
             this: Context,
             flags: CommonFlags,
-            project?: ProjectPath,
+            project?: string,
           ) {
             return run(this, flags, project, { mode: "cli" });
           },
@@ -113,7 +112,7 @@ export const resourcetoolCommand = buildRouteMap({
             this: Context,
             flags: CommonFlags,
             file: string,
-            project?: ProjectPath,
+            project?: string,
           ) {
             return run(this, flags, project, {
               mode: "script",

src/commands/resourcetool/impl.ts

@@ -16,7 +16,7 @@
 
 import { Cache } from "~/cache";
 import { type Context } from "~/context";
-import { findProjectFile, type ProjectPath } from "~/project";
+import { findProjectFile, parseProjectPath } from "~/project";
 import {
   downloadGmpm,
   downloadPackageTool,
@@ -34,11 +34,13 @@ export interface CommonFlags {
 export async function run(
   ctx: Context,
   flags: CommonFlags,
-  project: ProjectPath | undefined,
+  project: string | undefined,
   mode: ResourceToolMode,
 ): Promise<void> {
   const cwd = ctx.process.cwd();
-  const projectPath = project ?? (await findProjectFile(ctx, cwd));
+  const projectPath = project
+    ? parseProjectPath(ctx, project)
+    : await findProjectFile(ctx, cwd);
 
   if (projectPath === undefined && mode.mode === "mcp") {
     // Since we hide the "project load" tool in mcp mode

src/commands/run/command.ts

@@ -16,7 +16,6 @@
 
 import { buildCommand } from "@stricli/core";
 import { TARGETS, TargetSchema } from "~/target";
-import { parseProjectPath } from "~/project";
 import { parseToolchainVersion } from "~/toolchain";
 
 export const runCommand = buildCommand({
@@ -28,7 +27,7 @@ export const runCommand = buildCommand({
         {
           brief: "Path to the project .yyp file",
           placeholder: "project",
-          parse: parseProjectPath,
+          parse: String,
           optional: true,
         },
       ],

src/commands/run/impl.ts

@@ -15,13 +15,18 @@
  */
 
 import type { Context } from "~/context";
-import type { ProjectPath } from "~/project";
+import { parseProjectPath } from "~/project";
 import { runBuildPipeline, type CommonCliBuildFlags } from "~/build-pipeline";
 
 export default async function (
   this: Context,
   flags: CommonCliBuildFlags,
-  project?: ProjectPath,
+  project?: string,
 ): Promise<void> {
-  await runBuildPipeline(this, flags, project, { type: "run" });
+  await runBuildPipeline(
+    this,
+    flags,
+    project ? parseProjectPath(this, project) : undefined,
+    { type: "run" },
+  );
 }

src/project.ts

@@ -19,11 +19,11 @@ import { KnownError } from "./error";
 
 export type ProjectPath = string & { readonly __brand: unique symbol };
 
-export function parseProjectPath(s: string): ProjectPath {
+export function parseProjectPath(ctx: Context, s: string): ProjectPath {
   if (!s.endsWith(".yyp")) {
     throw new KnownError(`Expected a file with the .yyp extension.`);
   }
-  return s as ProjectPath;
+  return ctx.path.resolve(s) as ProjectPath;
 }
 
 export async function findProjectFile(
@@ -35,7 +35,7 @@ export async function findProjectFile(
   if (!yypFile) {
     return undefined;
   }
-  return ctx.path.join(dir, yypFile) as ProjectPath;
+  return ctx.path.resolve(ctx.path.join(dir, yypFile)) as ProjectPath;
 }
 
 export function getProjectName(ctx: Context, projectPath: ProjectPath) {