Skip to content

Commit 94e8aa7

Browse files
committed
Линки и баджи
1 parent 18968c5 commit 94e8aa7

File tree

2 files changed

+22
-6
lines changed

2 files changed

+22
-6
lines changed

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,7 @@ java -jar bsl-language-server.jar --diagnosticLanguage ru
4141
4242
Для формирования отчета об анализе требуется указать один или "репортеров". Для указания репортера используется параметр `--reporter` (сокращенно `-r`), за которым следует ключ репортера. Допустимо указывать несколько репортеров.
4343
44-
Доступные ключи репортеров:
45-
46-
* `generic` - вывод результата анализа в формате [Generic issue](https://docs.sonarqube.org/latest/analysis/generic-issue/).
47-
* `json` - вывод результата анализа в собственном формате JSON, поддерживаемым [SonarQube 1C (BSL) Community Plugin](https://github.com/1c-syntax/sonar-bsl-plugin-community);
48-
* `console` - вывод результата анализа в консоль;
49-
* `tslint` - вывод результата анализа в формате [TSLint JSON](https://palantir.github.io/tslint/formatters/json).
44+
Список и описания репортеров доступны [на сайте проекта](https://1c-syntax.github.io/bsl-language-server/).
5045
5146
Пример строки запуска анализа:
5247

docs/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
11
# BSL Language Server
22

3+
[![Build Status](https://travis-ci.org/1c-syntax/bsl-language-server.svg?branch=master)](https://travis-ci.org/1c-syntax/bsl-language-server)
4+
[![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)
5+
[![JitPack](https://jitpack.io/v/1c-syntax/bsl-language-server.svg)](https://jitpack.io/#1c-syntax/bsl-language-server)
6+
[![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)
7+
[![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)
8+
[![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)
9+
310
Реализация протокола [language server protocol](https://microsoft.github.io/language-server-protocol/) для языка 1C (BSL) - языка 1С:Предприятие 8 и [OneScript](http://oscript.io).
411

12+
* <a href="#capabilities">Возможности</a>
13+
* <a href="#cli">Запуск из командной строки</a>
14+
* <a href="#reporters">Репортеры</a>
15+
* <a href="#diagnostics">Диагностики</a>
16+
17+
<a id="capabilities"/>
18+
519
## Возможности
620

721
* Показ всплывающей информации по текущей процедуре
822
* Диагностики
923
* Запуск движка диагностик из командной строки
1024

25+
<a id="cli"/>
26+
1127
## Запуск из командной строки
1228

1329
Запуск jar-файлов осуществляется через `java -jar path/to/file.jar`.
@@ -48,17 +64,22 @@ java -jar bsl-language-server.jar --analyze --srcDir ./src/cf --reporter json
4864
java -Xmx4g -jar bsl-language-server.jar ...остальные параметры
4965
```
5066

67+
<a id="reporters"/>
68+
5169
## Репортеры
5270

5371
Используются для получения результатов анализа.
5472

5573
### Список реализованных репортеров
5674

5775
* [json](reporters/json.md) - вывод результата анализа в собственном формате JSON, поддерживаемым [SonarQube 1C (BSL) Community Plugin](https://github.com/1c-syntax/sonar-bsl-plugin-community);
76+
* [generic](reporters/generic.md) - вывод результата анализа в формате [Generic issue](https://docs.sonarqube.org/latest/analysis/generic-issue/) для SonarQube;
5877
* [junit](reporters/junit.md);
5978
* [tslint](reporters/tslint.md);
6079
* [console](reporters/console.md).
6180

81+
<a id="diagnostics"/>
82+
6283
## Диагностики
6384

6485
Используются для проверки кода на соответствие стандартам кодирования и для поиска возможных ошибок.

0 commit comments

Comments
 (0)