Skip to content

Latest commit

 

History

History
107 lines (75 loc) · 3.8 KB

README.md

File metadata and controls

107 lines (75 loc) · 3.8 KB
Raw

Public AW-Code-Standards

At AnywhereWorks, we believe that having good, automated quality checks of our code helps us work faster, more efficiently, and with less errors. This public (as in public to the entire world) repository contains AnywhereWorks' configuration for eslint and other code quality tools. To apply these standards to your own code, see the links to the instructions below.

Below are the instructions for configuring the Java Style Guide tools:

Java Style Guide

For Code Formatting:

Java: Google-Java-Format

Note: This plugin will be helpful to auto fix most of the CheckStyle warnings. But remember this will modify every line, So I hope you aware that will lead to more conflicts for the team uses multiple git branches. Recommend to plan well before using this formattor.

For Static Code Analysis:

We think this plugin covers most of our minimal expectation on code style and static code analysis.

https://plugins.gradle.org/plugin/com.monits.staticCodeAnalysis

Static Code Analysis wraps around Checkstyle, Findbugs, PMD and CPD(Copy/Paste Detector is an add-on to PMD), offering new features and extensions to the encapsulated plugins, making it easier to use them and providing better results with minimum effort.

XML Configurations:

Note: FindBugs is revamped as SpotBugs, so we'll be migrating in future to avail new updates.

build.gradle Gradle Config:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "com.monits:static-code-analysis-plugin:2.6.10"
  }
}

apply plugin: "com.monits.staticCodeAnalysis"


tasks.withType(FindBugs) {
    reports {
        xml.enabled = false
        html.enabled = true
    }
}

staticCodeAnalysis {
    findbugsExclude = "https://raw.githubusercontent.com/Adaptavant/AW-Code-Standards/master/java/config/v0.0.1/findbugs/excludeFilter-main.xml"
    checkstyleRules = "https://raw.githubusercontent.com/Adaptavant/AW-Code-Standards/master/java/config/v0.0.1/checkstyle/checkstyle-main.xml"
    pmdRules = ["https://raw.githubusercontent.com/Adaptavant/AW-Code-Standards/master/java/config/v0.0.1/pmd/pmd-main-pmd-6.xml"]
}

In case of Your using Gradle 5 :

plugins {
  id "com.monits.staticCodeAnalysis" version "2.6.10"
}

The plugin will add the task to run each analyser individually and also hooked to be run as part of the check task of the Java Plugin.

Run "gradle check" from the root of the project to run the analyzers:

$ gradle check

To execute individual plugins, type gradle tasks --all to see all possible tasks. Here are examples of individual code quality tasks:

checkstyle
checkstyleMain - Run Checkstyle analysis for main classes
checkstyleTest - Run Checkstyle analysis for test classes

cpd

findbugs
findbugsMain - Run FindBugs analysis for main classes
findbugsTest - Run FindBugs analysis for test classes
pmd
pmdMain - Run PMD analysis for main classes
pmdTest - Run PMD analysis for test classes

For instance, to run only the cpd plugin, you would type:

$ gradle cpd   # replace cpd with any of the above tasks.