diff --git a/README.md b/README.md index d40f8e91dee..602ae907f00 100644 --- a/README.md +++ b/README.md @@ -41,12 +41,7 @@ java -jar bsl-language-server.jar --diagnosticLanguage ru Для формирования отчета об анализе требуется указать один или "репортеров". Для указания репортера используется параметр `--reporter` (сокращенно `-r`), за которым следует ключ репортера. Допустимо указывать несколько репортеров. -Доступные ключи репортеров: - -* `generic` - вывод результата анализа в формате [Generic issue](https://docs.sonarqube.org/latest/analysis/generic-issue/). -* `json` - вывод результата анализа в собственном формате JSON, поддерживаемым [SonarQube 1C (BSL) Community Plugin](https://github.com/1c-syntax/sonar-bsl-plugin-community); -* `console` - вывод результата анализа в консоль; -* `tslint` - вывод результата анализа в формате [TSLint JSON](https://palantir.github.io/tslint/formatters/json). +Список и описания репортеров доступны [на сайте проекта](https://1c-syntax.github.io/bsl-language-server/). Пример строки запуска анализа: diff --git a/docs/index.md b/docs/index.md index 70ae4099818..122f6741711 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,13 +1,29 @@ # BSL Language Server +[![Build Status](https://travis-ci.org/1c-syntax/bsl-language-server.svg?branch=master)](https://travis-ci.org/1c-syntax/bsl-language-server) +[![Download](https://img.shields.io/github/release/1c-syntax/bsl-language-server.svg?label=download&style=flat-square)](https://github.com/1c-syntax/bsl-language-server/releases/latest) +[![JitPack](https://jitpack.io/v/1c-syntax/bsl-language-server.svg)](https://jitpack.io/#1c-syntax/bsl-language-server) +[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=1c-syntax_bsl-language-server&metric=alert_status)](https://sonarcloud.io/dashboard?id=1c-syntax_bsl-language-server) +[![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=1c-syntax_bsl-language-server&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=1c-syntax_bsl-language-server) +[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=1c-syntax_bsl-language-server&metric=coverage)](https://sonarcloud.io/dashboard?id=1c-syntax_bsl-language-server) + Реализация протокола [language server protocol](https://microsoft.github.io/language-server-protocol/) для языка 1C (BSL) - языка 1С:Предприятие 8 и [OneScript](http://oscript.io). +* Возможности +* Запуск из командной строки +* Репортеры +* Диагностики + + + ## Возможности * Показ всплывающей информации по текущей процедуре * Диагностики * Запуск движка диагностик из командной строки + + ## Запуск из командной строки Запуск jar-файлов осуществляется через `java -jar path/to/file.jar`. @@ -48,6 +64,8 @@ java -jar bsl-language-server.jar --analyze --srcDir ./src/cf --reporter json java -Xmx4g -jar bsl-language-server.jar ...остальные параметры ``` + + ## Репортеры Используются для получения результатов анализа. @@ -55,10 +73,13 @@ java -Xmx4g -jar bsl-language-server.jar ...остальные параметр ### Список реализованных репортеров * [json](reporters/json.md) - вывод результата анализа в собственном формате JSON, поддерживаемым [SonarQube 1C (BSL) Community Plugin](https://github.com/1c-syntax/sonar-bsl-plugin-community); +* [generic](reporters/generic.md) - вывод результата анализа в формате [Generic issue](https://docs.sonarqube.org/latest/analysis/generic-issue/) для SonarQube; * [junit](reporters/junit.md); * [tslint](reporters/tslint.md); * [console](reporters/console.md). + + ## Диагностики Используются для проверки кода на соответствие стандартам кодирования и для поиска возможных ошибок.