JarCasting
JarCasting JarCasting

Common Checkstyle Configuration

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

License

License
Categories

Categories

Checkstyle Application Testing & Monitoring Code Analysis config Application Layer Libs Configuration
GroupId

GroupId

at.favre.lib
ArtifactId

ArtifactId

checkstyle-config
Last Version

Last Version

2
Release Date

Release Date
Type

Type

jar
Description

Description

Common Checkstyle Configuration
Externalized checkstyle configuration which can be used in other Maven projects.
Project URL

Project URL

https://github.com/patrickfav/checkstyle-config
Source Code Management

Source Code Management

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

Download checkstyle-config

Filename Size
checkstyle-config-2.pom
checkstyle-config-2.jar 4 KB
checkstyle-config-2-sources.jar 4 KB
checkstyle-config-2-javadoc.jar 2 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/at.favre.lib/checkstyle-config/ -->
<dependency>
    <groupId>at.favre.lib</groupId>
    <artifactId>checkstyle-config</artifactId>
    <version>2</version>
</dependency>
// https://jarcasting.com/artifacts/at.favre.lib/checkstyle-config/
implementation 'at.favre.lib:checkstyle-config:2'
// https://jarcasting.com/artifacts/at.favre.lib/checkstyle-config/
implementation ("at.favre.lib:checkstyle-config:2")
'at.favre.lib:checkstyle-config:jar:2'
<dependency org="at.favre.lib" name="checkstyle-config" rev="2">
  <artifact name="checkstyle-config" type="jar" />
</dependency>
@Grapes(
@Grab(group='at.favre.lib', module='checkstyle-config', version='2')
)
libraryDependencies += "at.favre.lib" % "checkstyle-config" % "2"
[at.favre.lib/checkstyle-config "2"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Common Checkstyle Config

Logo

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

Download Build Status

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.

    <build>
        <plugins>
            <!-- checkstyle -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                ...
                <dependencies>
                    ...
                    <!-- add this lib as dependency to load external checkstyle config -->
                    <dependency>
                        <groupId>at.favre.lib</groupId>
                        <artifactId>checkstyle-config</artifactId>
                        <version>{latest_version}</version>
                    </dependency>
                </dependencies>
                <configuration>
                    <configLocation>checkstyle.xml</configLocation>
                </configuration>
            </plugin>
            ...

See this stackoverflow.com post for more info.

IDE Integration

IntelliJ

If you are using the checkstyle plugin for IntelliJ (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.

Versions

Version
2
1