Vfrdtyky

I'm trying to configure Checkstyle in the project. I've added:

    apply plugin: 'checkstyle'

    checkstyle {

        // assign the latest checkstyle version explicitly

        // default version is very old, likes 5.9

        toolVersion = '8.6'

        // checkstyle.xml copy from:

        // https://raw.githubusercontent.com/checkstyle/checkstyle/checkstyle-8.6/src/main/resources/google_checks.xml

        // the version should be as same as plugin version

        configFile = rootProject.file('config/checkstyle/checkstyle.xml')

    }

    task Checkstyle(type: Checkstyle) {

        source 'src/main/java'

        include '**/*.java'

        exclude '**/gen/**'

        exclude '**/R.java'

        exclude '**/BuildConfig.java'



        // empty classpath

        classpath = rootProject.files()

    }

to my root gradle file in allprojects.

But when I run ./gradlew checkstyle

I get:

* What went wrong:

Execution failed for task ':app:Checkstyle'.

> Unable to create Root Module: config {/Users/user/Development/project/config/checkstyle/checkstyle.xml}, classpath {null}.

Even the file with rules is located in specified dir.

I got this error when config/checkstyle/checkstyle.xml contained a reference to a non-existent file. In my case, via:

<module name="SuppressionFilter">

    <property name="file" value="config/checkstyle/checkstyle-suppressions.xml"/> <!-- Oops: No such file! -->

</module>

Creating the file config/checkstyle/checkstyle-suppressions.xml fixed the problem.

If it helps, its contents (with same header as checkstyle.xml) was:

<suppressions>

    <suppress files="/generated/" checks="w+"/>

    <suppress files="/test/" checks="w+"/>

</suppressions>

I was also having similar issue and same exception message. The following steps solved my problem:

Updated tool version to 8.16. Before I had 8.1
I used 'configDir' instead of 'configFile' property.

configDir = file("$rootProject.projectDir/etc/checkstyle")

Before it was:

configFile = file("$rootProject.projectDir/etc/checkstyle/checkstyle.xml")

Additionally, I had a 'reportDir' property which was also changed to point the directory instead of file.

reportsDir = file("$project.buildDir/reports/checkstyle")

Before it was:

reportsDir = file("$project.buildDir/reports/checkstyle/checkstyle.xml")

I am using JDK 11 and it worked with it.

This error happens whenever the config file could not be read. Are you sure you have a /Users/user/Development/project/config/checkstyle/checkstyle.xml file ?

I had a very similar problem, and I basically used the answer by @Bohemian. checkStyle could not find a file so I force-fed it waht it wanted. In my case, the root cause was that the gradle plugin for NetBeans does not propagate all "environment" variables correctly, so a reference to ${basedir}/config/checkstyle/import-control.xml failed. When checkStyle is running in NetBeans, ${basedir} is set to $USER_HOME, instead of the root of the project. As a workaround, I copied the required files into my home directory, and that allows checkStyle to run correctly.

Ugly, but better than nothing.

Problem was that it couldn't find rules file. So I changed:

configFile = rootProject.file('config/checkstyle/checkstyle.xml')

to:

configFile = file("${rootDir}/config/checkstyle/ckeckstyle.xml")

and now it pick up it correctly.

This happened to me when I updated Android Gradle Plugin to 3.3.0

Please run this:

./gradlew checkstyle --stacktrace

Probably you will need to check your checkstyle.xml config file.

I needed to move those two tags:

 <module name="SuppressionCommentFilter"/>



        <!--Enable usage SUPPRESS CHECKSTYLE comment-->

        <module name="SuppressWithNearbyCommentFilter">

            <property name="commentFormat" value="CHECKSTYLE IGNORE"/>

            <property name="checkFormat" value=".*"/>

            <property name="influenceFormat" value="0"/>

        </module>

inside

<module name="TreeWalker"> 

tag

Also I needed to remove:

<module name="SuppressionCommentFilter"/>

My problem was that this process was being run from a different directory than I thought it was.

Even though I checked to make sure the checkstyle.xml did indeed exist in the path that it showed, it still was breaking because my build process was failing to cd to the correct directory to run this!

Make sure you're running this from the place you think you are!