Merge pull request #2860 from artbear/line-break

[FP] IncorrectLineBreak - не ругаемся на висячую запятую

Author: nixel2007

docs/diagnostics/IncorrectLineBreak.md

@@ -21,6 +21,15 @@
 * логические операторы И, ИЛИ ставятся в начале строки, а не в конце предыдущей строки;
 * все условия предваряются стандартным отступом, либо выравниваются по началу первого условия, без учета логического оператора (для выравнивания выражений относительно первой строки рекомендуется использовать пробелы).
 
+**Примеры настройки исключений:**
+
+- Если стандарт вашей команды требует, чтобы закрывающая скобка и разделитель операторов ";" были написаны *после* строки, на которой указан последний параметр, нужно исправить настройку параметра `listOfIncorrectFirstSymbol`
+  - вместо подстроки `|\);` (в конце настройки) нужно написать подстроку `|\)\s*;\s*\S+`
+  - пример финальной строки `\)|;|,\s*\S+|\)s*;\s*\S+`
+  - пример кода указан в секции примеров
+
+Без указанной настройки правило будет выдавать замечания на закрывающую скобка и разделитель операторов ";", если они на отдельной строке.
+
 ## Примеры
 <!-- В данном разделе приводятся примеры, на которые диагностика срабатывает, а также можно привести пример, как можно исправить ситуацию -->
 
@@ -48,6 +57,25 @@
                  + СуммаАвтоматическойСкидки;
 ```
 
+Пример возможного расположения параметров и закрывающей скобки с разделителем операторов ";"
+
+```bsl
+ИменаДокументов = Новый СписокЗначений;
+ИменаДокументов.Добавить(Метаданные.Документы.СтрокаВыпискиРасход.Имя, 
+                         Метаданные.Документы.СтрокаВыпискиРасход.Синоним);
+```
+
+Пример возможного расположения закрывающей скобки с разделителем операторов ";" на отдельной строке:
+- без изменения параметра `listOfIncorrectFirstSymbol`, описанного выше, правило будет выдавать замечание на такой перенос выражений.
+
+```bsl
+ИменаДокументов = Новый СписокЗначений;
+ИменаДокументов.Добавить(
+    Метаданные.Документы.СтрокаВыпискиРасход.Имя, 
+    Метаданные.Документы.СтрокаВыпискиРасход.Синоним
+);
+```
+
 ## Источники
 <!-- Необходимо указывать ссылки на все источники, из которых почерпнута информация для создания диагностики -->
 

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

@@ -49,7 +49,7 @@ public class IncorrectLineBreakDiagnostic extends AbstractDiagnostic {
   // check first symbol
   private static final boolean DEFAULT_CHECK_START = true;
   // forbidden characters at the beginning of the line
-  private static final String DEFAULT_LIST_FOR_CHECK_START = "\\)|;|,|\\);";
+  private static final String DEFAULT_LIST_FOR_CHECK_START = "\\)|;|,\\s*\\S+|\\);";
   // check last symbol
   private static final boolean DEFAULT_CHECK_END = true;
   // forbidden end-of-line characters

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

@@ -37,8 +37,6 @@ class IncorrectLineBreakDiagnosticTest extends AbstractDiagnosticTest<IncorrectL
   @Test
   void test() {
 
-    Map<String, Object> configuration = diagnosticInstance.getInfo().getDefaultConfiguration();
-    diagnosticInstance.configure(configuration);
     List<Diagnostic> diagnostics = getDiagnostics();
 
     assertThat(diagnostics, true)
@@ -49,10 +47,10 @@ void test() {
       .hasRange(20, 49, 50)
       .hasRange(69, 80, 83)
       .hasRange(82, 89, 92)
-      .hasRange(44, 25, 26)
-      .hasRange(46, 25, 26)
-      .hasRange(58, 4, 5)
-      .hasRange(60, 4, 5)
+      .hasRange(44, 25, 76)
+      .hasRange(46, 25, 79)
+      .hasRange(58, 4, 55)
+      .hasRange(60, 4, 58)
       .hasRange(101, 2, 3)
       .hasRange(105, 2, 3)
       .hasRange(109, 2, 3)
@@ -88,7 +86,7 @@ void testTrailingBraceCodestyle() {
 
     List<Diagnostic> diagnostics = getDiagnostics();
 
-    assertThat(diagnostics).hasSize(11);
+    assertThat(diagnostics).hasSize(12);
     assertThat(diagnostics, true)
       .hasRange(6, 32, 33)
       .hasRange(7, 35, 36)
@@ -101,6 +99,7 @@ void testTrailingBraceCodestyle() {
       .hasRange(46, 25, 26)
       .hasRange(58, 4, 5)
       .hasRange(60, 4, 5)
+      .hasRange(134, 4, 5)
     ;
 
   }

src/test/resources/diagnostics/IncorrectLineBreakDiagnostic.bsl

@@ -128,3 +128,9 @@
 
 // Pass
 // Структура -
+
+ЗафиксироватьОшибку(
+    ИмяСобытияЖР(),
+    УровеньЖурналаРегистрации.Ошибка,
+    , // не ошибка
+    ТекстОшибки);