cwkr-coding-guidelines

Coding conventions and best practices

License	The Apache License, Version 2.0
Categories	IDE Development Tools GUI User Interface
GroupId	de.cwkr
ArtifactId	cwkr-coding-guidelines
Last Version	1.2.1
Release Date	Jun 27, 2020
Type	jar
Description	cwkr-coding-guidelines Coding conventions and best practices
Project URL	https://github.com/cwkr/coding-guidelines
Source Code Management	https://github.com/cwkr/coding-guidelines

Download cwkr-coding-guidelines

Filename	Size
cwkr-coding-guidelines-1.2.1.pom
cwkr-coding-guidelines-1.2.1.jar	9 KB
cwkr-coding-guidelines-1.2.1-sources.jar	9 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/de.cwkr/cwkr-coding-guidelines/ -->
<dependency>
    <groupId>de.cwkr</groupId>
    <artifactId>cwkr-coding-guidelines</artifactId>
    <version>1.2.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/de.cwkr/cwkr-coding-guidelines/
implementation 'de.cwkr:cwkr-coding-guidelines:1.2.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/de.cwkr/cwkr-coding-guidelines/
implementation ("de.cwkr:cwkr-coding-guidelines:1.2.1")

Apache Buildr

'de.cwkr:cwkr-coding-guidelines:jar:1.2.1'

Apache Ivy

<dependency org="de.cwkr" name="cwkr-coding-guidelines" rev="1.2.1">
  <artifact name="cwkr-coding-guidelines" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='de.cwkr', module='cwkr-coding-guidelines', version='1.2.1')
)

Scala SBT

libraryDependencies += "de.cwkr" % "cwkr-coding-guidelines" % "1.2.1"

Leiningen

[de.cwkr/cwkr-coding-guidelines "1.2.1"]

Dependencies

compile (2)

Group / Artifact	Type	Version
net.sourceforge.pmd : pmd-core	jar	6.24.0
net.sourceforge.pmd : pmd-java	jar	6.24.0

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.2.1 Jun 27, 2020
1.2.0 Jan 19, 2020
1.1 Jan 18, 2020