feat: validator & compiler provide presence name in errors (PreMiD#8731)

* feat(PresenceValidator): provide presence name in errors * feat(PresenceValidator): provide presence name in ALL errors * feat(PresenceCompiler): add presence name on error * Update tools/auto/presenceValidator.ts Co-authored-by: Bas van Zanten <[email protected]> Signed-off-by: github plz bring back DarkVIllager <[email protected]> * Update tools/auto/presenceValidator.ts Co-authored-by: Bas van Zanten <[email protected]> Signed-off-by: github plz bring back DarkVIllager <[email protected]> * Update tools/auto/presenceValidator.ts Co-authored-by: Bas van Zanten <[email protected]> Signed-off-by: github plz bring back DarkVIllager <[email protected]> --------- Signed-off-by: github plz bring back DarkVIllager <[email protected]> Co-authored-by: Bas van Zanten <[email protected]>
theusaf · Sep 19, 2024 · c72ffcd · c72ffcd
1 parent 3e4b043
commit c72ffcd
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 18 deletions.
diff --git a/tools/auto/presenceValidator.ts b/tools/auto/presenceValidator.ts
@@ -46,7 +46,7 @@ for (const presence of changedPresences) {
 	if (!existsSync(resolve(presencePath, "metadata.json"))) {
 		errors.push({
 			presence,
-			message: "Presence is missing metadata.json",
+			message: `Presence (${presence}) is missing metadata.json`,
 			properties: {
 				file: resolve(presencePath, "metadata.json"),
 			},
@@ -61,7 +61,7 @@ for (const presence of changedPresences) {
 	} catch {
 		errors.push({
 			presence,
-			message: "Presence metadata.json is not a valid JSON file",
+			message: `Presence (${presence}) metadata.json is not a valid JSON file`,
 			properties: {
 				file: resolve(presencePath, "metadata.json"),
 			},
@@ -97,7 +97,7 @@ for (const presence of changedPresences) {
 	if (metadata.$schema !== schema.url) {
 		errors.push({
 			presence,
-			message: `Schema version is not up to date - expected: ${schema.url}, got: ${metadata.$schema}`,
+			message: `Schema version is not up to date (Presence: ${presence}) - expected: ${schema.url}, got: ${metadata.$schema}`,
 			properties: {
 				file: resolve(presencePath, "metadata.json"),
 				startLine: getLine("$schema"),
@@ -113,7 +113,7 @@ for (const presence of changedPresences) {
 		if (compare(metadata.version, storePresence.metadata.version) <= 0) {
 			errors.push({
 				presence,
-				message: "Version has not been bumped",
+				message: `Version has not been bumped (Presence: ${presence})`,
 				properties: {
 					file: resolve(presencePath, "metadata.json"),
 					startLine: getLine("version"),
@@ -123,7 +123,7 @@ for (const presence of changedPresences) {
 	} else if (metadata.version !== "1.0.0") {
 		errors.push({
 			presence,
-			message: "Initial version must be 1.0.0",
+			message: `Initial version must be 1.0.0 (Presence: ${presence})`,
 			properties: {
 				file: resolve(presencePath, "metadata.json"),
 				startLine: getLine("version"),
@@ -139,7 +139,7 @@ for (const presence of changedPresences) {
 	if (!existsSync(iframePath) && metadata.iframe) {
 		errors.push({
 			presence,
-			message: "Presence is missing iframe.ts",
+			message: `Presence (${presence}) is missing iframe.ts`,
 			properties: {
 				file: iframePath,
 			},
@@ -149,7 +149,7 @@ for (const presence of changedPresences) {
 	if (!metadata.iframe && existsSync(iframePath)) {
 		errors.push({
 			presence,
-			message: "Presence has iframe.ts but metadata.iframe is set to false",
+			message: `Presence (${presence}) has iframe.ts but metadata.iframe is set to false`,
 			properties: {
 				file: iframePath,
 			},
@@ -159,8 +159,7 @@ for (const presence of changedPresences) {
 	if (metadata.iFrameRegExp === ".*") {
 		warnings.push({
 			presence,
-			message:
-				"Presence has metadata.iFrameRegExp set to '.*', please change this if possible",
+			message: `Presence (${presence}) has metadata.iFrameRegExp set to '.*', please change this if possible`,
 			properties: {
 				file: resolve(presencePath, "metadata.json"),
 				startLine: getLine("iFrameRegExp"),
@@ -171,8 +170,7 @@ for (const presence of changedPresences) {
 	if (metadata.iFrameRegExp && !metadata.iframe) {
 		errors.push({
 			presence,
-			message:
-				"Presence has metadata.iFrameRegExp set but metadata.iframe is set to false",
+			message: `Presence (${presence}) has metadata.iFrameRegExp set but metadata.iframe is set to false`,
 			properties: {
 				file: resolve(presencePath, "metadata.json"),
 				startLine: getLine("iFrameRegExp"),
@@ -183,8 +181,7 @@ for (const presence of changedPresences) {
 	if (!metadata.iFrameRegExp && metadata.iframe) {
 		warnings.push({
 			presence,
-			message:
-				"Presence has metadata.iframe set to true but metadata.iFrameRegExp is not set, you may want to set it",
+			message: `Presence (${presence}) has metadata.iframe set to true but metadata.iFrameRegExp is not set, you may want to set it`,
 			properties: {
 				file: resolve(presencePath, "metadata.json"),
 				startLine: getLine("iFrameRegExp"),

diff --git a/tools/classes/PresenceCompiler.ts b/tools/classes/PresenceCompiler.ts
@@ -150,12 +150,11 @@ export default class PresenceCompiler {
 				);
 
 				if (job.error) throw job.error;
-
-				if (job.stats?.compilation.errors.length)
+				const { service } = require(resolve(presencePath, "metadata.json"));
+				if (job.stats?.compilation.errors.length) {
+					actions.info(chalk.red(`Failed to compile ${service || presence}`));
 					errors.push(...(job.stats?.compilation?.errors || []));
-				else {
-					const { service } = require(resolve(presencePath, "metadata.json"));
-
+				} else {
 					actions.info(
 						chalk.green(`Successfully compiled ${service || presence}`)
 					);