Описание у асинх методов и с аннотациями

asosnoviy · asosnoviy · commit 59bb95c07591 · 2022-08-11T16:50:41.000+03:00
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -70,7 +70,7 @@ dependencies {
     api("org.eclipse.lsp4j", "org.eclipse.lsp4j", "0.14.0")
 
     // 1c-syntax
-    api("com.github.1c-syntax", "bsl-parser", "0.21.0") {
+    api("com.github.1c-syntax", "bsl-parser", "24a5789e241") {
         exclude("com.tunnelvisionlabs", "antlr4-annotations")
         exclude("com.ibm.icu", "*")
         exclude("org.antlr", "ST4")
diff --git a/src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputer.java b/src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputer.java
@@ -90,6 +90,7 @@ public ParseTree visitFunction(BSLParser.FunctionContext ctx) {
     }
 
     MethodSymbol methodSymbol = createMethodSymbol(
+      declaration.getStart(),
       startNode,
       stopNode,
       declaration.subName().getStart(),
@@ -120,6 +121,7 @@ public ParseTree visitProcedure(BSLParser.ProcedureContext ctx) {
     }
 
     MethodSymbol methodSymbol = createMethodSymbol(
+      declaration.getStart(),
       startNode,
       stopNode,
       declaration.subName().getStart(),
@@ -180,6 +182,7 @@ private static Optional<CompilerDirectiveKind> getCompilerDirective(
   }
 
   private MethodSymbol createMethodSymbol(
+    Token startToken,
     TerminalNode startNode,
     TerminalNode stopNode,
     Token subName,
@@ -189,7 +192,7 @@ private MethodSymbol createMethodSymbol(
     Optional<CompilerDirectiveKind> compilerDirective,
     List<Annotation> annotations
   ) {
-    Optional<MethodDescription> description = createDescription(startNode.getSymbol());
+    Optional<MethodDescription> description = createDescription(startToken);
     boolean deprecated = description
       .map(MethodDescription::isDeprecated)
       .orElse(false);
diff --git a/src/main/java/com/github/_1c_syntax/bsl/languageserver/utils/Trees.java b/src/main/java/com/github/_1c_syntax/bsl/languageserver/utils/Trees.java
@@ -21,6 +21,7 @@
  */
 package com.github._1c_syntax.bsl.languageserver.utils;
 
+import com.github._1c_syntax.bsl.parser.BSLLexer;
 import com.github._1c_syntax.bsl.parser.BSLParser;
 import com.github._1c_syntax.bsl.parser.BSLParserRuleContext;
 import lombok.experimental.UtilityClass;
@@ -49,16 +50,16 @@
 public final class Trees {
 
   private static final Set<Integer> VALID_TOKEN_TYPES_FOR_COMMENTS_SEARCH = Set.of(
-    BSLParser.ANNOTATION_ATCLIENT_SYMBOL,
-    BSLParser.ANNOTATION_ATSERVERNOCONTEXT_SYMBOL,
-    BSLParser.ANNOTATION_ATCLIENTATSERVERNOCONTEXT_SYMBOL,
-    BSLParser.ANNOTATION_ATCLIENTATSERVER_SYMBOL,
-    BSLParser.ANNOTATION_ATSERVER_SYMBOL,
-    BSLParser.ANNOTATION_CUSTOM_SYMBOL,
-    BSLParser.ANNOTATION_UNKNOWN,
-    BSLParser.LINE_COMMENT,
-    BSLParser.WHITE_SPACE,
-    BSLParser.AMPERSAND
+    BSLLexer.ANNOTATION_ATCLIENT_SYMBOL,
+    BSLLexer.ANNOTATION_ATSERVERNOCONTEXT_SYMBOL,
+    BSLLexer.ANNOTATION_ATCLIENTATSERVERNOCONTEXT_SYMBOL,
+    BSLLexer.ANNOTATION_ATCLIENTATSERVER_SYMBOL,
+    BSLLexer.ANNOTATION_ATSERVER_SYMBOL,
+    BSLLexer.ANNOTATION_CUSTOM_SYMBOL,
+    BSLLexer.ANNOTATION_UNKNOWN,
+    BSLLexer.LINE_COMMENT,
+    BSLLexer.WHITE_SPACE,
+    BSLLexer.AMPERSAND
   );
 
   /**
diff --git a/src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputerTest.java b/src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputerTest.java
@@ -192,6 +192,7 @@ void testAnnotation() {
     // AROUND
     methodSymbol = methods.get(22);
     assertThat(methodSymbol.getName()).isEqualTo("Р_Вместо");
+    assertThat(methodSymbol.getDescription()).isNotEmpty();
     assertThat(methodSymbol.getAnnotations().get(0).getName()).isEqualTo("Вместо");
     assertThat(methodSymbol.getAnnotations().get(0).getKind()).isEqualTo(AnnotationKind.AROUND);
     assertThat(methodSymbol.getAnnotations().get(0).getParameters().get(0).getValue()).isEqualTo("Вместо");
diff --git a/src/test/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/MethodDescriptionTest.java b/src/test/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/MethodDescriptionTest.java
@@ -44,18 +44,47 @@ void prepare() {
       var documentContext = TestUtils.getDocumentContextFromFile("./src/test/resources/context/symbol/MethodDescription.bsl");
       var methods = documentContext.getSymbolTree().getMethods();
 
-      assertThat(methods.size()).isEqualTo(14);
+      assertThat(methods.size()).isEqualTo(18);
 
       methodsWithDescription = methods.stream()
         .map(MethodSymbol::getDescription)
         .filter(Optional::isPresent)
         .map(Optional::get)
         .collect(Collectors.toList());
 
-      assertThat(methodsWithDescription.size()).isEqualTo(13);
+      assertThat(methodsWithDescription.size()).isEqualTo(15);
     }
   }
 
+  @Test
+  void testMethod15() {
+    var method = methodsWithDescription.get(14);
+    assertThat(method.getPurposeDescription())
+      .isNotEmpty()
+      .isEqualTo("См. ОбщийМодуль.ОписаниеСсылкойАсинх");
+    assertThat(method.isDeprecated()).isFalse();
+    assertThat(method.getDeprecationInfo()).isEmpty();
+    assertThat(method.getExamples()).isEmpty();
+    assertThat(method.getCallOptions()).isEmpty();
+    assertThat(method.getParameters()).isEmpty();
+    assertThat(method.getReturnedValue()).isEmpty();
+    assertThat(method.getLink()).isNotEmpty();
+  }
+  @Test
+  void testMethod14() {
+    var method = methodsWithDescription.get(13);
+    assertThat(method.getPurposeDescription())
+      .isNotEmpty()
+      .isEqualTo("См. ОбщийМодуль.Метод()");
+    assertThat(method.isDeprecated()).isFalse();
+    assertThat(method.getDeprecationInfo()).isEmpty();
+    assertThat(method.getExamples()).isEmpty();
+    assertThat(method.getCallOptions()).isEmpty();
+    assertThat(method.getParameters()).isEmpty();
+    assertThat(method.getReturnedValue()).isEmpty();
+    assertThat(method.getLink()).isNotEmpty();
+  }
+
   @Test
   void testMethod13() {
     var method = methodsWithDescription.get(12);
diff --git a/src/test/resources/context/computer/MethodSymbolComputerTest.bsl b/src/test/resources/context/computer/MethodSymbolComputerTest.bsl
@@ -108,6 +108,7 @@
 Процедура Р_После()
 КонецПроцедуры
 
+// Описание метода
 &Вместо("Вместо")
 Функция Р_Вместо()
 КонецФункции
diff --git a/src/test/resources/context/symbol/MethodDescription.bsl b/src/test/resources/context/symbol/MethodDescription.bsl
@@ -143,3 +143,15 @@
 //
 Функция BUG_1495(Ссылки, Знач Реквизиты, ВыбратьРазрешенные = Ложь) Экспорт
 КонецФункции
+
+// См. ОбщийМодуль.Метод()
+&Перед("ОписаниеСсылкойВРасширении")
+Функция ОписаниеСсылкойВРасширении(Параметр1, Знач Параметр2 = 3)
+КонецФункции
+Функция НаписанаБезПробела()
+КонецФункции  Процедура НаписанаВоднуСтроку() КонецПроцедуры
+
+// См. ОбщийМодуль.ОписаниеСсылкойАсинх
+&НаКлиенте
+Асинх Функция ОписаниеСсылкойАсинх()
+КонецФункции
diff --git a/src/test/resources/diagnostics/PublicMethodsDescriptionDiagnostic.bsl b/src/test/resources/diagnostics/PublicMethodsDescriptionDiagnostic.bsl
@@ -107,4 +107,19 @@
 
 КонецФункции
 
+// см. КакойтоМодуль.Метод
+Функция ОписаниеСм() Экспорт
+
+    Возврат Неопределено;
+
+КонецФункции
+
+// см. КакойтоМодуль.Метод
+&Перед("ОписаниеСмПеред")
+Функция ОписаниеСмПеред() Экспорт
+
+     Возврат Неопределено;
+
+КонецФункции
+
 #КонецОбласти
