Skip to content

Commit c300654

Browse files
Translate docs/features/ConfigurationFile.md in en
100% translated for the source file 'docs/features/ConfigurationFile.md' on the 'en' language.
1 parent a13ded5 commit c300654

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

docs/en/features/ConfigurationFile.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,21 @@ If there is no configuration file, an attempt will be made to find the ".bsl-lan
1616
|      `cyclomaticComplexity`|`Boolean` or `JSON-Object`|Enables displaying the value of the [cyclomatic complexity](../diagnostics/CyclomaticComplexity.md) of the method over its definition. The default is `true`. Lens options: `complexityThreshold` - lens response threshold. The default is - `-1`.|
1717
|`diagnostics`|`JSON-Object`|Contains diagnostic settings|
1818
|&nbsp;&nbsp;&nbsp;`computeTrigger`|`String`|Event that will trigger the code analysis procedure to diagnose comments. Possible values:<br/>* `onType` -when editing a file (online) ***on large files can significantly slow down editing ***<br/>* `onSave` - when saving a file (*default*)<br/> `never` - analysis will not be performed|
19-
|&nbsp;&nbsp;&nbsp;`ordinaryAppSupport`|`Boolean>`|Ordinary client support. Diagnostics will require taking into account the features of a ordinary application. Values:<br/>* `true` - the configuration uses ordinary application *(default)* <br/>* `false` - ignore ordinary application warnings|
19+
|&nbsp;&nbsp;&nbsp;`ordinaryAppSupport`|`Boolean`|Ordinary client support. Diagnostics will require taking into account the features of a ordinary application. Values:<br/>* `true` - the configuration uses ordinary application *(default)* <br/>* `false` - ignore ordinary application warnings|
2020
|&nbsp;&nbsp;&nbsp;`skipSupport`|`String`|This parameter sets **1C configuration** file skipping mode *(for example files are not analyzed for issues)* which are "on support" from vendor configuration. Possible values:<br/>* `withSupport` - skip all modules set "on support" *(all "locks" types)*<br/>* `withSupportLocked` - skip modules set "on support" with prohibited modification *("yellow closed lock")*<br/>* `never` - skip no modules as support mode is not analyzed *(set by default)*|
2121
|&nbsp;&nbsp;&nbsp;`mode`|`String`|Setting for controlling the diagnostic settings accounting mode. Possible options: <br/>* `OFF` - All diagnostics are considered to be turned off, regardless of their settings. <br/>* `ON` - All diagnostics enabled by default are considered enabled, the rest - depending on personal settings <br/>* `EXCEPT` - All diagnostics other than those specified are considered enabled. <br/>* `ONLY` - Only the specified diagnostics are considered enabled. <br/>* `ALL` - All diagnostics are considered enabled|
2222
|&nbsp;&nbsp;&nbsp;`parameters`|`JSON-Object`|Parameter is a collection of diagnostics parameters. Collection items are json-objects with the following structure:<br/>* *object key* - string, is diagnostic key<br/>* *object value* - if is boolean, then interpreted as diagnostic off-switch (`false`) or on-switch with default parameters (`true`), if is type `json-object`, collection of diagnostic parameters.<br/><br/>Key, if set to ON by default and all allowed parameters and examples are given on the diagnostic page.|
23+
|&nbsp;&nbsp;&nbsp;`subsystemsFilter`|`JSON-Object`|Filter by configuration subsystems|
24+
|&nbsp;&nbsp;&nbsp;`analyzeOnStart`|`Boolean`|Starting the analysis of the entire project at server startup. If enabled, after the context is built on the client, information about diagnostics in all project files will be sent.|
25+
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`include`|`Array` `String`|List of names of subsystems for which objects the analysis is performed, including child subsystems|
26+
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`exclude`|`Array` `String`|List of names of subsystems excluded from analysis, including child subsystems|
2327
|`documentLink`|`JSON-Object`|Contains documentation link settings|
2428
|&nbsp;&nbsp;&nbsp;`showDiagnosticDescription`|`Boolean`|Show additional links to diagnostics documentation. By default, the parameter is off (*set to `false`*)|
2529
|`useDevSite`|`Boolean`|When you turn on the settings, the resulting documentation links will lead to the develop version of the site. By default, the parameter is off (*set to `false`*)|
2630
|`siteRoot`|`String`|The path to the root of the site with the documentation. By default, the parameter value is `"https://1c-syntax.github.io/bsl-language-server"` |
2731
|`traceLog`|`String`|To log all requests *(incoming and outgoing)* between **BSL Language Server** and **Language Client** from used editor/IDE, this parameter sets log file path. The path can set either absolute or relative *(from project root)*, by default the value is not set.<br/><br/>**WARNING**<br/><br/>* When starting **BSL Language Server** overwrites this file <br/>* Speed of interaction between client and server **DRAMATICALLY REDUCED**|
2832
|`configurationRoot`|`String`|This parameter is intended to indicate the root directory the 1C configuration files are located in the project directory. It can be useful if there are several configuration directories in the same project directory or when the structure of the project directory is so complex. By default, the parameter is empty and `BSL Language Server` determines the location of the configuration root directory independently|
33+
|`sendErrors`|`String`|Mode for sending error messages to BSL Language Server developers. More [Monitoring](Monitoring.md).Possible values:<br/>* `ask` - ask permission on every error *(set by default)*. <br/>* `send` - always send error messages.<br/>* `never` - never send error messages.|
2934

3035
You can use the following JSON schema to make it easier to compile and edit a configuration file:
3136

@@ -41,6 +46,7 @@ Setting example:
4146
* Changes the diagnostic setting for [LineLength - Line Length limit](../diagnostics/LineLength.md), set the limit for the length of a string to 140 characters;
4247
* Disable [MethodSize - Method size restriction diagnostic](../diagnostics/MethodSize.md).
4348
* Enables the calculation of diagnostics in continuous mode (`computeTrigger = onType`)
49+
* Diagnostics are calculated only for the objects of the "StandardSubsystems" subsystem, with the exception of "ReportVariants" and "VersioningObjects"
4450

4551
```json
4652
{
@@ -53,6 +59,10 @@ Setting example:
5359
"maxLineLength": 140
5460
},
5561
"MethodSize": false
62+
},
63+
"subsystemsFilter": {
64+
"include": ["StandardSubsystems"],
65+
"exclude": ["ReportVariants", "VersioningObjects"]
5666
}
5767
}
5868
}

0 commit comments

Comments
 (0)