Rulebook

Third-party rules for JVM and Python lint tools, meant to be used in conjunction with official ones. Most of the rules are opinionated personal code styles. However, some already exists in other linters, providing the same experience across multiple languages.

View all rules

Download

Maven

repositories {
    mavenCentral()
}

dependencies {
    ktlint "com.hanggrian.rulebook:rulebook-ktlint:$version"
    checkstyle "com.hanggrian.rulebook:rulebook-checkstyle:$version"
    codenarc "com.hanggrian.rulebook:rulebook-codenarc:$version"
}

PyPI

pip install pylint regex rulebook-pylint

Usage

Ktlint

• Apply Ktlint Integration to Gradle project.
• Using configuration ktlint, add this project as dependency.

configurations {
    ktlint
}

dependencies {
    ktlint "com.hanggrian.rulebook:rulebook-ktlint:$libraryVersion"
}

// the rest of ktlint tasks' configuration

Checkstyle

• Apply Checkstyle Gradle Plugin.
• Using configuration checkstyle, add this project as dependency.
• Point to local config file or put in /config/checkstyle/codenarc.xml.

plugins {
    checkstyle
}

checkstyle {
    toolVersion "$checkstyleVersion"
    configFile "path/to/rulebook_checkstyle.xml"
}

dependencies {
    checkstyle "com.hanggrian.rulebook:rulebook-checkstyle:$libraryVersion"
}

CodeNarc

• Apply CodeNarc Gradle Plugin.
• Using configuration codenarc, add this project as dependency.
• Point to local config file or put in /config/codenarc/codenarc.xml.

plugins {
    codenarc
}

codenarc {
    toolVersion "$codenarcVersion"
    configFile "path/to/rulebook_codenarc.xml"
}

dependencies {
    codenarc "com.hanggrian.rulebook:rulebook-codenarc:$libraryVersion"
}

Pylint

• Point config file to local pylintrc.