Merge pull request #1845 from 1c-syntax/feature/NestedFunctionInParametersDiagnostic

NestedFunctionInParametersDiagnostic mod

Author: nixel2007

docs/diagnostics/NestedFunctionInParameters.md

@@ -4,6 +4,12 @@
 |:-------------:|:-----------------------------:|:----------------:|:------------------------------:|:-----------------------------------:|:----------------------------------------------------------:|
 | `Дефект кода` | `BSL`<br>`OS` | `Незначительный` | `Да` | `2` | `standard`<br>`brainoverload`<br>`badpractice` |
 
+## Параметры
+
+
+| Имя | Тип | Описание | Значение<br>по умолчанию |
+|:---------------:|:--------:|:----------------------------------:|:------------------------------:|
+| `allowOneliner` | `Булево` | `Разрешить однострочные выражения` | `true` |
 <!-- Блоки выше заполняются автоматически, не трогать -->
 ## Описание диагностики
 <!-- Описание диагностики заполняется вручную. Необходимо понятным языком описать смысл и схему работу -->
@@ -52,5 +58,7 @@
 ### Параметр конфигурационного файла
 
 ```json
-"NestedFunctionInParameters": false
+"NestedFunctionInParameters": {
+ "allowOneliner": true
+}
 ```

docs/en/diagnostics/NestedFunctionInParameters.md

@@ -4,6 +4,12 @@
 |:------------:|:-------------------:|:--------:|:-----------------------------:|:-----------------------:|:----------------------------------------------------------:|
 | `Code smell` | `BSL`<br>`OS` | `Minor` | `Yes` | `2` | `standard`<br>`brainoverload`<br>`badpractice` |
 
+## Parameters
+
+
+| Name | Type | Description | Default value |
+|:---------------:|:---------:|:---------------------------:|:-------------:|
+| `allowOneliner` | `Boolean` | `Allow oneliner expression` | `true` |
 <!-- Блоки выше заполняются автоматически, не трогать -->
 ## Description
 <!-- Описание диагностики заполняется вручную. Необходимо понятным языком описать смысл и схему работу -->
@@ -47,5 +53,7 @@ FileImageHRef = AttachedFiles.GetFileData(AttachedFile.Ref).RefToFileBinaryData;
 ### Parameter for config
 
 ```json
-"NestedFunctionInParameters": false
+"NestedFunctionInParameters": {
+ "allowOneliner": true
+}
 ```

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

@@ -22,6 +22,7 @@
 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.DiagnosticParameter;
 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;
