#86 Checkstyle

Author: oleg-cherednik

.editorconfig

@@ -10,3 +10,12 @@ trim_trailing_whitespace = true
 
 # noinspection EditorConfigKeyCorrectness
 continuation_indent_size = 8
+
+[{*.raml,*.yaml,*.yml}]
+indent_size = 2
+
+[{*.markdown,*.md}]
+indent_size = 2
+max_line_length = 120
+tab_width = 2
+ij_continuation_indent_size = 4

NOTICE

@@ -1,4 +1,4 @@
-gson-utils
+zip4jvm
 Copyright 2021 Oleg Cherednik (oleg.cherednik@gmail.com)
 
 This product includes software developed by

_config.yml

@@ -1,3 +1,6 @@
+import com.github.jk1.license.filter.LicenseBundleNormalizer
+import com.github.jk1.license.render.InventoryHtmlReportRenderer
+
 buildscript {
     repositories {
         mavenLocal()
@@ -8,8 +11,10 @@ buildscript {
 plugins {
     id 'jacoco'
     id 'java-library'
+    id 'io.freefair.lombok' version '8.4'
+
     id 'org.cadixdev.licenser' version '0.6.1'
-    id 'io.franzbecker.gradle-lombok' version '5.0.0'
+    id 'com.github.jk1.dependency-license-report' version '2.5'
     id 'com.github.ben-manes.versions' version '0.51.0'
 
     id 'signing'
@@ -25,13 +30,21 @@ repositories {
 group 'ru.oleg-cherednik.zip4jvm'
 version '1.11'
 
-sourceCompatibility = '1.8'
-targetCompatibility = '1.8'
+sourceCompatibility = JavaVersion.VERSION_1_8
+targetCompatibility = JavaVersion.VERSION_1_8
 
 tasks.withType(JavaCompile).configureEach {
     options.encoding = 'UTF-8'
+    options.compilerArgs += ['-Xlint:unchecked']
 }
 
+configurations {
+    jar.archiveFileName = "${rootProject.name}-${version}.jar"
+}
+
+apply from: "${projectDir}/gradle/checkstyle.gradle"
+apply from: "${projectDir}/gradle/pmd.gradle"
+
 dependencies {
     annotationProcessor "org.projectlombok:lombok:${property('lombok.version')}"
 
@@ -64,9 +77,16 @@ jacocoTestReport {
     }
 }
 
-check.dependsOn jacocoTestReport
+javadoc {
+    options.addBooleanOption('Xdoclint:-missing', true)
+}
+
+check.finalizedBy(checkLicense)
+check.finalizedBy(generateLicenseReport)
+check.finalizedBy(jacocoTestReport)
 
 test {
+    dependsOn('jar')
     useTestNG()
 }
 
@@ -76,6 +96,13 @@ license {
     newLine false
 }
 
+licenseReport {
+    configurations = ['compileClasspath', 'runtimeClasspath', 'testCompileClasspath', 'testRuntimeClasspath']
+    renderers = [new InventoryHtmlReportRenderer()]
+    allowedLicensesFile = new File("$projectDir/misc/license/allowed-licenses.json")
+    filters = [new LicenseBundleNormalizer(bundlePath: "$projectDir/misc/license/license-normalizer-bundle.json")]
+}
+
 signing {
     sign publishing.publications
 }

build.gradle

@@ -0,0 +1,21 @@
+apply plugin: 'checkstyle'
+
+checkstyle {
+    toolVersion = '10.10.0'
+    configFile = file("${projectDir}/misc/checkstyle/checkstyle.xml")
+    ignoreFailures = false
+    maxWarnings = 0
+    maxErrors = 0
+}
+
+checkstyleMain {
+    enabled = true
+    source = 'src/main/java'
+    group = 'static analysis'
+}
+
+checkstyleTest {
+    enabled = true
+    source = 'src/test/java'
+    group = 'static analysis'
+}

codecov.yml

@@ -0,0 +1,30 @@
+apply plugin: 'pmd'
+
+pmd {
+    toolVersion = '6.21.0'
+    consoleOutput = false
+    rulesMinimumPriority = 5
+    ignoreFailures = false
+    ruleSets = [
+            "${projectDir}/misc/pmd/bestpractices.xml",
+            "${projectDir}/misc/pmd/codestyle.xml",
+            "${projectDir}/misc/pmd/design.xml",
+            "${projectDir}/misc/pmd/errorprone.xml",
+            "${projectDir}/misc/pmd/multithreading.xml",
+            "${projectDir}/misc/pmd/performance.xml",
+            "${projectDir}/misc/pmd/security.xml"
+    ]
+}
+
+pmdMain {
+    enabled = true
+    source = 'src/main/java'
+    group = 'static analysis'
+}
+
+pmdTest {
+    dependsOn('jar')
+    enabled = true
+    source = 'src/test/java'
+    group = 'static analysis'
+}

gradle/checkstyle.gradle

@@ -0,0 +1,10 @@
+# https://projectlombok.org/features/configuration
+
+# configuration file is in the root of the workspace directory only
+config.stopBubbling = true
+# If true, lombok will generate a @java.beans.ConstructorProperties annotation when generating constructors.
+lombok.anyConstructor.addConstructorProperties=true
+# Do not use experimental annotations
+lombok.experimental.flagUsage=ERROR
+# Lombok marks generated code with @lombok.Generated, so JaCoCo can understand it
+lombok.addLombokGeneratedAnnotation = true