[FIX] ui5 init: Improve error message (#661)

Fixes: SAP/ui5-tooling#306
SAP · Oct 30, 2023 · 07e68b0 · 07e68b0
1 parent 5fb183d
commit 07e68b0
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 11 deletions.
diff --git a/lib/init/init.js b/lib/init/init.js
@@ -48,7 +48,10 @@ function getProjectType(hasWebapp, hasSrc, hasTest) {
 
 	let message = `Could not detect project type: ${errorReason}`;
 	message += "Applications should only have a 'webapp' folder.\n";
-	message += "Libraries should only have a 'src' and (optional) 'test' folder.";
+	message += "Libraries should only have an 'src' and (optional) 'test' folder.";
+	message += "\n\n";
+	message += "If you are about to start a new project, please refer to:\n";
+	message += "https://sap.github.io/ui5-tooling/v3/pages/GettingStarted/#starting-a-new-project";
 	throw new Error(message);
 }
 

diff --git a/test/lib/init/init.js b/test/lib/init/init.js
@@ -40,49 +40,50 @@ test("Init for library", async (t) => {
 	});
 });
 
+const GENERAL_ERROR_MESSAGE = `Applications should only have a 'webapp' folder.
+Libraries should only have an 'src' and (optional) 'test' folder.
+
+If you are about to start a new project, please refer to:
+https://sap.github.io/ui5-tooling/v3/pages/GettingStarted/#starting-a-new-project`;
+
 test("Init for invalid project (Found 'webapp', 'src' and 'test' folders)", async (t) => {
 	await t.throwsAsync(init({
 		cwd: getFixturePath("invalid-webapp-src-test")
 	}), {message:
 	"Could not detect project type: Found 'webapp', 'src' and 'test' folders.\n" +
-	"Applications should only have a 'webapp' folder.\n" +
-	"Libraries should only have a 'src' and (optional) 'test' folder."});
+	GENERAL_ERROR_MESSAGE});
 });
 
 test("Init for invalid project (Found 'webapp' and 'src' folders)", async (t) => {
 	await t.throwsAsync(init({
 		cwd: getFixturePath("invalid-webapp-src")
 	}), {message:
 	"Could not detect project type: Found 'webapp' and 'src' folders.\n" +
-	"Applications should only have a 'webapp' folder.\n" +
-	"Libraries should only have a 'src' and (optional) 'test' folder."});
+	GENERAL_ERROR_MESSAGE});
 });
 
 test("Init for invalid project (Found 'webapp' and 'test' folders)", async (t) => {
 	await t.throwsAsync(init({
 		cwd: getFixturePath("invalid-webapp-test")
 	}), {message:
 	"Could not detect project type: Found 'webapp' and 'test' folders.\n" +
-	"Applications should only have a 'webapp' folder.\n" +
-	"Libraries should only have a 'src' and (optional) 'test' folder."});
+	GENERAL_ERROR_MESSAGE});
 });
 
 test("Init for invalid project (Found 'test' folder but no 'src' folder)", async (t) => {
 	await t.throwsAsync(init({
 		cwd: getFixturePath("invalid-test")
 	}), {message:
 	"Could not detect project type: Found 'test' folder but no 'src' folder.\n" +
-	"Applications should only have a 'webapp' folder.\n" +
-	"Libraries should only have a 'src' and (optional) 'test' folder."});
+	GENERAL_ERROR_MESSAGE});
 });
 
 test("Init for invalid project (Could not find 'webapp' or 'src' / 'test' folders)", async (t) => {
 	await t.throwsAsync(init({
 		cwd: getFixturePath("invalid")
 	}), {message:
 	"Could not detect project type: Could not find 'webapp' or 'src' / 'test' folders.\n" +
-	"Applications should only have a 'webapp' folder.\n" +
-	"Libraries should only have a 'src' and (optional) 'test' folder."});
+	GENERAL_ERROR_MESSAGE});
 });
 
 test("Init for invalid project (No package.json)", async (t) => {