* `ru` - for Russian (*default*)
* `en` - for English| -|`codeLens`|`JSON-Object`|Contains the settings for displaying `lens` in advanced code editors/IDEs *(for example, [Visual Studio Code](https://code.visualstudio.com/))*, which displays various information above a block of code. Object properties| -|⤷ `parameters`|`JSON-Object`|Collection of lens settings. Collection items are json-objects with the following structure:
* *object key* - string, is lens key
* *object value* - if is boolean, then interpreted as lens off-switch (`false`) or on-switch with default parameters (`true`), if is type `json-object`, collection of lens parameters.| -| ⤷ `cognitiveComplexity`|`Boolean` or `JSON-Object`|Enables displaying the value of the [cognitive complexity](../diagnostics/CognitiveComplexity.md) of the method over its definition. The default is ` true `. Lens options: `complexityThreshold` - lens response threshold. The default is - `-1`.| -| ⤷ `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`.| -|`diagnostics`|`JSON-Object`|Contains diagnostic settings| -|⤷ `computeTrigger`|`String`|Event that will trigger the code analysis procedure to diagnose comments. Possible values:
* `onType` -when editing a file (online) ***on large files can significantly slow down editing ***
* `onSave` - when saving a file (*default*)
`never` - analysis will not be performed| -|⤷ `ordinaryAppSupport`|`Boolean>`|Ordinary client support. Diagnostics will require taking into account the features of a ordinary application. Values:
* `true` - the configuration uses ordinary application *(default)*
* `false` - ignore ordinary application warnings| -|⤷ `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:
* `withSupport` - skip all modules set "on support" *(all "locks" types)*
* `withSupportLocked` - skip modules set "on support" with prohibited modification *("yellow closed lock")*
* `never` - skip no modules as support mode is not analyzed *(set by default)*| -|⤷ `mode`|`String`|Setting for controlling the diagnostic settings accounting mode. Possible options:
* `OFF` - All diagnostics are considered to be turned off, regardless of their settings.
* `ON` - All diagnostics enabled by default are considered enabled, the rest - depending on personal settings
* `EXCEPT` - All diagnostics other than those specified are considered enabled.
* `ONLY` - Only the specified diagnostics are considered enabled.
* `ALL` - All diagnostics are considered enabled| -|⤷ `parameters`|`JSON-Object`|Parameter is a collection of diagnostics parameters. Collection items are json-objects with the following structure:
* *object key* - string, is diagnostic key
* *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.
Key, if set to ON by default and all allowed parameters and examples are given on the diagnostic page.| -|`documentLink`|`JSON-Object`|Contains documentation link settings| -|⤷ `showDiagnosticDescription`|`Boolean`|Show additional links to diagnostics documentation. By default, the parameter is off (*set to `false`*)| -|`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`*)| -|`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"` | -|`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.
**WARNING**
* When starting **BSL Language Server** overwrites this file
* Speed of interaction between client and server **DRAMATICALLY REDUCED**| -|`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| +| Name | Type | Description | +|:---------------------------------------------------------------|:--------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `language` | `String` | Set the language for displaying diagnosed comments. Supported languages:
* `ru` - for Russian (*default*)
* `en` - for English | +| `codeLens` | `JSON-Object` | Contains settings for displaying `lenses` in advanced code/IDEs *(eg [Visual Studio Code](https://code.visualstudio.com/))*, which displays various information above the code block. | +| ⤷ `parameters` | `JSON-Object` | Collection of lens settings. Collection items are json-objects with the following structure:
* *object key* - string, is lens key
* *object value* - if is boolean, then interpreted as lens off-switch (`false`) or on-switch with default parameters (`true`), if is type `json-object`, collection of lens parameters. | +| ⤷ `cognitiveComplexity` | `Boolean` or `JSON-Object` | Enables displaying the value of the [cognitive complexity](../diagnostics/CognitiveComplexity.md) of the method over its definition. The default is ` true `. Lens options: `complexityThreshold` - lens response threshold. The default is - `-1`. | +| ⤷ `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`. | +| `diagnostics` | `JSON-Object` | Contains diagnostic settings | +| ⤷ `computeTrigger` | `String` | Event that will trigger the code analysis procedure to diagnose comments. Possible values:
* `onType` -when editing a file (online) ***on large files can significantly slow down editing ***
* `onSave` - when saving a file (*default*)
`never` - analysis will not be performed | +| ⤷ `ordinaryAppSupport` | `Boolean` | Ordinary client support. Diagnostics will require taking into account the features of a ordinary application. Values:
* `true` - the configuration uses ordinary application *(default)*
* `false` - ignore ordinary application warnings | +| ⤷ `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:
* `withSupport` - skip all modules set "on support" *(all "locks" types)*
* `withSupportLocked` - skip modules set "on support" with prohibited modification *("yellow closed lock")*
* `never` - skip no modules as support mode is not analyzed *(set by default)* | +| ⤷ `mode` | `String` | Setting for controlling the diagnostic settings accounting mode. Possible options:
* `OFF` - All diagnostics are considered to be turned off, regardless of their settings.
* `ON` - All diagnostics enabled by default are considered enabled, the rest - depending on personal settings
* `EXCEPT` - All diagnostics other than those specified are considered enabled.
* `ONLY` - Only the specified diagnostics are considered enabled.
* `ALL` - All diagnostics are considered enabled | +| ⤷ `parameters` | `JSON-Object` | Parameter is a collection of diagnostics parameters. Collection items are json-objects with the following structure:
* *object key* - string, is diagnostic key
* *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.
Key, if set to ON by default and all allowed parameters and examples are given on the diagnostic page. | +| ⤷ `subsystemsFilter` | `JSON-Object` | Filter by configuration subsystems | +| ⤷ `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. | +| ⤷ `include` | `Array` `String` | List of names of subsystems for which objects the analysis is performed, including child subsystems | +| ⤷ `exclude` | `Array` `String` | List of names of subsystems excluded from analysis, including child subsystems | +| `documentLink` | `JSON-Object` | Contains documentation link settings | +| ⤷ `showDiagnosticDescription` | `Boolean` | Show additional links to diagnostics documentation. By default, the parameter is off (*set to `false`*) | +| `inlayHint` | `JSON-Object` | ontains settings for displaying `inlay hints` in advanced code editors/IDEs *(for example [Visual Studio Code](https://code.visualstudio.com/))*, which displays various information directly in the code line. | +| ⤷ `parameters` | `JSON-Object` | A collection of inlay hints settings. The elements of the collection are json objects of the following structure:*
*object key* - a string that is an identifier of inlay hint*
*object value* - can take either a boolean value, and then it is interpreted as disabling inlay hint (`false`) or enabling them with parameters by default (`true`), or a value of type `json-object`, which is a set of inlay hint settings. | +| ⤷ `cognitiveComplexity` | `Boolean` or `JSON-Object` | Enables displaying the value of the [Cognitive Complexity](../diagnostics/CognitiveComplexity.md) method as inlay hints. By default, the setting is set to `true`. | +| ⤷ `cyclomaticComplexity` | `Boolean` or `JSON-Object` | Enables displaying the value of the [Cyclomatic Complexity](../diagnostics/CyclomaticComplexity.md) method as inlay hints. By default, the setting is set to `true`. | +| ⤷ `sourceDefinedMethodCall` | `Boolean` or `JSON-Object` | Enables displaying the parameters of the invoked configuration/library method as inlay hints. By default, the setting is set to `true`. Available parameters:
* `showParametersWithTheSameName` - show parameters with names contained in the passed value. The default parameter value is `false`.
* `showDefaultValues` - show default values for parameters not passed. The default value of the parameter is `true`. | +| `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`*) | +| `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"` | +| `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.
**WARNING**
* When starting **BSL Language Server** overwrites this file
* Speed of interaction between client and server **DRAMATICALLY REDUCED** | +| `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 | +| `sendErrors` | `String` | Mode for sending error messages to BSL Language Server developers. More [Monitoring](Monitoring.md).Possible values:
* `ask` - ask permission on every error *(set by default)*.
* `send` - always send error messages.
* `never` - never send error messages. | You can use the following JSON schema to make it easier to compile and edit a configuration file: @@ -38,9 +48,12 @@ https://1c-syntax.github.io/bsl-language-server/configuration/schema.json Setting example: * Language of diagnostics messages - English; -* Changes the diagnostic setting for [LineLength - Line Length limit](../diagnostics/LineLength.md), set the limit for the length of a string to 140 characters; +* Changes the diagnostic setting [LineLength - Line length limit](../diagnostics/LineLength.md) by setting + line length limit of 140 characters; * Disable [MethodSize - Method size restriction diagnostic](../diagnostics/MethodSize.md). * Enables the calculation of diagnostics in continuous mode (`computeTrigger = onType`) +* Diagnostics are calculated only for the objects of the "StandardSubsystems" subsystem, with the exception of "ReportVariants" and " + ObjectVersioning" ```json { @@ -53,6 +66,15 @@ Setting example: "maxLineLength": 140 }, "MethodSize": false + }, + "subsystemsFilter": { + "include": [ + "StandardSubsystems" + ], + "exclude": [ + "ReportVariants", + "ObjectVersioning" + ] } } } diff --git a/docs/en/features/Monitoring.md b/docs/en/features/Monitoring.md new file mode 100644 index 00000000000..2bae2d04372 --- /dev/null +++ b/docs/en/features/Monitoring.md @@ -0,0 +1,280 @@ +# Monitoring and reporting errors + +BSL Language Server contains a mechanism for sending error data to Sentry. + +The public Sentry.io is used as the Sentry server at https://sentry.io/organizations/1c-syntax/projects/bsl-language-server + +Unfortunately, the peculiarities of configuring access to Sentry.io limit the ability to view data +unauthorized users. + +## Scheme + +In the [configuration file](ConfigurationFile.md) of the BSL Language Server, you can configure the mode for sending error messages. +The send mode can take one of three values: + +* ask (default); +* send always; +* never send. + +If the configuration file is missing a setting or has a value of "ask", when an error occurs +the connected language client (used by the IDE) is sent a question about further actions with an error +with the following answer options: + +* send this error but ask again; +* don't send this error but ask again. +* send this error and don't ask again; +* don't send this error and don't ask again; + +You can completely refuse to answer (for example, by clicking on the cross next to the notification with the question). +Lack of response is perceived as "don't send this error, but ask again". + +The error message does not contain user or workstation identification information, +except for the generated session UUID to bind errors that occur within one +launching BSL Language Server. + +> Attention! + +If you enable debug logging (by setting `logback` or using environment variables), the contents of the logs (the last 100 entries) will be attached to the event that is sent. + +Some messages sent between Language Client and BSL Language Server contain source code snippets +or the entire text of the file. +These fragments can also be attached to the sent message. + +Sending message example: + +??? event.json + + ```json + { + "event_id": "746e2e82f4c1499abcdd935bc4c26644", + "project": 5790531, + "release": "ae081de9d3c3496ddac1d176259365191966b0cd", + "dist": null, + "platform": "java", + "message": "Internal error: java.lang.RuntimeException: psss", + "datetime": "2022-07-14T11:07:57.875000Z", + "tags": [ + [ + "environment", + "production" + ], + [ + "level", + "error" + ], + [ + "logger", + "org.eclipse.lsp4j.jsonrpc.RemoteEndpoint" + ], + [ + "runtime", + "AdoptOpenJDK 15.0.2" + ], + [ + "runtime.name", + "AdoptOpenJDK" + ], + [ + "release", + "ae081de9d3c3496ddac1d176259365191966b0cd" + ], + [ + "user", + "id:49516eb9-2a0d-4a15-bd96-978b68d8d0df" + ], + [ + "server.version", + "feature-sentry-ae081de-DIRTY" + ] + ], + "_metrics": { + "bytes.ingested.event": 3289, + "bytes.stored.event": 9875 + }, + "contexts": { + "runtime": { + "name": "AdoptOpenJDK", + "version": "15.0.2", + "type": "runtime" + } + }, + "culprit": "java.util.concurrent.CompletableFuture in encodeThrowable", + "environment": "production", + "exception": { + "values": [ + { + "type": "RuntimeException", + "value": "psss", + "module": "java.lang", + "stacktrace": { + "frames": [ + { + "function": "run", + "module": "java.util.concurrent.ForkJoinWorkerThread", + "in_app": false + }, + { + "function": "runWorker", + "module": "java.util.concurrent.ForkJoinPool", + "in_app": false + }, + { + "function": "scan", + "module": "java.util.concurrent.ForkJoinPool", + "in_app": false + }, + { + "function": "topLevelExec", + "module": "java.util.concurrent.ForkJoinPool$WorkQueue", + "in_app": false + }, + { + "function": "doExec", + "module": "java.util.concurrent.ForkJoinTask", + "in_app": false + }, + { + "function": "exec", + "module": "java.util.concurrent.CompletableFuture$AsyncSupply", + "in_app": false + }, + { + "function": "run", + "module": "java.util.concurrent.CompletableFuture$AsyncSupply", + "in_app": false + }, + { + "function": "lambda$prepareCallHierarchy$8", + "module": "com.github._1c_syntax.bsl.languageserver.BSLTextDocumentService", + "filename": "BSLTextDocumentService.java", + "abs_path": "BSLTextDocumentService.java", + "lineno": 234, + "in_app": true + }, + { + "function": "prepareCallHierarchy", + "module": "com.github._1c_syntax.bsl.languageserver.providers.CallHierarchyProvider", + "filename": "CallHierarchyProvider.java", + "abs_path": "CallHierarchyProvider.java", + "lineno": 62, + "in_app": true + } + ] + }, + "thread_id": 24 + }, + { + "type": "CompletionException", + "value": "java.lang.RuntimeException: psss", + "module": "java.util.concurrent", + "stacktrace": { + "frames": [ + { + "function": "run", + "module": "java.util.concurrent.ForkJoinWorkerThread", + "in_app": false + }, + { + "function": "runWorker", + "module": "java.util.concurrent.ForkJoinPool", + "in_app": false + }, + { + "function": "scan", + "module": "java.util.concurrent.ForkJoinPool", + "in_app": false + }, + { + "function": "topLevelExec", + "module": "java.util.concurrent.ForkJoinPool$WorkQueue", + "in_app": false + }, + { + "function": "doExec", + "module": "java.util.concurrent.ForkJoinTask", + "in_app": false + }, + { + "function": "exec", + "module": "java.util.concurrent.CompletableFuture$AsyncSupply", + "in_app": false + }, + { + "function": "run", + "module": "java.util.concurrent.CompletableFuture$AsyncSupply", + "in_app": false + }, + { + "function": "completeThrowable", + "module": "java.util.concurrent.CompletableFuture", + "in_app": false + }, + { + "function": "encodeThrowable", + "module": "java.util.concurrent.CompletableFuture", + "in_app": false + } + ] + }, + "thread_id": 24 + } + ] + }, + "extra": { + "thread_name": "ForkJoinPool.commonPool-worker-19" + }, + "fingerprint": [ + "{{ default }}" + ], + "grouping_config": { + "enhancements": "eJybzDRxY3J-bm5-npWRgaGlroGxrpHxBABcYgcZ", + "id": "newstyle:2019-10-29" + }, + "hashes": [ + "4a63b2a190b48dc2bbafb225c5140009", + "cfeccf65e86c6129d81e7fd1df568ce3" + ], + "ingest_path": [ + { + "version": "22.6.0", + "public_key": "XE7QiyuNlja9PZ7I9qJlwQotzecWrUIN91BAO7Q5R38" + } + ], + "key_id": "1646438", + "level": "error", + "logentry": { + "formatted": "Internal error: java.lang.RuntimeException: psss" + }, + "logger": "org.eclipse.lsp4j.jsonrpc.RemoteEndpoint", + "metadata": { + "display_title_with_tree_label": false, + "function": "encodeThrowable", + "type": "CompletionException", + "value": "java.lang.RuntimeException: psss" + }, + "nodestore_insert": 1657796884.036383, + "received": 1657796882.652077, + "sdk": { + "name": "sentry.java.spring-boot", + "version": "6.2.1", + "packages": [ + { + "name": "maven:io.sentry:sentry", + "version": "6.2.1" + }, + { + "name": "maven:io.sentry:sentry-spring-boot-starter", + "version": "6.2.1" + } + ] + }, + "timestamp": 1657796877.875, + "title": "CompletionException: java.lang.RuntimeException: psss", + "type": "error", + "user": { + "id": "49516eb9-2a0d-4a15-bd96-978b68d8d0df" + }, + "version": "7", + "location": null + } + ``` \ No newline at end of file diff --git a/docs/en/features/index.md b/docs/en/features/index.md index 5a4591b3ae1..8111df669e6 100644 --- a/docs/en/features/index.md +++ b/docs/en/features/index.md @@ -4,3 +4,4 @@ Additional features BSL Language Server * [Configuration](ConfigurationFile.md) * [Diagnostic ignorance](DiagnosticIgnorance.md) +* [Monitoring](Monitoring.md) diff --git a/docs/en/index.md b/docs/en/index.md index bddae9cae38..2607e338947 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -2,13 +2,12 @@ [](https://github.com/1c-syntax/bsl-language-server/actions) [](https://github.com/1c-syntax/bsl-language-server/releases/latest) -[](https://jitpack.io/#1c-syntax/bsl-language-server) +[](https://github.com/1c-syntax/bsl-language-server/releases) [](https://github.com/1c-syntax/bsl-language-server/releases) [](https://github.com/1c-syntax/bsl-language-server/releases) [](https://sonarcloud.io/dashboard?id=1c-syntax_bsl-language-server) [](https://sonarcloud.io/dashboard?id=1c-syntax_bsl-language-server) [](https://sonarcloud.io/dashboard?id=1c-syntax_bsl-language-server) -[](https://1c-syntax.github.io/bsl-language-server/qodana) [](https://www.transifex.com/1c-syntax/bsl-language-server) [](bench/index.html) [](https://t.me/bsl_language_server) @@ -18,6 +17,7 @@ * [Contributing guidelines](contributing/index.md) * Capabilities * Run from command line +* Run in websocket mode * Run in analyzer mode * Run in formatter mode * Configuration file @@ -32,7 +32,7 @@ Perfomance measurement - [SSL 3.1](../bench/index.html) -## Capabilities +## Features * File formatting * Selected region formatting @@ -46,23 +46,23 @@ Perfomance measurement - [SSL 3.1](../bench/index.html) * Expand selection * Display color representation and convert between `Color` and `WebColors` * Diagnostics -* Quick fixes for several diagnostics +* Quick fixes and code actions for several diagnostics * Run diagnostics engine from command line * Run formatter engine from command line -* Rename symbol +* Renaming Symbols ## Supported protocol operations ??? workspace -| Operation | Supported | Comment | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [didChangeWorkspaceFolders](https://microsoft.github.io/language-server-protocol/specification-current#workspace_didChangeWorkspaceFolders) |
| |
-| [didChangeConfiguration](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeConfiguration) | 
| with restrictions, see [#1431](https://github.com/1c-syntax/bsl-language-server/issues/1431) |
-| [didChangeWatchedFiles](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeWatchedFiles) | | |
-| [symbol](https://microsoft.github.io/language-server-protocol/specification#workspace_symbol) | | |
-| [executeCommand](https://microsoft.github.io/language-server-protocol/specification#workspace_executeCommand) | | |
-| [applyEdit](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_applyEdit) | | |
-| [willCreateFiles](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_willCreateFiles) | | |
+ | Operation | Support | Commentary |
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+ | [didChangeWorkspaceFolders](https://microsoft.github.io/language-server-protocol/specification-current#workspace_didChangeWorkspaceFolders) | | |
+ | [didChangeConfiguration](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeConfiguration) | | with restrictions see [#1431](https://github.com/1c-syntax/bsl-language-server/issues/1431) |
+ | [didChangeWatchedFiles](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeWatchedFiles) | | |
+ | [symbol](https://microsoft.github.io/language-server-protocol/specification#workspace_symbol) | | |
+ | [executeCommand](https://microsoft.github.io/language-server-protocol/specification#workspace_executeCommand) | | |
+ | [applyEdit](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_applyEdit) | | |
+ | [willCreateFiles](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_willCreateFiles) | | |
??? "Text Synchronization"
| Opertaion | Supported | Comment |
@@ -75,42 +75,45 @@ Perfomance measurement - [SSL 3.1](../bench/index.html)
| [willSaveWaitUntil](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_willSaveWaitUntil) | | | |
??? textDocument
-| Operation | Supported | Comment | Configurable? |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ---------------- |
-| [publishDiagnostics](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_publishDiagnostics) | | tagSupport = trueversionSupport = true
[список диагностик](./diagnostics/index.md) | yes | -| [completion](https://github.com/1c-syntax/bsl-language-server/blob/develop/docs/diagnostics/index.md) |
| resolveProvider = false | |
-| [completionItem/resolve](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#completionItem_resolve) | | | |
-| [hover](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover) | | contentFormat = MarkupContent | |
-| [signatureHelp](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_signatureHelp) | | | |
-| [declaration](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_declaration) | | not applicable in 1C:Enterprise | |
-| [definition](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_definition) | | linkSupport = true | |
-| [typeDefinition](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_typeDefinition) | | | |
-| [implementation](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_implementation) | | not applicable in 1C:Enterprise | |
-| [references](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_references) | | | |
-| [documentHighlight](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentHighlight) | | | |
-| [documentSymbol](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentSymbol) | | hierarchicalDocumentSymbolSupport = true | |
-| [codeAction](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_codeAction) | | codeActionKinds = ? (see [#1433](https://github.com/1c-syntax/bsl-language-server/issues/1433))isPreferredSupport = true | yes | -| [codeAction/resolve](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#codeAction_resolve) |
| | |
-| [codeLens](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_codeLens) | | resolveProvider = false | да |
-| [codeLens/resolve](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#codeLens_resolve) | | | |
-| [codeLens/refresh](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#codeLens_refresh) | | | |
-| [documentLink](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentLink) | | Displaying hyperlinks to diagnostics documentation.tooltipSupport = true
resolveProvider = false | yes | -| [documentLink/resolve](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#documentLink_resolve) |
| | |
-| [documentColor](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentColor) | | | |
-| [colorPresentation](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_colorPresentation) | | | |
-| [formatting](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_formatting) | | | |
-| [rangeFormatting](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_rangeFormatting) | | | |
-| [onTypeFormatting](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_onTypeFormatting) | | | |
-| [rename](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_rename) | | | |
-| [prepareRename](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_prepareRename) | | | |
-| [foldingRange](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_foldingRange) | | | |
-| [selectionRange](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_selectionRange) | | | |
-| [prepareCallHierarchy](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_prepareCallHierarchy) | | | |
-| [callHierarchy/incomingCalls](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#callHierarchy_incomingCalls) | | | |
-| [callHierarchy/outgoingCalls](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#callHierarchy_outgoingCalls) | | | |
-| [semanticTokens](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_semanticTokens) | | | |
-| [linkedEditingRange](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_linkedEditingRange) | | | |
-| [moniker](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_moniker) | | | |
+ | Operation | Support | Commentary | Is configured? |
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ---------------- |
+ | [publishDiagnostics](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_publishDiagnostics) | | tagSupport = trueversionSupport = true
[diagnostics](./diagnostics/index.md) | yes | + | [completion](https://github.com/1c-syntax/bsl-language-server/blob/develop/docs/diagnostics/index.md) |
| resolveProvider = false | |
+ | [completionItem/resolve](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#completionItem_resolve) | | | |
+ | [hover](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover) | | contentFormat = MarkupContent | |
+ | [signatureHelp](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_signatureHelp) | | | |
+ | [declaration](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_declaration) | | not applicable in 1C:Enterprise | |
+ | [definition](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_definition) | | linkSupport = true | |
+ | [typeDefinition](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_typeDefinition) | | | |
+ | [implementation](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_implementation) | | not applicable in 1C:Enterprise | |
+ | [references](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_references) | | | |
+ | [documentHighlight](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentHighlight) | | | |
+ | [documentSymbol](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentSymbol) | | hierarchicalDocumentSymbolSupport = true | |
+ | [codeAction](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_codeAction) | | codeActionKinds = ? (см. [#1433](https://github.com/1c-syntax/bsl-language-server/issues/1433))isPreferredSupport = true | yes | + | [codeAction/resolve](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#codeAction_resolve) |
| | |
+ | [codeLens](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_codeLens) | | resolveProvider = false | yes |
+ | [codeLens/resolve](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#codeLens_resolve) | | | |
+ | [codeLens/refresh](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#codeLens_refresh) | | | |
+ | [documentLink](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentLink) | | Showing hyperlinks to documentation on diagnostics.tooltipSupport = true
resolveProvider = false | yes | + | [documentLink/resolve](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#documentLink_resolve) |
| | |
+ | [documentColor](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentColor) | | | |
+ | [colorPresentation](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_colorPresentation) | | | |
+ | [formatting](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_formatting) | | | |
+ | [rangeFormatting](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_rangeFormatting) | | | |
+ | [onTypeFormatting](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_onTypeFormatting) | | | |
+ | [rename](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_rename) | | | |
+ | [prepareRename](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_prepareRename) | | | |
+ | [foldingRange](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_foldingRange) | | | |
+ | [selectionRange](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_selectionRange) | | | |
+ | [prepareCallHierarchy](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_prepareCallHierarchy) | | | |
+ | [callHierarchy/incomingCalls](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#callHierarchy_incomingCalls) | | | |
+ | [callHierarchy/outgoingCalls](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#callHierarchy_outgoingCalls) | | | |
+ | [semanticTokens](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_semanticTokens) | | | |
+ | [linkedEditingRange](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_linkedEditingRange) | | | |
+ | [moniker](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_moniker) | | | |
+ | [inlayHint](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_inlayHint) | | resolveProvider = false | yes |
+ | [inlayHint/resolve](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#inlayHint_resolve) | | | |
+ | [inlayHint/refresh](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_inlayHint_refresh) | | | |
@@ -127,16 +130,60 @@ Usage: bsl-language-server [-h] [-c=* `ru` - для русского языка (*используется по умолчанию*)
* `en` - для английского языка| -|`codeLens`|`JSON-Объект`|Содержит настройки отображения `линз` в продвинутых кода/IDE *(например [Visual Studio Code](https://code.visualstudio.com/))*, в которых выводится различная информация над блоком кода. Свойства объекта| -|⤷ `parameters`|`JSON-Объект`|Коллекция настроек линз. Элементами коллекции являются json-объекты следующей структуры:
* *ключ объекта* - строка, являющаяся идентификатором линзы
* *значение объекта* - может принимать либо булево значение, и тогда интерпретируется как отключение линзы (`false`) или ее включение с параметрами по умолчанию (`true`), либо значение типа `json-объект`, представляющего собой набор настроек линзы.| -| ⤷ `cognitiveComplexity`|`Булево` или `JSON-Объект`|Включает отображение значения [когнитивной сложности](../diagnostics/CognitiveComplexity.md) метода над его определением. По умолчанию настройка установлена в `true`. Доступные параметры линзы: `complexityThreshold` - порог, после которого линза начинает срабатывать. Значение параметра по умолчанию - `-1`.| -| ⤷ `cyclomaticComplexity`|`Булево` или `JSON-Объект`|Включает отображение значения [цикломатической сложности](../diagnostics/CyclomaticComplexity.md) метода. По умолчанию настройка установлена в `true`. Доступные параметры линзы: `complexityThreshold` - порог, после которого линза начинает срабатывать. Значение параметра по умолчанию - `-1`.| -|`diagnostics`|`JSON-Объект`|Содержит настройки диагностик| -|⤷ `computeTrigger`|`Строка`|С помощью этого параметра можно указать событие, при котором будет вызвана процедура анализа кода для диагностирования замечаний. Возможные значения:
* `onType` - при редактировании файла (онлайн) ***на больших файлах может ЗНАЧИТЕЛЬНО замедлять редактирование***
* `onSave` - при сохранении файла (*используется по умолчанию*)
* `never` - анализ выполняться не будет| -|⤷ `ordinaryAppSupport`|`Булево`|Поддержка обычного клиента. Диагностики будут требовать учитывать особенности обычного приложения. Возможные значения:
* `true` - конфигурация разрабатывается с поддержкой обычного клиента *(установлен по умолчанию)*
* `false` - игнорировать предупреждения связанные с особенностями обычного клиента| -|⤷ `skipSupport`|`Строка`|Этим параметром настраивается режим пропуска файлов *(т.е. файлы не анализируются на предмет наличия замечаний)* **конфигурации 1С**, находящихся "на поддержке" конфигурации поставщика. Возможные значения:
* `withSupport` - пропускаются все модули, находящиеся "на поддержке" *(все виды "замков")*
* `withSupportLocked` - пропускаются только модули, находящиеся "на поддержке" с запретом изменений *("желтый закрытый замок")*
* `never` - режим поддержки не анализируется и модули не пропускаются *(установлен по умолчанию)*| -|⤷ `mode`|`Строка`|Настройка для управления режимом учета настроек диагностик. Возможные варианты:
* `OFF` - Все диагностики считаются выключенными, вне зависимости от их настроек
* `ON` - Все диагностики включенные по умолчанию считаются включенными, остальные - в зависимости от личных настроек
* `EXCEPT` - Все диагностистики, кроме указанных, считаются включенными
* `ONLY` - Только указанные диагностики считаются включенными
* `ALL` - Все диагностики считаются включенными| -|⤷ `parameters`|`JSON-Объект`|Параметр представляет собой коллекцию настроек диагностик. Элементами коллекции являются json-объекты следующей структуры:
* *ключ объекта* - строка, являющаяся ключом диагностики
* *значение объекта* - может принимать либо булево значение, и тогда интерпретируется как отключение диагностики (`false`) или ее включение с параметрами по умолчанию (`true`), либо значение типа `json-объект`, представляющего собой набор настроек диагностики.
Ключ, включена ли по умолчанию, а также описание возможных параметров и примеры для конфигурационного файла представлены на странице с описанием каждой диагностики.| -|⤷ `subsystemsFilter`|`JSON-Объект`|Фильтр по подсистемам конфигурации| -|⤷ `analyzeOnStart`|`Булево`|Запустить анализ всего проекта при запуске сервера. Если включено, после построения контекста на клиента будет отправлена информация о диагностиках во всех файлах проекта.| -| ⤷ `include`|`Массив` `Строка`|Список имен подсистем по объектам которых выполняется анализ, включая подчиненные подсистемы| -| ⤷ `exclude`|`Массив` `Строка`|Список имен подсистем исключенных из анализа, включая подчиненные подсистемы| -|`documentLink`|`JSON-Объект`|Содержит настройки ссылок на документацию| -|⤷ `showDiagnosticDescription`|`Булево`|Показывать дополнительные ссылки на документацию по диагностикам. По умолчанию параметр выключен (*установлен в `false`*)| -|`useDevSite`|`Булево`|При включении настройки формирующиеся ссылки на документацию будут вести на develop-версию сайта. По умолчанию параметр выключен (*установлен в `false`*)| -|`siteRoot`|`Строка`|Путь к корню сайта с документацией. По умолчанию параметр имеет значение `"https://1c-syntax.github.io/bsl-language-server"` | -|`traceLog`|`Строка`|Для логирования всех запросов *(входящих и исходящих)* между **BSL Language Server** и **Language Client** из используемого редактора/IDE, в этом параметре можно указать путь к файлу лога. Путь можно указывать как абсолютный, так и относительный *(от корня анализируемого проекта)*, по умолчанию значение не заполнено.
**ВНИМАНИЕ**
* При запуске **BSL Language Server** перезаписывает указанный файл
* Скорость взаимодействия между клиентом и сервером **ЗНАЧИТЕЛЬНО ЗАМЕДЛЯЕТСЯ**| -|`configurationRoot`|`Строка`|Данный параметр предназначен для указания корневого каталога, в котором находятся файлы конфигурации 1С в каталоге проекта. Может быть полезен в случае нахождения нескольких каталогов конфигураций в одном каталоге проекта либо при сложной структуре каталога проекта. По умолчанию параметр не заполнен и `BSL Language Server` самостоятельно определяет расположение корневого каталога конфигурации| -|`sendErrors`|`Строка`|Режим отправки сообщений об ошибках разработчикам BSL Language Server. Подробнее - на странице [Мониторинг и отправка ошибок](Monitoring.md). Возможные значения:
* `ask` - спрашивать разрешение при каждой ошибке *(установлен по умолчанию)*.
* `send` - всегда отправлять сообщения об ошибках.
* `never` - никогда не отправлять сообщения об ошибках.| +| Наименование | Тип | Описание | +|:---------------------------------------------------------------|:--------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `language` | `Строка` | Этот параметр устанавливает язык отображения диагностированных замечаний. На данный момент поддерживаются два языка:
* `ru` - для русского языка (*используется по умолчанию*)
* `en` - для английского языка | +| `codeLens` | `JSON-Объект` | Содержит настройки отображения `линз` в продвинутых кода/IDE *(например [Visual Studio Code](https://code.visualstudio.com/))*, в которых выводится различная информация над блоком кода. | +| ⤷ `parameters` | `JSON-Объект` | Коллекция настроек линз. Элементами коллекции являются json-объекты следующей структуры:
* *ключ объекта* - строка, являющаяся идентификатором линзы
* *значение объекта* - может принимать либо булево значение, и тогда интерпретируется как отключение линзы (`false`) или ее включение с параметрами по умолчанию (`true`), либо значение типа `json-объект`, представляющего собой набор настроек линзы. | +| ⤷ `cognitiveComplexity` | `Булево` или `JSON-Объект` | Включает отображение значения [когнитивной сложности](../diagnostics/CognitiveComplexity.md) метода над его определением. По умолчанию настройка установлена в `true`. Доступные параметры линзы: `complexityThreshold` - порог, после которого линза начинает срабатывать. Значение параметра по умолчанию - `-1`. | +| ⤷ `cyclomaticComplexity` | `Булево` или `JSON-Объект` | Включает отображение значения [цикломатической сложности](../diagnostics/CyclomaticComplexity.md) метода. По умолчанию настройка установлена в `true`. Доступные параметры линзы: `complexityThreshold` - порог, после которого линза начинает срабатывать. Значение параметра по умолчанию - `-1`. | +| `diagnostics` | `JSON-Объект` | Содержит настройки диагностик | +| ⤷ `computeTrigger` | `Строка` | С помощью этого параметра можно указать событие, при котором будет вызвана процедура анализа кода для диагностирования замечаний. Возможные значения:
* `onType` - при редактировании файла (онлайн) ***на больших файлах может ЗНАЧИТЕЛЬНО замедлять редактирование***
* `onSave` - при сохранении файла (*используется по умолчанию*)
* `never` - анализ выполняться не будет | +| ⤷ `ordinaryAppSupport` | `Булево` | Поддержка обычного клиента. Диагностики будут требовать учитывать особенности обычного приложения. Возможные значения:
* `true` - конфигурация разрабатывается с поддержкой обычного клиента *(установлен по умолчанию)*
* `false` - игнорировать предупреждения связанные с особенностями обычного клиента | +| ⤷ `skipSupport` | `Строка` | Этим параметром настраивается режим пропуска файлов *(т.е. файлы не анализируются на предмет наличия замечаний)* **конфигурации 1С**, находящихся "на поддержке" конфигурации поставщика. Возможные значения:
* `withSupport` - пропускаются все модули, находящиеся "на поддержке" *(все виды "замков")*
* `withSupportLocked` - пропускаются только модули, находящиеся "на поддержке" с запретом изменений *("желтый закрытый замок")*
* `never` - режим поддержки не анализируется и модули не пропускаются *(установлен по умолчанию)* | +| ⤷ `mode` | `Строка` | Настройка для управления режимом учета настроек диагностик. Возможные варианты:
* `OFF` - Все диагностики считаются выключенными, вне зависимости от их настроек
* `ON` - Все диагностики включенные по умолчанию считаются включенными, остальные - в зависимости от личных настроек
* `EXCEPT` - Все диагностистики, кроме указанных, считаются включенными
* `ONLY` - Только указанные диагностики считаются включенными
* `ALL` - Все диагностики считаются включенными | +| ⤷ `parameters` | `JSON-Объект` | Параметр представляет собой коллекцию настроек диагностик. Элементами коллекции являются json-объекты следующей структуры:
* *ключ объекта* - строка, являющаяся ключом диагностики
* *значение объекта* - может принимать либо булево значение, и тогда интерпретируется как отключение диагностики (`false`) или ее включение с параметрами по умолчанию (`true`), либо значение типа `json-объект`, представляющего собой набор настроек диагностики.
Ключ, включена ли по умолчанию, а также описание возможных параметров и примеры для конфигурационного файла представлены на странице с описанием каждой диагностики. | +| ⤷ `subsystemsFilter` | `JSON-Объект` | Фильтр по подсистемам конфигурации | +| ⤷ `analyzeOnStart` | `Булево` | Запустить анализ всего проекта при запуске сервера. Если включено, после построения контекста на клиента будет отправлена информация о диагностиках во всех файлах проекта. | +| ⤷ `include` | `Массив` `Строка` | Список имен подсистем по объектам которых выполняется анализ, включая подчиненные подсистемы | +| ⤷ `exclude` | `Массив` `Строка` | Список имен подсистем исключенных из анализа, включая подчиненные подсистемы | +| `documentLink` | `JSON-Объект` | Содержит настройки ссылок на документацию | +| ⤷ `showDiagnosticDescription` | `Булево` | Показывать дополнительные ссылки на документацию по диагностикам. По умолчанию параметр выключен (*установлен в `false`*) | +| `inlayHint` | `JSON-Объект` | Содержит настройки отображения `inlay hints` в продвинутых редакторах кода/IDE *(например [Visual Studio Code](https://code.visualstudio.com/))*, в которых выводится различная информация прямо в строке с кодом. | +| ⤷ `parameters` | `JSON-Объект` | Коллекция настроек inlay hints. Элементами коллекции являются json-объекты следующей структуры:
* *ключ объекта* - строка, являющаяся идентификатором inlay hint
* *значение объекта* - может принимать либо булево значение, и тогда интерпретируется как отключение inlay hint (`false`) или их включение с параметрами по умолчанию (`true`), либо значение типа `json-объект`, представляющего собой набор настроек inlay hint. | +| ⤷ `cognitiveComplexity` | `Булево` или `JSON-Объект` | Включает отображение значения [когнитивной сложности](../diagnostics/CognitiveComplexity.md) метода в виде inlay hints. По умолчанию настройка установлена в `true`. | +| ⤷ `cyclomaticComplexity` | `Булево` или `JSON-Объект` | Включает отображение значения [цикломатической сложности](../diagnostics/CyclomaticComplexity.md) метода в виде inlay hints. По умолчанию настройка установлена в `true`. | +| ⤷ `sourceDefinedMethodCall` | `Булево` или `JSON-Объект` | Включает отображение параметров вызываемого метода конфигурации/библиотеки в виде inlay hints. По умолчанию настройка установлена в `true`. Доступные параметры:
* `showParametersWithTheSameName` - отображать параметры с именами, содержащимися в передаваемом значении. Значение параметра по умолчанию - `false`.
* `showDefaultValues` - отображать значения по умолчанию для непереданных параметров. Значение параметра по умолчанию - `true`. | +| `useDevSite` | `Булево` | При включении настройки формирующиеся ссылки на документацию будут вести на develop-версию сайта. По умолчанию параметр выключен (*установлен в `false`*) | +| `siteRoot` | `Строка` | Путь к корню сайта с документацией. По умолчанию параметр имеет значение `"https://1c-syntax.github.io/bsl-language-server"` | +| `traceLog` | `Строка` | Для логирования всех запросов *(входящих и исходящих)* между **BSL Language Server** и **Language Client** из используемого редактора/IDE, в этом параметре можно указать путь к файлу лога. Путь можно указывать как абсолютный, так и относительный *(от корня анализируемого проекта)*, по умолчанию значение не заполнено.
**ВНИМАНИЕ**
* При запуске **BSL Language Server** перезаписывает указанный файл
* Скорость взаимодействия между клиентом и сервером **ЗНАЧИТЕЛЬНО ЗАМЕДЛЯЕТСЯ** | +| `configurationRoot` | `Строка` | Данный параметр предназначен для указания корневого каталога, в котором находятся файлы конфигурации 1С в каталоге проекта. Может быть полезен в случае нахождения нескольких каталогов конфигураций в одном каталоге проекта либо при сложной структуре каталога проекта. По умолчанию параметр не заполнен и `BSL Language Server` самостоятельно определяет расположение корневого каталога конфигурации | +| `sendErrors` | `Строка` | Режим отправки сообщений об ошибках разработчикам BSL Language Server. Подробнее - на странице [Мониторинг и отправка ошибок](Monitoring.md). Возможные значения:
* `ask` - спрашивать разрешение при каждой ошибке *(установлен по умолчанию)*.
* `send` - всегда отправлять сообщения об ошибках.
* `never` - никогда не отправлять сообщения об ошибках. | Для облегчения составления и редактирования конфигурационного файла можно использовать следующую JSON-схему: @@ -43,10 +52,12 @@ https://1c-syntax.github.io/bsl-language-server/configuration/schema.json Ниже приведен пример настройки: * Устанавливает язык сообщений диагностик - английский; -* Изменяет настройку диагностики [LineLength - Ограничение на длину строки](../diagnostics/LineLength.md), устанавливая предел длины строки в 140 символов; +* Изменяет настройку диагностики [LineLength - Ограничение на длину строки](../diagnostics/LineLength.md), устанавливая + предел длины строки в 140 символов; * Отключает диагностику [MethodSize - Ограничение на размер метода](../diagnostics/MethodSize.md). * Включает расчет диагностик в непрерывном режиме (`computeTrigger = onType`) -* Диагностики рассчитываются только по объектам подсистемы "СтандартныеПодсистемы" за исключением "ВариантыОтчетов" и "ВерсионированиеОбъектов" +* Диагностики рассчитываются только по объектам подсистемы "СтандартныеПодсистемы" за исключением "ВариантыОтчетов" и " + ВерсионированиеОбъектов" ```json { @@ -61,8 +72,13 @@ https://1c-syntax.github.io/bsl-language-server/configuration/schema.json "MethodSize": false }, "subsystemsFilter": { - "include": ["СтандартныеПодсистемы"], - "exclude": ["ВариантыОтчетов", "ВерсионированиеОбъектов"] + "include": [ + "СтандартныеПодсистемы" + ], + "exclude": [ + "ВариантыОтчетов", + "ВерсионированиеОбъектов" + ] } } } diff --git a/docs/index.md b/docs/index.md index 82eff10f92a..6d74f53391c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,13 +2,12 @@ [](https://github.com/1c-syntax/bsl-language-server/actions) [](https://github.com/1c-syntax/bsl-language-server/releases/latest) -[](https://jitpack.io/#1c-syntax/bsl-language-server) +[](https://github.com/1c-syntax/bsl-language-server/releases) [](https://github.com/1c-syntax/bsl-language-server/releases) [](https://github.com/1c-syntax/bsl-language-server/releases) [](https://sonarcloud.io/dashboard?id=1c-syntax_bsl-language-server) [](https://sonarcloud.io/dashboard?id=1c-syntax_bsl-language-server) [](https://sonarcloud.io/dashboard?id=1c-syntax_bsl-language-server) -[](https://1c-syntax.github.io/bsl-language-server/qodana) [](https://www.transifex.com/1c-syntax/bsl-language-server) [](bench/index.html) [](https://t.me/bsl_language_server) @@ -61,7 +60,7 @@ | [didChangeConfiguration](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeConfiguration) |
| с ограничениями, см. [#1431](https://github.com/1c-syntax/bsl-language-server/issues/1431) |
| [didChangeWatchedFiles](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeWatchedFiles) | | |
| [symbol](https://microsoft.github.io/language-server-protocol/specification#workspace_symbol) | | |
- | [executeCommand](https://microsoft.github.io/language-server-protocol/specification#workspace_executeCommand) | | |
+ | [executeCommand](https://microsoft.github.io/language-server-protocol/specification#workspace_executeCommand) | | |
| [applyEdit](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_applyEdit) | | |
| [willCreateFiles](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_willCreateFiles) | | |
@@ -112,6 +111,9 @@
| [semanticTokens](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_semanticTokens) | | | |
| [linkedEditingRange](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_linkedEditingRange) | | | |
| [moniker](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_moniker) | | | |
+ | [inlayHint](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_inlayHint) | | resolveProvider = false | да |
+ | [inlayHint/resolve](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#inlayHint_resolve) | | | |
+ | [inlayHint/refresh](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_inlayHint_refresh) | | | |
@@ -204,7 +206,7 @@ Run analysis and get diagnostic info
```
Для указания каталога расположения анализируемых исходников используется параметр `--srcDir` (сокращенно `-s`), за которым следует путь (относительный или абсолютный) к каталогу исходников.
-Для формирования отчета об анализе требуется указать один или "репортеров". Для указания репортера используется параметр `--reporter` (сокращенно `-r`), за которым следует ключ репортера. Допустимо указывать несколько репортеров. Список репортетов см. в разделе **Репортеры**.
+Для формирования отчета об анализе требуется указать один из "репортеров". Для указания репортера используется параметр `--reporter` (сокращенно `-r`), за которым следует ключ репортера. Допустимо указывать несколько репортеров. Список репортетов см. в разделе **Репортеры**.
Пример строки запуска анализа:
diff --git a/docs/reporters/code-quality.md b/docs/reporters/code-quality.md
new file mode 100644
index 00000000000..9f6932d2c5a
--- /dev/null
+++ b/docs/reporters/code-quality.md
@@ -0,0 +1,7 @@
+# CodeQuality reporter
+
+Ключ репортера - `code-quality`
+
+## Описание
+
+Выводит результаты анализа в файл `bsl-code-quality.json` в текущей рабочей директории. Формат вывода описан в документации GitLab, раздел [Code Quality](https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format)
diff --git a/docs/reporters/index.md b/docs/reporters/index.md
index d47c679b936..529706db773 100644
--- a/docs/reporters/index.md
+++ b/docs/reporters/index.md
@@ -9,4 +9,5 @@
* [junit](junit.md);
* [tslint](tslint.md);
* [sarif](sarif.md);
+* [code-quality](code-quality.md);
* [console](console.md).
diff --git a/docs/systemRequirements.md b/docs/systemRequirements.md
index 750751402fa..5d97384198a 100644
--- a/docs/systemRequirements.md
+++ b/docs/systemRequirements.md
@@ -6,7 +6,7 @@
`BSL Language Server` представляет собой консольное Java приложение, соответственно, для его функционирования необходимо наличие виртуальной машины Java на компьютере.
-На данный момент минимальной поддерживаемой версией является Java 11, но в рамках сборочных конвейеров происходит проверка работоспособности при использовании более свежих версий. На данный момент поддерживаются Java версий 11 и 17.
+На данный момент минимальной поддерживаемой версией является Java 17, но в рамках сборочных конвейеров происходит проверка работоспособности при использовании более свежих версий. На данный момент поддерживаются Java версий 17, 21, 23.
Кроме версии Java интересен и вендор JDK. В связи с изменившейся политикой лицензирования Oracle, рекомендуется использование открытых реализаций виртуальной машины `OpenJDK`: AdoptOpenJDK, Liberica JDK.
@@ -14,6 +14,6 @@
`BSL Language Server` должен работать на всех системах под управлением современных десктопных и серверных операционных систем, для которых существует поддержка Java. В рамках сборочных конвейеров происходит тестирование наиболее популярных окружений:
-- гарантированно работает на последних версиях OS семейства Windows 7/10, включая серверные 2012 и выше
+- гарантированно работает на последних версиях OS семейства Windows 7/10/11, включая серверные 2012 и выше
- поддерживаются OS на ядре Linux, в частности проводится тестирование каждого изменения на Ubuntu, в промышленной эксплуатации подтверждена работоспособность на CentOS версий 6 и 7.
- поддерживается MacOS последних версий
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
index 7454180f2ae..9bbc975c742 100644
Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
index 2e6e5897b52..37f853b1c84 100644
--- a/gradle/wrapper/gradle-wrapper.properties
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
index c53aefaa5fc..faf93008b77 100755
--- a/gradlew
+++ b/gradlew
@@ -1,7 +1,7 @@
#!/bin/sh
#
-# Copyright 2015-2021 the original authors.
+# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -15,6 +15,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+# SPDX-License-Identifier: Apache-2.0
+#
##############################################################################
#
@@ -32,10 +34,10 @@
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
-# * expansions $var, ${var}, ${var:-default}, ${var+SET},
-# ${var#prefix}, ${var%suffix}, and $( cmd );
-# * compound commands having a testable exit status, especially case;
-# * various built-in commands including command, set, and ulimit.
+# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+# * compound commands having a testable exit status, especially «case»;
+# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
@@ -55,7 +57,7 @@
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
-# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +82,11 @@ do
esac
done
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
@@ -133,22 +133,29 @@ location of your Java installation."
fi
else
JAVACMD=java
- which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+ if ! command -v java >/dev/null 2>&1
+ then
+ die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
+ fi
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
+ # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+ # shellcheck disable=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
+ # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+ # shellcheck disable=SC2039,SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
@@ -193,11 +200,15 @@ if "$cygwin" || "$msys" ; then
done
fi
-# Collect all arguments for the java command;
-# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-# shell script including quotes and variable substitutions, so put them in
-# double quotes to make sure that they get re-expanded; and
-# * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+# and any embedded shellness will be escaped.
+# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+# treated as '${Hostname}' itself on the command line.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
@@ -205,6 +216,12 @@ set -- \
org.gradle.wrapper.GradleWrapperMain \
"$@"
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+ die "xargs is not available"
+fi
+
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
diff --git a/gradlew.bat b/gradlew.bat
index 107acd32c4e..9d21a21834d 100644
--- a/gradlew.bat
+++ b/gradlew.bat
@@ -13,8 +13,10 @@
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@@ -25,7 +27,8 @@
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@@ -40,13 +43,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
goto fail
@@ -56,11 +59,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
goto fail
@@ -75,13 +78,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
:end
@rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
-if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal
diff --git a/jitpack.yml b/jitpack.yml
deleted file mode 100644
index c9e5a8ab06d..00000000000
--- a/jitpack.yml
+++ /dev/null
@@ -1,4 +0,0 @@
-before_install:
- - source ~/.sdkman/bin/sdkman-init.sh
- - sdk install java 17.0.1-tem
- - sdk use java 17.0.1-tem
diff --git a/lombok.config b/lombok.config
index 0206de4de79..9ed93ece8d2 100644
--- a/lombok.config
+++ b/lombok.config
@@ -1,4 +1,6 @@
lombok.anyConstructor.addConstructorProperties=true
+lombok.copyableannotations+=org.springframework.beans.factory.annotation.Qualifier
+lombok.copyableannotations+=org.springframework.beans.factory.annotation.Value
lombok.addLombokGeneratedAnnotation=true
lombok.log.fieldName=LOGGER
lombok.extern.findbugs.addSuppressFBWarnings = true
diff --git a/qodana.yaml b/qodana.yaml
deleted file mode 100644
index 446ab3156d0..00000000000
--- a/qodana.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-version: "1.0"
-linter: jetbrains/qodana-jvm-community:2022.2
-profile:
- name: qodana.starter
-include:
- - name: CheckDependencyLicenses
-exclude:
- - name: OptionalUsedAsFieldOrParameterType
diff --git a/src/jmh/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/VariableSymbolCreate.java b/src/jmh/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/VariableSymbolCreate.java
index 994dcca3d88..f60f8134312 100644
--- a/src/jmh/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/VariableSymbolCreate.java
+++ b/src/jmh/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/VariableSymbolCreate.java
@@ -1,7 +1,7 @@
/*
* This file is a part of BSL Language Server.
*
- * Copyright (c) 2018-2022
+ * Copyright (c) 2018-2025
* Alexey Sosnoviy