Skip to content

SimonHarmonicMinor/beholder-core

Repository files navigation

Beholder

Build Status Quality Gate Status Coverage

Automatic Java code style checker

The current version is in alpha stage now. The API is not stable and will be probably changed in the future. If you want 1.0 version to release sooner, feel free to contribute!

The master branch represents DEV-SNAPSHOT version that updates on each merge of a pull request. You can find release versions by tag names.

Table of contents

What is it about

We always try to specify some code style rules, when it comes to project development in a team. The problem is that usually these rules are not obligatory. For example, we made a deal that all public methods should be overridden from an interface or an abstract class. It forces developers to check each pull request for any rule violations. Of course, some will be missed. More than that, some will be missed manually. Imagine that developers decided that test coverage should not be decreased by any new feature implementation. Do you think it would be possible if there were now automatic analyzers that restrict merges on bad pull requests? This library provides the same philosophy with code style. The build won't be passed, if there is any rule that failed.

Quick start

Maven:

<dependency>
    <groupId>com.kirekov</groupId>
    <artifactId>beholder-core</artifactId>
</dependency>

Gradle:

dependencies {
    implementation 'com.kirekov:beholder-core' 
}

Usage

// TODO

Releases

No releases published

Packages

No packages published