Настройка исключений для диагностики CommentedCodeDiagnostic

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/CommentedCodeDiagnostic.java

@@ -41,9 +41,12 @@
 import org.eclipse.lsp4j.TextEdit;
 
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 @DiagnosticMetadata(
@@ -67,6 +70,11 @@ public class CommentedCodeDiagnostic extends AbstractDiagnostic implements Quick
   )
   private float threshold = COMMENTED_CODE_THRESHOLD;
 
+  @DiagnosticParameter(
+    type = String.class
+  )
+  private Set<String> exclusionPrefixes = Collections.emptySet();
+
   private List<MethodDescription> methodDescriptions;
   private CodeRecognizer codeRecognizer;
 
@@ -78,6 +86,12 @@ public CommentedCodeDiagnostic() {
   public void configure(Map<String, Object> configuration) {
     threshold = ((Number) configuration.getOrDefault("threshold", threshold)).floatValue();
     codeRecognizer = new CodeRecognizer(threshold, new BSLFootprint());
+
+    String excludePrefixesString = (String) configuration.getOrDefault("exclusionPrefixes", "");
+    exclusionPrefixes = Arrays.stream(excludePrefixesString.split(","))
+      .map(String::trim)
+      .filter(s -> !s.isEmpty())
+      .collect(Collectors.toSet());
   }
 
   @Override
@@ -170,11 +184,18 @@ private void checkCommentGroup(List<Token> commentGroup) {
   }
 
   private boolean isTextParsedAsCode(String text) {
+    String uncommented = uncomment(text);
+
+    for (String prefix : exclusionPrefixes) {
+      if (uncommented.startsWith(prefix)) {
+        return false;
+      }
+    }
     if (!codeRecognizer.meetsCondition(text)) {
       return false;
     }
 
-    BSLTokenizer tokenizer = new BSLTokenizer(uncomment(text));
+    BSLTokenizer tokenizer = new BSLTokenizer(uncommented);
     final List<Token> tokens = tokenizer.getTokens();
 
     // Если меньше двух токенов нет смысла анализировать - это код

src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/parameters-schema.json

@@ -167,6 +167,12 @@
             ],
             "title": "Commented out code",
             "properties": {
+                "exclusionPrefixes": {
+                    "description": "Exclusion prefixes",
+                    "default": "",
+                    "type": "string",
+                    "title": "Exclusion prefixes"
+                },
                 "threshold": {
                     "description": "Threshold",
                     "default": 0.9,
@@ -837,7 +843,7 @@
                 },
                 "listOfIncorrectFirstSymbol": {
                     "description": "Vertical bar-separated characters that should not start the line (special characters must be escaped)",
-                    "default": "\\)|;|,|\\);",
+                    "default": "\\)|;|,\\s*\\S+|\\);",
                     "type": "string",
                     "title": "Vertical bar-separated characters that should not start the line (special characters must be escaped)"
                 }

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/CommentedCodeDiagnostic_en.properties

@@ -1,4 +1,5 @@
 diagnosticMessage=Modules must not have commented out code
 diagnosticName=Commented out code
 quickFixMessage=Remove commented code
-threshold=Threshold
+threshold=Threshold
+exclusionPrefixes=Exclusion prefixes

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/CommentedCodeDiagnostic_ru.properties

@@ -1,4 +1,5 @@
 diagnosticMessage=Программные модули не должны иметь закомментированных фрагментов кода
 diagnosticName=Закомментированный фрагмент кода
 quickFixMessage=Удалить закомментированный код
-threshold=Порог чуствительности
+threshold=Порог чуствительности
+exclusionPrefixes=Префиксы исключений

src/test/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/CommentedCodeDiagnosticTest.java

@@ -40,8 +40,23 @@ class CommentedCodeDiagnosticTest extends AbstractDiagnosticTest<CommentedCodeDi
   @Test
   void runTest() {
     List<Diagnostic> diagnostics = getDiagnostics();
+    check(diagnostics, false);
+  }
 
-    assertThat(diagnostics).hasSize(11);
+  @Test
+  void exclusionPrefixesTest(){
+    Map<String, Object> configuration = diagnosticInstance.info.getDefaultConfiguration();
+    configuration.put("exclusionPrefixes", "<code>");
+    diagnosticInstance.configure(configuration);
+
+    var diagnostics = getDiagnostics();
+    check(diagnostics, true);
+  }
+
+  void check(List<Diagnostic> diagnostics, boolean excludePrefixes){
+    int expectedSize = excludePrefixes?11:12;
+
+    assertThat(diagnostics).hasSize(expectedSize);
     assertThat(diagnostics, true)
       .hasRange(0, 0, 6, 81)
       .hasRange(16, 4, 34, 16)
@@ -54,6 +69,10 @@ void runTest() {
       .hasRange(117, 0, 118, 24)
       .hasRange(203, 0, 203, 32)
       .hasRange(244, 0, 264, 152);
+
+    if(!excludePrefixes){
+      assertThat(diagnostics, true).hasRange(268, 4, 270, 22);
+    }
   }
 
   @Test

src/test/resources/diagnostics/CommentedCodeDiagnostic.bsl

@@ -264,6 +264,14 @@
 // Синтаксис:
 // Процедура ПриЗавершенииСеансов(ФормаВладелец, Знач МассивСеансов, СтандартнаяОбработка, Знач ОповещениеПослеЗавершенияСеансов = Неопределено) Экспорт
 
+Процедура ШаблонМетода(Параметр)
+
+    //<code>Если Истина Тогда
+    //<code>Возврат;
+    //<code>КонецЕсли;
+
+КонецПроцедуры
+
 #КонецОбласти
 
 ////////////////////////////////////////////////////////////////////////////////