Merge pull request #1635 from huxuxuya/feature/IncorrectLineBreak

Author: nixel2007

.idea/libraries-with-intellij-classes.xml

@@ -0,0 +1,56 @@
+# Неправильный перенос выражения (IncorrectLineBreak)
+
+ Тип | Поддерживаются<br>языки | Важность | Включена<br>по умолчанию | Время на<br>исправление (мин) | Тэги 
+ :-: | :-: | :-: | :-: | :-: | :-: 
+ `Дефект кода` | `BSL`<br>`OS` | `Информационный` | `Да` | `2` | `standard`<br>`badpractice` 
+
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Описание диагностики
+<!-- Описание диагностики заполняется вручную. Необходимо понятным языком описать смысл и схему работу -->
+
+Длинные арифметические выражения переносятся следующим образом:
+в одной строке может находиться более одного операнда;
+при переносе знаки операции пишутся в начале строки (а не в конце предыдущей строки);
+операнды на новой строке предваряются стандартным отступом, либо выравниваются по началу первого операнда без учета знаков операций.
+
+При необходимости параметры процедур, функций и методов следует переносить следующим образом:
+
+* параметры выравниваются по началу первого параметра, либо предваряются стандартным отступом;
+* закрывающая скобка и разделитель операторов ";" пишутся в той же строке, что и последний параметр;
+* также допустим и способ форматирования, который предлагает функция автоформатирования в конфигураторе
+
+Сложные логические условия в Если…ИначеЕсли…КонецЕсли следует переносить следующим образом:
+
+* каждое элементарное условие нужно начинать с новой строки, если длина строки превышает ограничение в 120 символов;
+* логические операторы И, ИЛИ ставятся в начале строки, а не в конце предыдущей строки;
+* все условия предваряются стандартным отступом, либо выравниваются по началу первого условия, без учета логического оператора (для выравнивания выражений относительно первой строки рекомендуется использовать пробелы).
+
+## Примеры
+<!-- В данном разделе приводятся примеры, на которые диагностика срабатывает, а также можно привести пример, как можно исправить ситуацию -->
+
+```bsl
+СуммаДокумента = СуммаБезСкидки +
+                 СуммаРучнойСкидки +
+                 СуммаАвтоматическойСкидки;
+```
+
+## Источники
+<!-- Необходимо указывать ссылки на все источники, из которых почерпнута информация для создания диагностики -->
+
+* Источник: [Стандарт: Перенос выражений](https://its.1c.ru/db/v8std#content:444:hdoc)
+
+## Сниппеты
+
+<!-- Блоки ниже заполняются автоматически, не трогать -->
+### Экранирование кода
+
+```bsl
+// BSLLS:IncorrectLineBreak-off
+// BSLLS:IncorrectLineBreak-on
+```
+
+### Параметр конфигурационного файла
+
+```json
+"IncorrectLineBreak": false
+```

.idea/misc.xml

@@ -8,12 +8,12 @@
 
 ## Список реализованных диагностик
 
-Общее количество: **140**
+Общее количество: **141**
 
 * Потенциальная уязвимость: **4**
 * Уязвимость: **3**
 * Ошибка: **44**
-* Дефект кода: **89**
+* Дефект кода: **90**
 
 
 | Ключ | Название | Включена по умолчанию | Важность | Тип | Тэги |
@@ -76,6 +76,7 @@
  [IfElseDuplicatedCodeBlock](IfElseDuplicatedCodeBlock.md) | Повторяющиеся блоки кода в синтаксической конструкции Если...Тогда...ИначеЕсли... | Да | Незначительный | Дефект кода | `suspicious` 
  [IfElseDuplicatedCondition](IfElseDuplicatedCondition.md) | Повторяющиеся условия в синтаксической конструкции Если...Тогда...ИначеЕсли... | Да | Важный | Дефект кода | `suspicious` 
  [IfElseIfEndsWithElse](IfElseIfEndsWithElse.md) | Использование синтаксической конструкции Если...Тогда...ИначеЕсли... | Да | Важный | Дефект кода | `badpractice` 
+ [IncorrectLineBreak](IncorrectLineBreak.md) | Неправильный перенос выражения | Да | Информационный | Дефект кода | `standard`<br>`badpractice` 
  [IncorrectUseLikeInQuery](IncorrectUseLikeInQuery.md) | Некорректное использование 'ПОДОБНО' | Да | Критичный | Ошибка | `standard`<br>`sql`<br>`unpredictable` 
  [IncorrectUseOfStrTemplate](IncorrectUseOfStrTemplate.md) | Неверное использование "СтрШаблон" | Да | Блокирующий | Ошибка | `brainoverload`<br>`suspicious`<br>`unpredictable` 
  [InvalidCharacterInFile](InvalidCharacterInFile.md) | Недопустимый символ | Да | Важный | Ошибка | `error`<br>`standard`<br>`unpredictable` 

docs/diagnostics/IncorrectLineBreak.md

@@ -0,0 +1,55 @@
+# Incorrect expression line break (IncorrectLineBreak)
+
+ Type | Scope | Severity | Activated<br>by default | Minutes<br>to fix | Tags 
+ :-: | :-: | :-: | :-: | :-: | :-: 
+ `Code smell` | `BSL`<br>`OS` | `Info` | `Yes` | `2` | `standard`<br>`badpractice` 
+
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Description
+
+Long arithmetic expressions are carried as follows:
+one entry can contain more than one operand;
+when wrapping, operation characters are written at the beginning of the line (and not at the end of the previous line);
+operands on a new line are preceded by standard indentation, or they are aligned to the beginning of the first operand, regardless of the operation signs.
+
+If necessary, parameters of procedures, functions and methods should be transferred as follows:
+
+* parameters are either aligned to the beginning of the first parameter, or preceded by standard indentation;
+* closing parenthesis and operator separator ";" are written on the same line as the last parameter;
+* the formatting method that offers the auto-formatting function in the configurator is also acceptable
+
+Complex logical conditions in If ... ElseIf ... EndIf should be carried as follows:
+
+* The basis for the newline if the line length is limited to 120 characters;
+* logical operators AND, OR are placed at the beginning of a line, and not at the end of the previous line;
+* all conditions are preceded by the standard first indent, or they are aligned at the start of work without taking into account the logical operator (it is recommended to use spaces to align expressions relative to the first line).
+
+## Examples
+<!-- В данном разделе приводятся примеры, на которые диагностика срабатывает, а также можно привести пример, как можно исправить ситуацию -->
+
+```bsl
+AmountDocument = AmountWithoutDiscount +
+                 AmountManualDiscounts +
+                 AmountAutomaticDiscount;
+```
+
+## Sources
+<!-- Необходимо указывать ссылки на все источники, из которых почерпнута информация для создания диагностики -->
+
+* Источник: [Стандарт: Перенос выражений (RU)](https://its.1c.ru/db/v8std#content:444:hdoc)
+
+## Snippets
+
+<!-- Блоки ниже заполняются автоматически, не трогать -->
+### Diagnostic ignorance in code
+
+```bsl
+// BSLLS:IncorrectLineBreak-off
+// BSLLS:IncorrectLineBreak-on
+```
+
+### Parameter for config
+
+```json
+"IncorrectLineBreak": false
+```

docs/diagnostics/index.md

@@ -8,12 +8,12 @@ To escape individual sections of code or files from triggering diagnostics, you
 
 ## Implemented diagnostics
 
-Total: **140**
+Total: **141**
 
 * Security Hotspot: **4**
 * Vulnerability: **3**
 * Error: **44**
-* Code smell: **89**
+* Code smell: **90**
 
 
 | Key | Name| Enabled by default | Severity | Type | Tags |
@@ -76,6 +76,7 @@ Total: **140**
  [IfElseDuplicatedCodeBlock](IfElseDuplicatedCodeBlock.md) | Duplicated code blocks in If...Then...ElseIf... statements | Yes | Minor | Code smell | `suspicious` 
  [IfElseDuplicatedCondition](IfElseDuplicatedCondition.md) | Duplicated conditions in If...Then...ElseIf... statements | Yes | Major | Code smell | `suspicious` 
  [IfElseIfEndsWithElse](IfElseIfEndsWithElse.md) | Else...The...ElseIf... statement should end with Else branch | Yes | Major | Code smell | `badpractice` 
+ [IncorrectLineBreak](IncorrectLineBreak.md) | Incorrect expression line break | Yes | Info | Code smell | `standard`<br>`badpractice` 
  [IncorrectUseLikeInQuery](IncorrectUseLikeInQuery.md) | Incorrect use of 'LIKE' | Yes | Critical | Error | `standard`<br>`sql`<br>`unpredictable` 
  [IncorrectUseOfStrTemplate](IncorrectUseOfStrTemplate.md) | Incorrect use of "StrTemplate" | Yes | Blocker | Error | `brainoverload`<br>`suspicious`<br>`unpredictable` 
  [InvalidCharacterInFile](InvalidCharacterInFile.md) | Invalid character | Yes | Major | Error | `error`<br>`standard`<br>`unpredictable` 

docs/en/diagnostics/IncorrectLineBreak.md

@@ -0,0 +1,84 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright © 2018-2021
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Gryzlov <nixel2007@gmail.com> and contributors
+ *
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ *
+ * BSL Language Server is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3.0 of the License, or (at your option) any later version.
+ *
+ * BSL Language Server is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with BSL Language Server.
+ */
+package com.github._1c_syntax.bsl.languageserver.diagnostics;
+
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticSeverity;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticTag;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticType;
+import com.github._1c_syntax.utils.CaseInsensitivePattern;
+
+import java.util.HashSet;
+import java.util.Set;
+import java.util.regex.Pattern;
+
+@DiagnosticMetadata(
+  type = DiagnosticType.CODE_SMELL,
+  severity = DiagnosticSeverity.INFO,
+  minutesToFix = 2,
+  tags = {
+    DiagnosticTag.STANDARD,
+    DiagnosticTag.BADPRACTICE
+  }
+)
+public class IncorrectLineBreakDiagnostic extends AbstractDiagnostic {
+
+  private static final Pattern INCORRECT_START_LINE_PATTERN = CaseInsensitivePattern.compile(
+    "^\\s*(:?\\)|;|,|\\);)"
+  );
+
+  private static final Pattern INCORRECT_END_LINE_PATTERN = CaseInsensitivePattern.compile(
+    "\\s+(:?ИЛИ|И|OR|AND|\\+|-|/|%|\\*)\\s*(?://.*)?$"
+  );
+
+  // +1 for next line and +1 for 1..n based line numbers.
+  private static final int QUERY_START_LINE_OFFSET = 2;
+
+  private final Set<Integer> queryFirstLines = new HashSet<>();
+
+  @Override
+  protected void check() {
+    findQueryFirstLines();
+
+    checkContent(INCORRECT_START_LINE_PATTERN);
+    checkContent(INCORRECT_END_LINE_PATTERN);
+  }
+
+  private void findQueryFirstLines() {
+    documentContext.getQueries().forEach(query -> queryFirstLines.add(query.getAst().getStart().getLine()));
+  }
+
+  private void checkContent(Pattern pattern) {
+    String[] contentList = documentContext.getContentList();
+    String checkText;
+
+    for (var i = 0; i < contentList.length; i++) {
+      checkText = contentList[i];
+
+      var matcher = pattern.matcher(checkText);
+
+      if (matcher.find() && !queryFirstLines.contains(i + QUERY_START_LINE_OFFSET)) {
+        diagnosticStorage.addDiagnostic(i + 1, matcher.start(1), i + 1, matcher.end(1));
+      }
+    }
+  }
+}

docs/en/diagnostics/index.md

@@ -682,6 +682,16 @@
             "title": "Else...The...ElseIf... statement should end with Else branch",
             "$id": "#/definitions/IfElseIfEndsWithElse"
         },
+        "IncorrectLineBreak": {
+            "description": "Incorrect expression line break",
+            "default": true,
+            "type": [
+                "boolean",
+                "object"
+            ],
+            "title": "Incorrect expression line break",
+            "$id": "#/definitions/IncorrectLineBreak"
+        },
         "IncorrectUseLikeInQuery": {
             "description": "Incorrect use of 'LIKE'",
             "default": true,

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

@@ -197,6 +197,9 @@
                 "IfElseIfEndsWithElse": {
                     "$ref": "parameters-schema.json#/definitions/IfElseIfEndsWithElse"
                 },
+                "IncorrectLineBreak": {
+                    "$ref": "parameters-schema.json#/definitions/IncorrectLineBreak"
+                },
                 "IncorrectUseLikeInQuery": {
                     "$ref": "parameters-schema.json#/definitions/IncorrectUseLikeInQuery"
                 },

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

@@ -0,0 +1,2 @@
+diagnosticMessage=Check for line break of operands, operators and parameters
+diagnosticName=Incorrect expression line break