Skip to content

Commit 8c3ab32

Browse files
committed
Документация нового свойства и схема
1 parent f9646eb commit 8c3ab32

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

docs/features/ConfigurationFile.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,12 @@ BSL Language Server предоставляет возможность измен
1616
|      `cyclomaticComplexity`|`Булево` или `JSON-Объект`|Включает отображение значения [цикломатической сложности](../diagnostics/CyclomaticComplexity.md) метода. По умолчанию настройка установлена в `true`. Доступные параметры линзы: `complexityThreshold` - порог, после которого линза начинает срабатывать. Значение параметра по умолчанию - `-1`.|
1717
|`diagnostics`|`JSON-Объект`|Содержит настройки диагностик|
1818
|&nbsp;&nbsp;&nbsp;`computeTrigger`|`Строка`|С помощью этого параметра можно указать событие, при котором будет вызвана процедура анализа кода для диагностирования замечаний. Возможные значения:<br/>* `onType` - при редактировании файла (онлайн) ***на больших файлах может ЗНАЧИТЕЛЬНО замедлять редактирование***<br/>* `onSave` - при сохранении файла (*используется по умолчанию*)<br/>* `never` - анализ выполняться не будет|
19-
|&nbsp;&nbsp;&nbsp;`ordinaryAppSupport`|`Булево>`|Поддержка обычного клиента. Диагностики будут требовать учитывать особенности обычного приложения. Возможные значения:<br/>* `true` - конфигурация разрабатывается с поддержкой обычного клиента *(установлен по умолчанию)* <br/>* `false` - игнорировать предупреждения связанные с особенностями обычного клиента|
19+
|&nbsp;&nbsp;&nbsp;`ordinaryAppSupport`|`Булево`|Поддержка обычного клиента. Диагностики будут требовать учитывать особенности обычного приложения. Возможные значения:<br/>* `true` - конфигурация разрабатывается с поддержкой обычного клиента *(установлен по умолчанию)* <br/>* `false` - игнорировать предупреждения связанные с особенностями обычного клиента|
2020
|&nbsp;&nbsp;&nbsp;`skipSupport`|`Строка`|Этим параметром настраивается режим пропуска файлов *(т.е. файлы не анализируются на предмет наличия замечаний)* **конфигурации 1С**, находящихся "на поддержке" конфигурации поставщика. Возможные значения:<br/>* `withSupport` - пропускаются все модули, находящиеся "на поддержке" *(все виды "замков")*<br/>* `withSupportLocked` - пропускаются только модули, находящиеся "на поддержке" с запретом изменений *("желтый закрытый замок")*<br/>* `never` - режим поддержки не анализируется и модули не пропускаются *(установлен по умолчанию)*|
2121
|&nbsp;&nbsp;&nbsp;`mode`|`Строка`|Настройка для управления режимом учета настроек диагностик. Возможные варианты:<br/>* `OFF` - Все диагностики считаются выключенными, вне зависимости от их настроек <br/>* `ON` - Все диагностики включенные по умолчанию считаются включенными, остальные - в зависимости от личных настроек <br/>* `EXCEPT` - Все диагностистики, кроме указанных, считаются включенными <br/>* `ONLY` - Только указанные диагностики считаются включенными <br/>* `ALL` - Все диагностики считаются включенными|
2222
|⤷&nbsp;&nbsp;&nbsp;`parameters`|`JSON-Объект`|Параметр представляет собой коллекцию настроек диагностик. Элементами коллекции являются json-объекты следующей структуры:<br/>* *ключ объекта* - строка, являющаяся ключом диагностики<br/>* *значение объекта* - может принимать либо булево значение, и тогда интерпретируется как отключение диагностики (`false`) или ее включение с параметрами по умолчанию (`true`), либо значение типа `json-объект`, представляющего собой набор настроек диагностики.<br/><br/>Ключ, включена ли по умолчанию, а также описание возможных параметров и примеры для конфигурационного файла представлены на странице с описанием каждой диагностики.|
2323
|&nbsp;&nbsp;&nbsp;`subsystemsFilter`|`JSON-Объект`|Фильтр по подсистемам конфигурации|
24+
|&nbsp;&nbsp;&nbsp;`analyzeOnStart`|`Булево`|Запустить анализ всего проекта при запуске сервера. Если включено, после построения контекста на клиента будет отправлена информация о диагностиках во всех файлах проекта.|
2425
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`include`|`Массив` `Строка`|Список имен подсистем по объектам которых выполняется анализ, включая подчиненные подсистемы|
2526
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`exclude`|`Массив` `Строка`|Список имен подсистем исключенных из анализа, включая подчиненные подсистемы|
2627
|`documentLink`|`JSON-Объект`|Содержит настройки ссылок на документацию|

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -670,6 +670,22 @@
670670
}
671671
}
672672
}
673+
},
674+
"analyzeOnStart": {
675+
"$id": "#/properties/analyzeOnStart",
676+
"type": "boolean",
677+
"title": "Analyze project and push computed diagnostics to client on server start.",
678+
"default": false,
679+
"oneOf": [
680+
{
681+
"const": true,
682+
"description": "Analyze project on start."
683+
},
684+
{
685+
"const": false,
686+
"description": "Don't analyze project on start. (default)."
687+
}
688+
]
673689
}
674690
}
675691
},

0 commit comments

Comments
 (0)