https://github.com/patrickfav/checkstyle-config

Global checkstyle config to be reused in different projects. These include my own personal rules so your milage may vary.
https://github.com/patrickfav/checkstyle-config

checkstyle checkstyle-plugin configuration java maven

Last synced: 2 months ago
JSON representation

Global checkstyle config to be reused in different projects. These include my own personal rules so your milage may vary.

• Host: GitHub
• URL: https://github.com/patrickfav/checkstyle-config
• Owner: patrickfav
• License: apache-2.0
• Created: 2019-04-14T18:19:48.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-02-12T21:47:53.000Z (almost 2 years ago)
• Last Synced: 2023-06-29T07:08:24.555Z (over 1 year ago)
• Topics: checkstyle, checkstyle-plugin, configuration, java, maven
• Homepage: https://favr.dev/opensource/checkstyle-config
• Size: 316 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
# Common Checkstyle Config



Externalized checkstyle configuration which can be used in other Maven projects.

[![Maven Central](https://img.shields.io/maven-central/v/at.favre.lib/checkstyle-config)](https://mvnrepository.com/artifact/at.favre.lib/checkstyle-config)

[![Build Status](https://travis-ci.com/patrickfav/checkstyle-config.svg?branch=master)](https://travis-ci.com/patrickfav/checkstyle-config)

## Description

This is a hand-picked, incrementally improved checkstyle configuration. It is more on the liberal side as I believe tools should work for the user not the other way around. Code style is subjective and this one might not be for you.

## Usage

Add this maven project as dependency to load the external checkstyle configuration. The name of the config xml is `checkstyle.xml`.

```xml

    

        

            

            

                org.apache.maven.plugins

                maven-checkstyle-plugin

                ...

                

                    ...

                    

                    

                        at.favre.lib

                        checkstyle-config

                        {latest_version}

                    

                

                

                    checkstyle.xml

                

            

            ...

```

See this [stackoverflow.com post](https://stackoverflow.com/a/19690484/774398) for more info.

### IDE Integration

#### IntelliJ

If you are using the [checkstyle plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) for [IntelliJ](https://www.jetbrains.com/idea/) (which you should). You will find a copy of the configuration in the `/target` folder called `checkstyle-checker.xml`. 

# License

Copyright 2019 Patrick Favre-Bulle

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.