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

The Spotify checkstyle configuration
https://github.com/spotify/spotify-checkstyle-config

checkstyle java

Last synced: about 1 month ago
JSON representation

The Spotify checkstyle configuration

• Host: GitHub
• URL: https://github.com/spotify/spotify-checkstyle-config
• Owner: spotify
• License: lgpl-2.1
• Archived: true
• Created: 2016-06-27T14:40:30.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-07-08T00:29:48.000Z (about 4 years ago)
• Last Synced: 2024-04-27T08:32:09.082Z (5 months ago)
• Topics: checkstyle, java
• Size: 73.2 KB
• Stars: 27
• Watchers: 15
• Forks: 17
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
Spotify Checkstyle Configuration

================================

[![Maven Central](https://img.shields.io/maven-central/v/com.spotify.checkstyle/spotify-checkstyle-config.svg)](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.spotify.checkstyle%22%20spotify-checkstyle-config)

[![License](https://img.shields.io/github/license/spotify/spotify-checkstyle-config.svg)](LICENSE.txt)

This project provides a default configuration for checkstyle at Spotify.

To use it, configure your maven-checkstyle-plugin like so:

```

   

     maven-checkstyle-plugin

     2.17

     

       

         com.spotify.checkstyle

         spotify-checkstyle-config

         LATEST-VERSION

       

       

         com.puppycrawl.tools

         checkstyle

         8.24

       

     

     

       spotify_checks.xml

       

       

       true

       true

       true

       error

     

     

       

         validate

         validate

         

           check

         

       

     

   

```

See the [maven-checkstyle-plugin docs](https://maven.apache.org/plugins/maven-checkstyle-plugin/check-mojo.html) 

for more information about what the configuration parameters mean.

Internally, we have the above configuration in the `` section of a 

company-wide parent pom, meaning that projects only need to specify the below in their

`` section:

```

   

      maven-checkstyle-plugin

   

```

# Configuration

## Suppressions

The configuration of the checkstyle plugin you get from `spotify_checks.xml` tells it to 

optionally look for a file named `suppressions.xml` as per the

[SuppressionFilter docs](http://checkstyle.sourceforge.net/config_filters.html#SuppressionFilter). 

This means you can configure suppressions by providing such a file on your

project's classpath or in the current directory where you build it - note 

that for multi-module projects, it's probably a good idea to use something

like [this solution](http://stackoverflow.com/a/19690484/1659929) to share

the configuration among each sub-module.

# IDEA support

There is a [configuration file for IntelliJ IDEA](src/main/idea/spotify-checkstyle-idea.xml) that you can import into your project.

# Code of conduct

This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.

[code-of-conduct]: https://github.com/spotify/code-of-conduct/blob/master/code-of-conduct.md