Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aboutbits/java-checkstyle-config

Configuration for Checkstyle
https://github.com/aboutbits/java-checkstyle-config

checkstyle code-quality configuration java linter

Last synced: about 1 month ago
JSON representation

Configuration for Checkstyle

Awesome Lists containing this project

README

        

# Java Checkstyle Config

Checkstyle config for all JAVA projects.

## Usage

Add the `maven-checkstyle-plugin` to your `pom.xml`:
```xml

org.apache.maven.plugins
maven-checkstyle-plugin
3.5.0

checkstyle.xml
checkstyle-suppressions.xml
true
true
true
false



validate
validate

check





com.puppycrawl.tools
checkstyle
10.18.1


it.aboutbits
java-checkstyle-config
1.0.0

```

**Configure your IDE:**
First you need to run `mvn verify` once.
In your IDE go to `Settings` then search for "checkstyle".
Add a new checkstyle configuration and select the `target/checkstyle-checker.xml` file.
Set the property `org.checkstyle.sun.suppressionfilter.config` to `checkstyle-suppressions.xml`

## Information

About Bits is a company based in South Tyrol, Italy. You can find more information about us on [our website](https://aboutbits.it).

### Support

For support, please contact [[email protected]](mailto:[email protected]).

### Credits

- [All Contributors](../../contributors)

### License

The MIT License (MIT). Please see the [license file](license.md) for more information.