@@ -42,6 +43,14 @@
 )
 public class NestedFunctionInParametersDiagnostic extends AbstractVisitorDiagnostic {
 
+ private static final boolean DEFAULT_ALLOW_ONELINER = true;
+
+ @DiagnosticParameter(
+ type = Boolean.class,
+ defaultValue = "" + DEFAULT_ALLOW_ONELINER
+ )
+ private boolean allowOneliner = DEFAULT_ALLOW_ONELINER;
+
  @Override
  public ParseTree visitMethodCall(BSLParser.MethodCallContext ctx) {
  checkMethodCall(ctx, ctx.doCall(), ctx.methodName());
@@ -57,34 +66,41 @@ public ParseTree visitGlobalMethodCall(BSLParser.GlobalMethodCallContext ctx) {
  @Override
  public ParseTree visitNewExpression(BSLParser.NewExpressionContext ctx) {
 
- if (findNestedCall(ctx, ctx.doCall())) {
- if (ctx.typeName() != null) {
- diagnosticStorage.addDiagnostic(
- ctx.typeName(),
- info.getMessage(
- info.getResourceString("diagnosticMessageConstructor"),
- ctx.typeName().getText()));
- } else { // для констукторов через параметр New
- diagnosticStorage.addDiagnostic(
- ctx.getStart(),
- info.getResourceString("diagnosticMessageWithoutName",
- info.getResourceString("diagnosticMessageConstructor")));
- }
+ if (!findNestedCall(ctx, ctx.doCall())) {
+ return super.visitNewExpression(ctx);
+ }
+
+ if (ctx.typeName() != null) {
+ diagnosticStorage.addDiagnostic(
+ ctx.typeName(),
+ info.getMessage(
+ info.getResourceString("diagnosticMessageConstructor"),
+ ctx.typeName().getText()));
+ } else { // для конструкторов через параметр New
+ diagnosticStorage.addDiagnostic(
+ ctx.getStart(),
+ info.getResourceString("diagnosticMessageWithoutName",
+ info.getResourceString("diagnosticMessageConstructor")));
  }
 
  return super.visitNewExpression(ctx);
  }
 
- private static boolean findNestedCall(BSLParserRuleContext ctx, BSLParser.DoCallContext ctxDoCall) {
+ private boolean findNestedCall(BSLParserRuleContext ctx, BSLParser.DoCallContext ctxDoCall) {
  if (ctxDoCall == null
- || ctxDoCall.callParamList() == null) {
+ || ctxDoCall.callParamList() == null
+ || ctxDoCall.callParamList().isEmpty()) {
  return false;
  }
 
- // если есть параметры и вызов не в одной строке, то найдем вызовы методов
- return !ctxDoCall.callParamList().isEmpty()
- && ctx.getStart().getLine() != ctx.getStop().getLine()
- && Trees.nodeContains(ctx, ctxDoCall, BSLParser.RULE_doCall);
+ return ctx.getStart().getLine() != ctx.getStop().getLine()
+ && Trees.nodeContains(ctx, ctxDoCall, BSLParser.RULE_doCall)
+ && multilineParam(ctxDoCall);
+ }
+
+ private boolean multilineParam(BSLParser.DoCallContext ctxDoCall) {
+ return !allowOneliner || ctxDoCall.callParamList().callParam().stream()
+ .anyMatch(callParamContext -> callParamContext.getStop().getLine() > callParamContext.getStart().getLine());
  }
 
  private void checkMethodCall(BSLParserRuleContext ctx,

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

@@ -1148,6 +1148,14 @@
  "object"
  ],
  "title": "Initialization of method and constructor parameters by calling nested methods",
+ "properties": {
+ "allowOneliner": {
+ "description": "Allow oneliner expression",
+ "default": true,
+ "type": "boolean",
+ "title": "Allow oneliner expression"
+ }
+ },
  "$id": "#/definitions/NestedFunctionInParameters"
  },
  "NestedStatements": {

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

@@ -3,3 +3,4 @@ diagnosticMessageWithoutName=Remove parameter initialization for %s by nested me
 diagnosticName=Initialization of method and constructor parameters by calling nested methods
 diagnosticMessageMethod=method
 diagnosticMessageConstructor=constructor
+allowOneliner=Allow oneliner expression

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

@@ -3,3 +3,4 @@ diagnosticMessageWithoutName=Уберите инициализацию пара
 diagnosticName=Инициализация параметров методов и конструкторов вызовом вложенных методов
 diagnosticMessageMethod=метода
 diagnosticMessageConstructor=конструктора
+allowOneliner=Разрешить однострочные выражения

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

@@ -25,6 +25,7 @@
 import org.junit.jupiter.api.Test;
 
 import java.util.List;
+import java.util.Map;
 
 import static com.github._1c_syntax.bsl.languageserver.util.Assertions.assertThat;
 
@@ -38,7 +39,24 @@ void test() {
 
  List<Diagnostic> diagnostics = getDiagnostics();
 
- assertThat(diagnostics).hasSize(7);
+ assertThat(diagnostics).hasSize(3);
+ assertThat(diagnostics, true)
+ .hasRange(1, 22, 30)
+ .hasRange(3, 11, 19)
+ .hasRange(51, 72, 94)
+ ;
+ }
+
+ @Test
+ void testConfigure() {
+
+ Map<String, Object> configuration = diagnosticInstance.getInfo().getDefaultConfiguration();
+ configuration.put("allowOneliner", false);
+ diagnosticInstance.configure(configuration);
+
+ List<Diagnostic> diagnostics = getDiagnostics();
+
+ assertThat(diagnostics).hasSize(10);
  assertThat(diagnostics, true)
  .hasRange(1, 22, 30)
  .hasRange(3, 11, 19)
@@ -47,6 +65,9 @@ void test() {
  .hasRange(13, 35, 42)
  .hasRange(17, 22, 31)
  .hasRange(36, 14, 19)
+ .hasRange(47, 72, 94)
+ .hasRange(51, 72, 94)
+ .hasRange(56, 4, 28)
  ;
 
  }

src/test/resources/diagnostics/NestedFunctionInParametersDiagnostic.bsl

@@ -1,4 +1,4 @@
-Процедура Тест()
+Процедура Тест() // Все комментарии про allowOneliner=false
  СтруктураВложений.Вставить( // <-- Ошибка, т.к. есть вложенный конструктов и метод
  ПрисоединенныйФайл.Наименование,
  Новый Картинка(ПолучитьИзВременногоХранилища( // <-- 2 ошибки, т.к. есть вложенный метод м в конструкторе и в методе
@@ -8,8 +8,8 @@
 
  Сообщить(СуммаСтрокой("77"), // <-- ошибка для Сообщить, т.к есть вложенный метод в параметрах
  СуммаСтрокой(СуммаНДС(Перечисление.ВтораяСумма))); // <-- не ошибка для СуммаСтрокой, т.к. в одной строке
-
-
+ А = Новый Массив;
+ Сообщить();
  Объект.Метод().Метод2(Объект2.Метод2()); // <-- не ошибка, все в одной строке
  Объект.Метод(Объект2.Метод2()).Метод21( // <-- ошибка для Метод21, т.к. есть вложенный метод
  Объект2.Метод22());
@@ -44,3 +44,20 @@
 ОткрытьФорму("РегистрСведений.ОчередьРассылок.ФормаЗаписи", ПараметрыФормыЗаписи);
 
 КонецПроцедуры
+
+ СсылкаНаОбъект = РегистрыСведений.СоответствиеСсылокИдентификаторам.ПолучитьСсылкуНаОбъект(
+ Новый УникальныйИдентификатор(ИдентификаторОбъекта)
+);
+
+ СсылкаНаОбъект = РегистрыСведений.СоответствиеСсылокИдентификаторам.ПолучитьСсылкуНаОбъект(
+ Новый УникальныйИдентификатор(ИдентификаторОбъекта,
+ Истина)
+ );
+
+ ЗаписьЖурналаРегистрации(
+ НСтр("ru = 'WMS.InDeliverySetEndReceiving'", ОбщегоНазначения.КодОсновногоЯзыка()),
+ УровеньЖурналаРегистрации.Ошибка,
+ ,
+ ,
+ ПодробноеПредставлениеОшибки(ИнформацияОбОшибке())
+ );