Merge pull request #2687 from opral/clearer-project-settings-errors

MESDK-82 Improve error handling for module URLs in project settings

.changeset/witty-icons-kick.md

@@ -0,0 +1,6 @@
+---
+"@inlang/project-settings": patch
+"@inlang/sdk": patch
+---
+
+Improve error handling for module URLs in project settings

inlang/source-code/sdk/src/errors.ts

@@ -1,3 +1,4 @@
+import type { SchemaOptions } from "@sinclair/typebox"
 import type { ValueError } from "@sinclair/typebox/errors"
 
 export class LoadProjectInvalidArgument extends Error {
@@ -11,15 +12,26 @@ export class ProjectSettingsInvalidError extends Error {
 	constructor(options: { errors: ValueError[] }) {
 		// TODO: beatufiy ValueErrors
 		super(
-			`The project settings are invalid:\n\n${options.errors
-				.filter((error) => error.path)
-				.map((error) => `"${error.path}":\n\n${error.message}`)
-				.join("\n")}`
+			`The project settings are invalid:
+${options.errors
+	.filter((error) => error.path)
+	.map(FormatProjectSettingsError)
+	.join("\n")}`
 		)
 		this.name = "ProjectSettingsInvalidError"
 	}
 }
 
+function FormatProjectSettingsError(error: ValueError) {
+	let msg = `${error.message} at ${error.path}`
+	if (error.path.startsWith("/modules/")) {
+		msg += `
+value = "${error.value}"
+- ${error.schema.allOf.map((o: SchemaOptions) => `${o.description ?? ""}`).join("\n- ")}`
+	}
+	return msg
+}
+
 export class ProjectSettingsFileJSONSyntaxError extends Error {
 	constructor(options: { cause: ErrorOptions["cause"]; path: string }) {
 		super(

inlang/source-code/versioned-interfaces/project-settings/src/interface.ts

@@ -65,8 +65,7 @@ const InternalProjectSettings = Type.Object({
 			}),
 			Type.String({
 				pattern: "^(?!.*@\\d\\.)[^]*$",
-				description:
-					"The module can only contain a major version number (ComVer, not SemVer). See https://inlang.com/documentation/comver",
+				description: "The module can only contain a major version number.",
 			}),
 		]),
 		{