Улучшение ховера по модулю

Author: nixel2007

src/main/java/com/github/_1c_syntax/bsl/languageserver/hover/DescriptionFormatter.java

@@ -23,6 +23,7 @@
 
 import com.github._1c_syntax.bsl.languageserver.context.symbol.AnnotationSymbol;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.MethodSymbol;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.ModuleSymbol;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.ParameterDefinition;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.VariableSymbol;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.description.MethodDescription;
@@ -137,6 +138,23 @@ public String getSectionWithCodeFences(Collection<String> codeBlocks, String res
     return codeFences;
   }
 
+  public String getLocation(ModuleSymbol symbol) {
+    var documentContext = symbol.getOwner();
+    var uri = documentContext.getUri();
+
+    var mdObject = documentContext.getMdObject();
+    String mdoRefLocal = mdObject.map(md -> documentContext.getServerContext()
+      .getConfiguration()
+      .getMdoRefLocal(md)
+    ).orElseGet(documentContext::getMdoRef);
+
+    return String.format(
+      "[%s](%s)",
+      mdoRefLocal,
+      uri
+    );
+  }
+
   public String getLocation(MethodSymbol symbol) {
     var documentContext = symbol.getOwner();
     var startPosition = symbol.getSelectionRange().getStart();

src/main/java/com/github/_1c_syntax/bsl/languageserver/hover/ModuleSymbolMarkupContentBuilder.java

@@ -24,8 +24,6 @@
 import com.github._1c_syntax.bsl.languageserver.context.symbol.ModuleSymbol;
 import com.github._1c_syntax.bsl.languageserver.utils.Resources;
 import com.github._1c_syntax.bsl.mdo.CommonModule;
-import com.github._1c_syntax.bsl.mdo.support.ReturnValueReuse;
-import com.github._1c_syntax.bsl.types.ModuleType;
 import lombok.RequiredArgsConstructor;
 import org.eclipse.lsp4j.MarkupContent;
 import org.eclipse.lsp4j.MarkupKind;
@@ -43,22 +41,19 @@
 public class ModuleSymbolMarkupContentBuilder implements MarkupContentBuilder<ModuleSymbol> {
 
   private final Resources resources;
+  private final DescriptionFormatter descriptionFormatter;
 
   @Override
   public MarkupContent getContent(ModuleSymbol symbol) {
     var markupBuilder = new StringJoiner("\n");
 
-    // Сигнатура модуля
-    String signature = buildSignature(symbol);
-    addSectionIfNotEmpty(markupBuilder, signature);
-
     // Местоположение модуля
-    String location = buildLocation(symbol);
-    addSectionIfNotEmpty(markupBuilder, location);
+    String moduleLocation = descriptionFormatter.getLocation(symbol);
+    descriptionFormatter.addSectionIfNotEmpty(markupBuilder, moduleLocation);
 
     // Информация о модуле из метаданных
-    String moduleInfo = buildModuleInfo(symbol);
-    addSectionIfNotEmpty(markupBuilder, moduleInfo);
+    String moduleInfo = getModuleInfo(symbol);
+    descriptionFormatter.addSectionIfNotEmpty(markupBuilder, moduleInfo);
 
     String content = markupBuilder.toString();
     return new MarkupContent(MarkupKind.MARKDOWN, content);
@@ -69,48 +64,7 @@ public SymbolKind getSymbolKind() {
     return SymbolKind.Module;
   }
 
-  private String buildSignature(ModuleSymbol symbol) {
-    var documentContext = symbol.getOwner();
-    var moduleType = documentContext.getModuleType();
-    var moduleName = symbol.getName();
-
-    // Для CommonModule показываем только имя модуля
-    if (moduleType == ModuleType.CommonModule) {
-      return String.format("```bsl\n%s\n```", moduleName);
-    }
-
-    // Для остальных типов используем mdoRef в зависимости от локали
-    var mdObject = documentContext.getMdObject();
-    if (mdObject.isPresent()) {
-      var mdoRefLocal = documentContext.getServerContext()
-        .getConfiguration()
-        .getMdoRefLocal(mdObject.get());
-      return String.format("```bsl\n%s\n```", mdoRefLocal);
-    }
-
-    var mdoRef = documentContext.getMdoRef();
-    return String.format("```bsl\n%s\n```", mdoRef);
-  }
-
-  private String buildLocation(ModuleSymbol symbol) {
-    var documentContext = symbol.getOwner();
-    var uri = documentContext.getUri();
-    
-    // Используем локализованный mdoRef
-    var mdObject = documentContext.getMdObject();
-    String mdoRefLocal;
-    if (mdObject.isPresent()) {
-      mdoRefLocal = documentContext.getServerContext()
-        .getConfiguration()
-        .getMdoRefLocal(mdObject.get());
-    } else {
-      mdoRefLocal = documentContext.getMdoRef();
-    }
-
-    return String.format("[%s](%s)", mdoRefLocal, uri);
-  }
-
-  private String buildModuleInfo(ModuleSymbol symbol) {
+  private String getModuleInfo(ModuleSymbol symbol) {
     var documentContext = symbol.getOwner();
     var mdObject = documentContext.getMdObject();
 
@@ -123,13 +77,13 @@ private String buildModuleInfo(ModuleSymbol symbol) {
       return "";
     }
 
-    var infoBuilder = new StringJoiner("\n");
+    var moduleInfoBuilder = new StringJoiner("\n");
 
     // Комментарий
     var comment = commonModule.getComment();
     if (!comment.isBlank()) {
-      infoBuilder.add(comment);
-      infoBuilder.add("");
+      moduleInfoBuilder.add(comment);
+      moduleInfoBuilder.add("");
     }
 
     // Флаги доступности
@@ -159,33 +113,24 @@ private String buildModuleInfo(ModuleSymbol symbol) {
 
     if (!flags.isEmpty()) {
       var flagsHeader = "**" + getResourceString("availability") + ":** ";
-      infoBuilder.add(flagsHeader + String.join(", ", flags));
-      infoBuilder.add("");
+      moduleInfoBuilder.add(flagsHeader + String.join(", ", flags));
+      moduleInfoBuilder.add("");
     }
 
     // Режим повторного использования
     var returnValueReuse = commonModule.getReturnValuesReuse();
-    if (returnValueReuse != ReturnValueReuse.DONT_USE) {
-      var reuseKey = switch (returnValueReuse) {
-        case DURING_REQUEST -> "duringRequest";
-        case DURING_SESSION -> "duringSession";
-        default -> "";
-      };
-      if (!reuseKey.isEmpty()) {
-        var reuseHeader = "**" + getResourceString("returnValuesReuse") + ":** ";
-        infoBuilder.add(reuseHeader + getResourceString(reuseKey));
-      }
-    }
+    var reuseKey = switch (returnValueReuse) {
+      case DURING_REQUEST -> "duringRequest";
+      case DURING_SESSION -> "duringSession";
+      case DONT_USE, UNKNOWN -> "";
+    };
 
-    return infoBuilder.toString();
-  }
-
-  private void addSectionIfNotEmpty(StringJoiner markupBuilder, String newContent) {
-    if (!newContent.isEmpty()) {
-      markupBuilder.add(newContent);
-      markupBuilder.add("");
-      markupBuilder.add("---");
+    if (!reuseKey.isEmpty()) {
+      var reuseHeader = "**" + getResourceString("returnValuesReuse") + ":** ";
+      moduleInfoBuilder.add(reuseHeader + getResourceString(reuseKey));
     }
+
+    return moduleInfoBuilder.toString();
   }
 
   private String getResourceString(String key) {

src/main/resources/com/github/_1c_syntax/bsl/languageserver/hover/ModuleSymbolMarkupContentBuilder_en.properties

@@ -1,25 +1,8 @@
-# Module types
-commonModule=Common Module
-managerModule=Manager Module
-objectModule=Object Module
-formModule=Form Module
-commandModule=Command Module
-recordSetModule=Record Set Module
-valueManagerModule=Value Manager Module
-sessionModule=Session Module
-externalConnectionModule=External Connection Module
-managedApplicationModule=Managed Application Module
-ordinaryApplicationModule=Ordinary Application Module
-httpServiceModule=HTTP Service Module
-webServiceModule=Web Service Module
-integrationServiceModule=Integration Service Module
-module=Module
-
 # Availability flags
 availability=Availability
 server=Server
-clientManagedApplication=Managed Application
-clientOrdinaryApplication=Ordinary Application
+clientManagedApplication=Client (Managed Application)
+clientOrdinaryApplication=Client (Ordinary Application)
 externalConnection=External Connection
 serverCall=Server Call
 privilegedMode=Privileged Mode

src/main/resources/com/github/_1c_syntax/bsl/languageserver/hover/ModuleSymbolMarkupContentBuilder_ru.properties

@@ -1,25 +1,8 @@
-# Module types
-commonModule=Общий модуль
-managerModule=Модуль менеджера
-objectModule=Модуль объекта
-formModule=Модуль формы
-commandModule=Модуль команды
-recordSetModule=Модуль набора записей
-valueManagerModule=Модуль менеджера значения
-sessionModule=Модуль сеанса
-externalConnectionModule=Модуль внешнего соединения
-managedApplicationModule=Модуль управляемого приложения
-ordinaryApplicationModule=Модуль обычного приложения
-httpServiceModule=Модуль HTTP-сервиса
-webServiceModule=Модуль Web-сервиса
-integrationServiceModule=Модуль сервиса интеграции
-module=Модуль
-
 # Availability flags
 availability=Доступность
 server=Сервер
-clientManagedApplication=Управляемое приложение
-clientOrdinaryApplication=Обычное приложение
+clientManagedApplication=Клиент (Управляемое приложение)
+clientOrdinaryApplication=Клиент (Обычное приложение)
 externalConnection=Внешнее соединение
 serverCall=Вызов сервера
 privilegedMode=Привилегированный режим

src/test/java/com/github/_1c_syntax/bsl/languageserver/hover/ModuleSymbolMarkupContentBuilderTest.java

@@ -65,15 +65,14 @@ void testContentFromCommonModule() {
 
     var blocks = Arrays.asList(content.split("---\n?"));
 
-    // Должны быть: сигнатура, местоположение, информация о модуле
+    // Должны быть: местоположение, информация о модуле
     assertThat(blocks).hasSizeGreaterThanOrEqualTo(2);
 
     // Сигнатура - для CommonModule показывается только имя модуля
-    assertThat(blocks.get(0)).contains("ПервыйОбщийМодуль");
-    assertThat(blocks.get(0)).doesNotContain("Общий модуль:");
+    assertThat(blocks.get(0)).contains("ОбщийМодуль.ПервыйОбщийМодуль");
 
     // Местоположение - используется локализованный mdoRef
-    assertThat(blocks.get(1)).contains("ОбщийМодуль.ПервыйОбщийМодуль");
+    assertThat(blocks.get(1)).contains("Доступность:");
   }
 
   @Test
@@ -90,7 +89,7 @@ void testContentFromManagerModule() {
 
     var blocks = Arrays.asList(content.split("---\n?"));
 
-    assertThat(blocks).hasSizeGreaterThanOrEqualTo(2);
+    assertThat(blocks).hasSizeGreaterThanOrEqualTo(1);
 
     // Для ManagerModule используется локализованный mdoRef
     assertThat(blocks.get(0)).contains("Справочник.Справочник1");
@@ -110,7 +109,7 @@ void testContentFromObjectModule() {
 
     var blocks = Arrays.asList(content.split("---\n?"));
 
-    assertThat(blocks).hasSizeGreaterThanOrEqualTo(2);
+    assertThat(blocks).hasSizeGreaterThanOrEqualTo(1);
 
     // Для ObjectModule используется локализованный mdoRef
     assertThat(blocks.get(0)).contains("Справочник.Справочник1");