cwkr-checkstyle

Checkstyle configuration and custom checks

License	The Apache License, Version 2.0
Categories	Checkstyle Application Testing & Monitoring Code Analysis
GroupId	de.cwkr
ArtifactId	cwkr-checkstyle
Last Version	1.1
Release Date	Jan 18, 2020
Type	jar
Description	cwkr-checkstyle Checkstyle configuration and custom checks
Project URL	https://github.com/cwkr/coding-guidelines
Source Code Management	https://github.com/cwkr/coding-guidelines

Download cwkr-checkstyle

Filename	Size
cwkr-checkstyle-1.1.pom
cwkr-checkstyle-1.1.jar	5 KB
cwkr-checkstyle-1.1-sources.jar	5 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/de.cwkr/cwkr-checkstyle/ -->
<dependency>
    <groupId>de.cwkr</groupId>
    <artifactId>cwkr-checkstyle</artifactId>
    <version>1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/de.cwkr/cwkr-checkstyle/
implementation 'de.cwkr:cwkr-checkstyle:1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/de.cwkr/cwkr-checkstyle/
implementation ("de.cwkr:cwkr-checkstyle:1.1")

Apache Buildr

'de.cwkr:cwkr-checkstyle:jar:1.1'

Apache Ivy

<dependency org="de.cwkr" name="cwkr-checkstyle" rev="1.1">
  <artifact name="cwkr-checkstyle" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='de.cwkr', module='cwkr-checkstyle', version='1.1')
)

Scala SBT

libraryDependencies += "de.cwkr" % "cwkr-checkstyle" % "1.1"

Leiningen

[de.cwkr/cwkr-checkstyle "1.1"]

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.

Coding Guidelines

This project collects coding conventions and best practices.

Static Code Analysis using PMD

This project contains the following PMD rule sets.

• category/java/cwkr/recommended.xml
  • category/java/cwkr/codestyle.xml
  • category/java/cwkr/exceptions.xml
  • category/java/cwkr/logging.xml
  • category/java/cwkr/maintainability.xml
  • category/java/cwkr/performance.xml

They can be used to check Java source code using Maven as follows:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-pmd-plugin</artifactId>
    <version>3.13.0</version>
    <configuration>
        <rulesets>
            <ruleset>/category/java/cwkr/recommended.xml</ruleset>
        </rulesets>
        <linkXRef>false</linkXRef>
        <printFailingErrors>true</printFailingErrors>
        <failOnViolation>true</failOnViolation>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>net.sourceforge.pmd</groupId>
            <artifactId>pmd-core</artifactId>
            <version>6.28.0</version>
        </dependency>
        <dependency>
            <groupId>net.sourceforge.pmd</groupId>
            <artifactId>pmd-java</artifactId>
            <version>6.28.0</version>
        </dependency>
        <dependency>
            <groupId>de.cwkr</groupId>
            <artifactId>cwkr-pmd</artifactId>
            <version>1.3.1</version>
        </dependency>
    </dependencies>
    <executions>
        <execution>
            <id>validate</id>
            <phase>validate</phase>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Static Code Analysis using Stylelint

stylelint-config-cwkr

Licensing

The Apache License, Version 2.0

Versions

Version
1.1 Jan 18, 2020
1.0 Jan 13, 2020