Klaviyo's Java Checkstyle config based on Google's
Integrating Klaviyo's Checkstyle config into a gradle project is a little more involved, but can be accomplished with a custom task and defining that custom task as a dependency of the checkstyle task.
# gradle.properties
checkstyleXmlUrl=https://raw.githubusercontent.com/klaviyo/java-checkstyle/master/checkstyle.xml
checkstyleConfigDir=config/checkstyle
checkstyleLocalPath=config/checkstyle/checkstyle.xml
# NOTE: in theory the above 2 values for checkstyle dir/path are configurable,
# however they are here to document the default values because I was not
# able to get the checkstyle gradle plugin to accept any other values.// build.gradle
task lint(type: GradleBuild) {
tasks = ['getCheckstyle', 'checkstyleMain']
}
// NOTE: this line is required to make checkstyle not go crazy linting generated source files
checkstyleMain.source = "src/main/java"
task getCheckstyle {
doLast {
// check if the config dir was created yet
def checkstyleConfigDir = new File(checkstyleConfigDir)
if (!checkstyleConfigDir.exists() && !checkstyleConfigDir.mkdirs()) {
throw new StopActionException("failed to create directory ${checkstyleConfigDir}")
}
if (!checkstyleConfigDir.with { isDirectory() && canRead() && canExecute() }) {
throw new StopActionException("failed to access directory ${checkstyleConfigDir}")
}
// save the remote file down if it doesn't exist
def checkstyleConfig = new File(checkstyleLocalPath)
if (!checkstyleConfig.exists()) {
println "Downloading ${checkstyleXmlUrl}"
checkstyleConfig << new URL(checkstyleXmlUrl).getText()
}
}
}
tasks.checkstyleMain.dependsOn('getCheckstyle')
tasks.checkstyleTest.dependsOn('getCheckstyle')To integrate Klaviyo's Checkstyle configuration into a maven build, add the following to your project's pom.xml
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.0.0</version>
<configuration>
<configLocation>
https://raw.githubusercontent.com/klaviyo/java-checkstyle/master/checkstyle.xml
</configLocation>
</configuration>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>8.11</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>- Install the checkstyle plugin from the plugin browser or from github
- Once installed, open settings and navigate to
Other Settings>Checkstyle - Check
Treat Checkstyle errors as warningsso you can distinguish between actual java syntax errors and simple linting errors - Hit the plus button on the right side of the settings window to add a new configuration file and select file from HTTP. Make sure you use the raw content link, not the prettified HTML view link.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent