Skip to content

Commit

Permalink
Линки и баджи
Browse files Browse the repository at this point in the history
  • Loading branch information
nixel2007 committed Feb 26, 2019
1 parent 18968c5 commit 94e8aa7
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 6 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Пример строки запуска анализа:
Expand Down
21 changes: 21 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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).

* <a href="#capabilities">Возможности</a>
* <a href="#cli">Запуск из командной строки</a>
* <a href="#reporters">Репортеры</a>
* <a href="#diagnostics">Диагностики</a>

<a id="capabilities"/>

## Возможности

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

<a id="cli"/>

## Запуск из командной строки

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

<a id="reporters"/>

## Репортеры

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

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

* [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).

<a id="diagnostics"/>

## Диагностики

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

0 comments on commit 94e8aa7

Please sign in to comment.