com.cogvio:checkstyle-config

A module containing Checkstyle Maven plugin configuration shared among Cogvio projects.

License

License

Categories

Categories

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

GroupId

com.cogvio
ArtifactId

ArtifactId

checkstyle-config
Last Version

Last Version

0.1
Release Date

Release Date

Type

Type

jar
Description

Description

com.cogvio:checkstyle-config
A module containing Checkstyle Maven plugin configuration shared among Cogvio projects.
Project URL

Project URL

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

Source Code Management

http://github.com/Cogvio/checkstyle-config/tree/master

Download checkstyle-config

How to add to project

<!-- https://jarcasting.com/artifacts/com.cogvio/checkstyle-config/ -->
<dependency>
    <groupId>com.cogvio</groupId>
    <artifactId>checkstyle-config</artifactId>
    <version>0.1</version>
</dependency>
// https://jarcasting.com/artifacts/com.cogvio/checkstyle-config/
implementation 'com.cogvio:checkstyle-config:0.1'
// https://jarcasting.com/artifacts/com.cogvio/checkstyle-config/
implementation ("com.cogvio:checkstyle-config:0.1")
'com.cogvio:checkstyle-config:jar:0.1'
<dependency org="com.cogvio" name="checkstyle-config" rev="0.1">
  <artifact name="checkstyle-config" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.cogvio', module='checkstyle-config', version='0.1')
)
libraryDependencies += "com.cogvio" % "checkstyle-config" % "0.1"
[com.cogvio/checkstyle-config "0.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.

Cogvio Checkstyle Config

Maven Central

Checkstyle plugin configuration shared among Cogvio projects.

Usage

setup the plugin in the <build><plugins> section

<plugin>
 <artifactId>maven-checkstyle-plugin</artifactId>
 <version>${maven-checkstyle-plugin.version}</version>
 <dependencies>
   <dependency>
     <groupId>com.cogvio</groupId>
     <artifactId>checkstyle-config</artifactId>
     <version>${cogvio-checkstyle.version}</version>
   </dependency>
   <dependency>
     <groupId>com.puppycrawl.tools</groupId>
     <artifactId>checkstyle</artifactId>
     <version>${checkstyle.version}</version>
   </dependency>
 </dependencies>
 <configuration>
   <configLocation>cogvio_checkstyle.xml</configLocation>
   <encoding>UTF-8</encoding>
   <consoleOutput>true</consoleOutput>
   <failOnViolation>true</failOnViolation>
   <violationSeverity>warning</violationSeverity>
   <includeTestSourceDirectory>true</includeTestSourceDirectory>
 </configuration>
 <executions>
   <execution>
     <id>validate</id>
     <phase>validate</phase>
     <goals>
       <goal>check</goal>
     </goals>
   </execution>
 </executions>
</plugin>

Suppressions

Optionally, you can create a checkstyle_suppressions.xml file in your project, ideally using this guide

<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
    <suppress files=".*[\\/]src[\\/]test[\\/]java[\\/].*" id="VisibilityModifierCode"/>
    <suppress files=".*[\\/]src[\\/]test[\\/]java[\\/].*" id="MagicNumberCode"/>
</suppressions>

and then specify the location using <suppressionsLocation> in above configuration.

com.cogvio

Cogvio

Versions

Version
0.1