Merge pull request #2747 from 1c-syntax/feature/subsystemFilter

Author: nixel2007

docs/features/ConfigurationFile.md

@@ -20,6 +20,9 @@ BSL Language Server предоставляет возможность измен
 |⤷&nbsp;&nbsp;&nbsp;`skipSupport`|`Строка`|Этим параметром настраивается режим пропуска файлов *(т.е. файлы не анализируются на предмет наличия замечаний)* **конфигурации 1С**, находящихся "на поддержке" конфигурации поставщика. Возможные значения:<br/>* `withSupport` - пропускаются все модули, находящиеся "на поддержке" *(все виды "замков")*<br/>* `withSupportLocked` - пропускаются только модули, находящиеся "на поддержке" с запретом изменений *("желтый закрытый замок")*<br/>* `never` - режим поддержки не анализируется и модули не пропускаются *(установлен по умолчанию)*|
 |⤷&nbsp;&nbsp;&nbsp;`mode`|`Строка`|Настройка для управления режимом учета настроек диагностик. Возможные варианты:<br/>* `OFF` - Все диагностики считаются выключенными, вне зависимости от их настроек <br/>* `ON` - Все диагностики включенные по умолчанию считаются включенными, остальные - в зависимости от личных настроек <br/>* `EXCEPT` - Все диагностистики, кроме указанных, считаются включенными <br/>* `ONLY` - Только указанные диагностики считаются включенными <br/>* `ALL` - Все диагностики считаются включенными|
 |⤷&nbsp;&nbsp;&nbsp;`parameters`|`JSON-Объект`|Параметр представляет собой коллекцию настроек диагностик. Элементами коллекции являются json-объекты следующей структуры:<br/>* *ключ объекта* - строка, являющаяся ключом диагностики<br/>* *значение объекта* - может принимать либо булево значение, и тогда интерпретируется как отключение диагностики (`false`) или ее включение с параметрами по умолчанию (`true`), либо значение типа `json-объект`, представляющего собой набор настроек диагностики.<br/><br/>Ключ, включена ли по умолчанию, а также описание возможных параметров и примеры для конфигурационного файла представлены на странице с описанием каждой диагностики.|
+|⤷&nbsp;&nbsp;&nbsp;`subsystemsFilter`|`JSON-Объект`|Фильтр по подсистемам конфигурации|
+|&nbsp;&nbsp;&nbsp;⤷&nbsp;&nbsp;&nbsp;`include`|`Массив` `Строка`|Список имен подсистем по объектам которых выполняется анализ, включая подчиненные подсистемы|
+|&nbsp;&nbsp;&nbsp;⤷&nbsp;&nbsp;&nbsp;`exclude`|`Массив` `Строка`|Список имен подсистем исключенных из анализа, включая подчиненные подсистемы|
 |`documentLink`|`JSON-Объект`|Содержит настройки ссылок на документацию|
 |⤷&nbsp;&nbsp;&nbsp;`showDiagnosticDescription`|`Булево`|Показывать дополнительные ссылки на документацию по диагностикам. По умолчанию параметр выключен (*установлен в `false`*)|
 |`useDevSite`|`Булево`|При включении настройки формирующиеся ссылки на документацию будут вести на develop-версию сайта. По умолчанию параметр выключен (*установлен в `false`*)|
@@ -41,6 +44,7 @@ https://1c-syntax.github.io/bsl-language-server/configuration/schema.json
 * Изменяет настройку диагностики [LineLength - Ограничение на длину строки](../diagnostics/LineLength.md), устанавливая предел длины строки в 140 символов;
 * Отключает диагностику [MethodSize - Ограничение на размер метода](../diagnostics/MethodSize.md).
 * Включает расчет диагностик в непрерывном режиме (`computeTrigger = onType`)
