PHPackages                             aaerofeev/bitbucket-static-reviews - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. aaerofeev/bitbucket-static-reviews

ActiveLibrary

aaerofeev/bitbucket-static-reviews
==================================

Checkstyle integration to stash/bitbucket pull requests

1.0.2(7y ago)1101MITPHPPHP >=7.0

Since Nov 23Pushed 7y ago1 watchersCompare

[ Source](https://github.com/aaerofeev/bitbucket-static-reviews)[ Packagist](https://packagist.org/packages/aaerofeev/bitbucket-static-reviews)[ RSS](/packages/aaerofeev-bitbucket-static-reviews/feed)WikiDiscussions master Synced 5d ago

READMEChangelog (1)Dependencies (4)Versions (4)Used By (0)

Интеграция checkstyle-format в stash/bitbucket
----------------------------------------------

[](#интеграция-checkstyle-format-в-stashbitbucket)

### Checkstyle-format integration into stash / bitbucket

[](#checkstyle-format-integration-into-stash--bitbucket)

[See English version below](#in-english)

Читает формат checkstyle и пишет комментарии к pull-request в stash/bitbucket

[Dockerhub image](https://hub.docker.com/r/aaerofeev/bitbucket-static-reviews)

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

[](#возможности)

- Публикация комментариев на основе отчетов checkstyle
- Режимы работы инспектора только с измененным кодом или контекстом
- Группировка ошибок
- Ограничения по важности
- Ограничения по количеству комментариев: общий, на файл, на группу
- Реакция на исправленные ошибки (геймификация)
- Игнорирование по паттерну ошибки, или по файлу
- Отправка статистики в statsd

#### Автоматическая пометка "Исправлено" / "Fixed" mark added automatically

[](#автоматическая-пометка-исправлено--fixed-mark-added-automatically)

[![Fixed](https://github.com/aaerofeev/bitbucket-static-reviews/raw/master/docs/Selection_006.png?raw=true)](https://github.com/aaerofeev/bitbucket-static-reviews/blob/master/docs/Selection_006.png?raw=true)

#### Группировка ошибок / Error grouping

[](#группировка-ошибок--error-grouping)

[![Group](https://github.com/aaerofeev/bitbucket-static-reviews/raw/master/docs/Selection_007.png?raw=true)](https://github.com/aaerofeev/bitbucket-static-reviews/blob/master/docs/Selection_007.png?raw=true)

### Как работает

[](#как-работает)

Данные которые требуются: проект, репозиторий, ветка. Комментарии будут публиковаться в пулл-реквест со статусом OPEN, если такой имеется.

1. Передается результат `git diff origin/master ` или разница ревизий
2. Последовательно передаются результаты работы статических анализаторов в формате checkstyle
3. Производится анализ и рассылка комментариев

### In English

[](#in-english)

This project reads checkstyle format reports and writes comments to stash / bitbucket pull-requests.

### Features

[](#features)

- Posts comments based on checkstyle reports
- Can be configured to check the context or modified code only
- Error grouping
- Severity limitation
- Limit the number of comments: total, per file, or per group
- Reaction to fixed bugs (gamification)
- Ignoring by error patterns and by filenames
- Sending statistics to statsd

### How does it work

[](#how-does-it-work)

Required options: project, repository, and branch names. Comments will be posted to a pull-request with an OPEN status, if any.

1. The results of `git diff origin/master ` or the revisions difference is transmitted to analyzers
2. Static analyzers' reports are collected
3. The comments are analyzed and sent to Bitbucket API

### Bitbucket API

[](#bitbucket-api)

[https://docs.atlassian.com/bitbucket-server/rest/5.15.0/bitbucket-rest.html?utm\_source=%2Fstatic%2Frest%2Fbitbucket-server%2Flatest%2Fbitbucket-rest.html&utm\_medium=301#idm45622371276656](https://docs.atlassian.com/bitbucket-server/rest/5.15.0/bitbucket-rest.html?utm_source=%2Fstatic%2Frest%2Fbitbucket-server%2Flatest%2Fbitbucket-rest.html&utm_medium=301#idm45622371276656)

### Config

[](#config)

Default configuration filename is `.config.php`

```