Improved error message for an unsupported workspace type (bazelbuild#…

…6257)
VirtuslabRnD · Mar 18, 2024 · 9677796 · 9677796
1 parent 9a23caf
commit 9677796
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/base/src/com/google/idea/blaze/base/sync/projectview/LanguageSupport.java b/base/src/com/google/idea/blaze/base/sync/projectview/LanguageSupport.java
@@ -72,8 +72,9 @@ public static boolean validateLanguageSettings(
       StringBuilder messageBuilder = new StringBuilder();
       messageBuilder.append(
               String.format(
-                      "Workspace type '%s' is not supported by this plugin.",
-                      languageSettings.getWorkspaceType().getName())
+                      "Workspace type '%s' is not supported by this plugin. Supported types are %s.",
+                      languageSettings.getWorkspaceType().getName(), supportedTypes
+              )
       );
       // `//:plugin_dev` is a completely optional dependency that won't get enabled
       // unless you have DevKit installed.

diff --git a/base/tests/unittests/com/google/idea/blaze/base/sync/LanguageSupportTest.java b/base/tests/unittests/com/google/idea/blaze/base/sync/LanguageSupportTest.java
@@ -113,7 +113,8 @@ public WorkspaceType getDefaultWorkspaceType() {
     WorkspaceLanguageSettings settings =
         LanguageSupport.createWorkspaceLanguageSettings(projectViewSet);
     LanguageSupport.validateLanguageSettings(context, settings);
-    errorCollector.assertIssues("Workspace type 'c' is not supported by this plugin.");
+    errorCollector.assertIssues("Workspace type 'c' is not supported by this plugin. " +
+            "Supported types are [none].");
   }
 
   @Test
@@ -135,7 +136,8 @@ public WorkspaceType getDefaultWorkspaceType() {
       WorkspaceLanguageSettings settings =
               LanguageSupport.createWorkspaceLanguageSettings(projectViewSet);
       LanguageSupport.validateLanguageSettings(context, settings);
-      errorCollector.assertIssues("Workspace type 'intellij_plugin' is not supported by this plugin. Do you have the DevKit plugin installed?");
+      errorCollector.assertIssues("Workspace type 'intellij_plugin' is not supported by this plugin. " +
+              "Supported types are [none]. Do you have the DevKit plugin installed?");
   }
 
   @Test

diff --git a/...cript/tests/unittests/com/google/idea/blaze/javascript/BlazeJavascriptSyncPluginTest.java b/...cript/tests/unittests/com/google/idea/blaze/javascript/BlazeJavascriptSyncPluginTest.java
@@ -106,6 +106,7 @@ public void testJavascriptWorkspaceTypeUnavailableForCommunityEdition() {
     WorkspaceLanguageSettings workspaceLanguageSettings =
         LanguageSupport.createWorkspaceLanguageSettings(projectViewSet);
     LanguageSupport.validateLanguageSettings(context, workspaceLanguageSettings);
-    errorCollector.assertIssues("Workspace type 'javascript' is not supported by this plugin.");
+    errorCollector.assertIssues("Workspace type 'javascript' is not supported by this plugin. " +
+            "Supported types are [none].");
   }
 }