+* Диагностики рассчитываются только по объектам подсистемы "СтандартныеПодсистемы" за исключением "ВариантыОтчетов" и "ВерсионированиеОбъектов"
 
 ```json
 {
@@ -53,6 +57,10 @@ https://1c-syntax.github.io/bsl-language-server/configuration/schema.json
         "maxLineLength": 140
       },
       "MethodSize": false
+    },
+    "subsystemsFilter": {
+      "include": ["СтандартныеПодсистемы"],
+      "exclude": ["ВариантыОтчетов", "ВерсионированиеОбъектов"]
     }
   }
 }

src/main/java/com/github/_1c_syntax/bsl/languageserver/configuration/diagnostics/DiagnosticsOptions.java

@@ -45,6 +45,7 @@ public class DiagnosticsOptions {
   private SkipSupport skipSupport = SkipSupport.NEVER;
   private Mode mode = Mode.ON;
   private boolean ordinaryAppSupport = true;
+  private SubsystemFilter subsystemsFilter = new SubsystemFilter();
 
   @JsonDeserialize(using = ParametersDeserializer.class)
   private Map<String, Either<Boolean, Map<String, Object>>> parameters = new HashMap<>();

src/main/java/com/github/_1c_syntax/bsl/languageserver/configuration/diagnostics/SubsystemFilter.java

@@ -0,0 +1,38 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright (c) 2018-2022
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Fedkin <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.configuration.diagnostics;
+
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.Set;
+import java.util.TreeSet;
+
+/**
+ * Фильтр диагностик по подсистемам
+ */
+@Data
+@NoArgsConstructor
+public class SubsystemFilter {
+  private Set<String> include = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
+  private Set<String> exclude = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
+}

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/infrastructure/DiagnosticsConfiguration.java

@@ -32,6 +32,8 @@
 import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticInfo;
 import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticScope;
 import com.github._1c_syntax.mdclasses.common.CompatibilityMode;
+import com.github._1c_syntax.mdclasses.mdo.AbstractMDO;
+import com.github._1c_syntax.mdclasses.mdo.MDSubsystem;
 import com.github._1c_syntax.mdclasses.mdo.support.ModuleType;
 import com.github._1c_syntax.mdclasses.supportconf.SupportConfiguration;
 import com.github._1c_syntax.mdclasses.supportconf.SupportVariant;
@@ -48,6 +50,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 @Configuration
 @RequiredArgsConstructor
@@ -92,6 +95,35 @@ private static boolean needToComputeDiagnostics(
     DocumentContext documentContext,
     DiagnosticsOptions diagnosticsOptions
   ) {
+    return checkSupport(documentContext, diagnosticsOptions)
+      && filterSubsystems(documentContext, diagnosticsOptions);
+  }
+
+  private static boolean filterSubsystems(DocumentContext documentContext, DiagnosticsOptions diagnosticsOptions) {
+    var mdoObject = documentContext.getMdObject();
+    var subsystemsFilter = diagnosticsOptions.getSubsystemsFilter();
+
+    if (mdoObject.isEmpty()
+      || (subsystemsFilter.getInclude().isEmpty() && subsystemsFilter.getExclude().isEmpty())) {
+      return true;
+    }
+
+    var subsystemsNames = subsystemFlatList(mdoObject.get().getIncludedSubsystems()).stream()
+      .map(AbstractMDO::getName)
+      .collect(Collectors.toList());
+
+    var include = subsystemsFilter.getInclude().isEmpty()
+      || subsystemsNames.stream()
+      .anyMatch(mdoSystemName -> subsystemsFilter.getInclude().contains(mdoSystemName));
+
+    var exclude = !subsystemsFilter.getExclude().isEmpty()
+      && subsystemsNames.stream()
+      .anyMatch(mdoSystemName -> subsystemsFilter.getExclude().contains(mdoSystemName));
+
+    return include && !exclude;
+  }
+
+  private static boolean checkSupport(DocumentContext documentContext, DiagnosticsOptions diagnosticsOptions) {
     var configuredMode = diagnosticsOptions.getMode();
 
     if (configuredMode == Mode.OFF) {
@@ -199,4 +231,11 @@ private static boolean passedCompatibilityMode(
     return CompatibilityMode.compareTo(compatibilityMode.getCompatibilityMode(), contextCompatibilityMode) >= 0;
   }
 
+  // перенести в mdClasses
+  private static List<MDSubsystem> subsystemFlatList(Collection<MDSubsystem> subsystems) {
+    return subsystems.stream()
+      .flatMap(subsys -> Stream.concat(Stream.of(subsys), subsystemFlatList(subsys.getIncludedSubsystems()).stream()))
+      .collect(Collectors.toList());
+  }
+
 }

src/main/java/com/github/_1c_syntax/bsl/languageserver/utils/MdoRefBuilder.java

@@ -25,6 +25,7 @@
 import com.github._1c_syntax.bsl.parser.BSLParser;
 import com.github._1c_syntax.mdclasses.mdo.AbstractMDObjectBase;
 import com.github._1c_syntax.mdclasses.mdo.MDCommonModule;
+import com.github._1c_syntax.mdclasses.mdo.MDSubsystem;
 import com.github._1c_syntax.mdclasses.mdo.support.MDOReference;
 import com.github._1c_syntax.mdclasses.mdo.support.MDOType;
 import com.github._1c_syntax.mdclasses.mdo.support.ModuleType;
@@ -35,10 +36,13 @@
 import org.antlr.v4.runtime.tree.TerminalNode;
 
 import javax.annotation.Nullable;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.atomic.AtomicReference;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 @UtilityClass
 public class MdoRefBuilder {

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

@@ -649,6 +649,27 @@
                             "description": "Ignore ordinary application warnings."
                         }
                     ]
+                },
+                "subsystemsFilter": {
+                    "$id": "#/properties/subsystemsFilter",
+                    "type": "object",
+                    "title": "Subsystems filter configuration.",
+                    "properties": {
+                        "include": {
+                            "$id": "#/properties/include",
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            }
+                        },
+                        "exclude": {
+                            "$id": "#/properties/exclude",
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            }
+                        }
+                    }
                 }
             }
         },

src/test/java/com/github/_1c_syntax/bsl/languageserver/configuration/LanguageServerConfigurationTest.java

@@ -50,7 +50,7 @@ class LanguageServerConfigurationTest {
 
   private static final String PATH_TO_CONFIGURATION_FILE = "./src/test/resources/.bsl-language-server.json";
   private static final String PATH_TO_EMPTY_CONFIGURATION_FILE = "./src/test/resources/.empty-bsl-language-server.json";
-  private static final String PATH_TO_METADATA = "src/test/resources/metadata";
+  private static final String PATH_TO_METADATA = "src/test/resources/metadata/designer";
   private static final String PATH_TO_PARTIAL_CONFIGURATION_FILE
     = "./src/test/resources/.partial-bsl-language-server.json";
 

src/test/java/com/github/_1c_syntax/bsl/languageserver/context/ServerContextTest.java

@@ -44,7 +44,7 @@
 @CleanupContextBeforeClassAndAfterEachTestMethod
 class ServerContextTest {
 
-  private static final String PATH_TO_METADATA = "src/test/resources/metadata";
+  private static final String PATH_TO_METADATA = "src/test/resources/metadata/designer";
   private static final String PATH_TO_MODULE_FILE = "CommonModules/ПервыйОбщийМодуль/Ext/Module.bsl";
   private static final String PATH_TO_CATALOG_FILE = "Catalogs/Справочник1/Ext/ManagerModule.bsl";
   private static final String PATH_TO_CATALOG_MODULE_FILE = "Catalogs/Справочник1/Ext/ObjectModule.bsl";

src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputerTest.java

@@ -46,7 +46,7 @@
 @SpringBootTest
 class MethodSymbolComputerTest {
 
-  private static final String PATH_TO_METADATA = "src/test/resources/metadata";
+  private static final String PATH_TO_METADATA = "src/test/resources/metadata/designer";
   private static final String PATH_TO_MODULE_FILE = "CommonModules/ПервыйОбщийМодуль/Ext/Module.bsl";
   private static final String PATH_TO_CATALOG_FILE = "Catalogs/Справочник1/Ext/ManagerModule.bsl";
   private static final String PATH_TO_CATALOG_MODULE_FILE = "Catalogs/Справочник1/Ext/ObjectModule.bsl";

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

@@ -51,8 +51,8 @@ class CachedPublicDiagnosticTest extends AbstractDiagnosticTest<CachedPublicDiag
   private MDCommonModule module;
   private DocumentContext documentContext;
 
-  private static final String PATH_TO_METADATA = "src/test/resources/metadata";
-  private static final String PATH_TO_MODULE_FILE = "src/test/resources/metadata/CommonModules/ПервыйОбщийМодуль/Ext/Module.bsl";
+  private static final String PATH_TO_METADATA = "src/test/resources/metadata/designer";
+  private static final String PATH_TO_MODULE_FILE = "src/test/resources/metadata/designer/CommonModules/ПервыйОбщийМодуль/Ext/Module.bsl";
   private static final String PATH_TO_MODULE_CONTENT = "src/test/resources/diagnostics/CachedPublicDiagnostic.bsl";
   private static final String PATH_TO_MODULE_EMPTY_CONTENT = "src/test/resources/diagnostics/CachedPublicDiagnosticEmpty.bsl";