checkstyle/checkstyle

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. By default it supports the Google Java Style Guide and Sun Code Conventions, but is highly configurable. It can be invoked with an ANT task and a command line program.

Eugenio Romano

@eromano

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>${checkstyle-maven-plugin.version}</version>
        <executions>
          <execution>
            <id>validate</id>
            <phase>validate</phase>
            <goals>
              <goal>check</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <sourceDirectories>
            <sourceDirectory>activiti-api-impl</sourceDirectory>
          </sourceDirectories>
          <configLocation>./checkstyle.xml</configLocation>
          <encoding>UTF-8</encoding>
          <consoleOutput>true</consoleOutput>
          <failsOnError>true</failsOnError>
          <linkXRef>false</linkXRef>
        </configuration>
      </plugin>

    </plugins>
  </build>

  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>${checkstyle-maven-plugin.version}</version>
        <configuration>
          <configLocation>./checkstyle.xml</configLocation>
        </configuration>
      </plugin>
    </plugins>
  </reporting>

this is the conf I use and for what I got executions configured as I did should not even run checkstyle during install

Roman Ivanov

@romani

we need more details, and all versions, please create mail thread in our mail group

Eugenio Romano

@eromano

ok thanks I will do it

Roman Ivanov

@romani

https://groups.google.com/forum/#!forum/checkstyle

and please share all possible details

Eugenio Romano

@eromano

I will link the PR with the cahnge in the project so it's clear is an open source project

Roman Ivanov

@romani

and output of mvn -X ...

Eugenio Romano

@eromano

sure no problem

thanks

Eugenio Romano

@eromano

@romani thanks https://groups.google.com/forum/#!topic/checkstyle/hIKYuVWh8x4 I have created a post

matrixbot

@matrixbot

BuZZ-dEE hi is possible to convert an old checkstyle configuration / xml file to a new version if for example there breaking changes from the old one to the new one?

Roman Ivanov

@romani

I do know such tool

I do not know such tool

Roman Ivanov

@romani

We try to be accurate and clearly define bracking changes and provide migration notes in issues

From what version you are upgrading ?

Roman Ivanov

@romani

======
code freeze till I finish release 8.24

Roman Ivanov

@romani

Done

Mincong Huang

@mincong-h

Thank you @romani :raised_hands:

Mincong Huang

@mincong-h

Hi everyone, I would like to know if there is a check in Checkstyle which verifies the correctness of placeholders in String.formator any similar formatting method?

Here are 3 examples:

jshell> String.format("Hello, %s", "Checkstyle");
$1 ==> "Hello, Checkstyle"

jshell> String.format("Hello, %s", "check", "style");
$1 ==> "Hello, check"

jshell> String.format("Hello, %s");
|  Exception java.util.MissingFormatArgumentException: Format specifier 'Exception in thread "main" java.util.MissingFormatArgumentException: Format specifier '%s'
    at java.base/java.util.Formatter.format(Formatter.java:2672)
    at java.base/java.io.PrintStream.format(PrintStream.java:1053)
    at java.base/java.io.PrintStream.printf(PrintStream.java:949)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.error(JShellTool.java:728)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.errormsg(JShellTool.java:867)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.displayEvalException(JShellTool.java:3451)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.displayException(JShellTool.java:3425)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.displayException(JShellTool.java:3418)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.handleEvent(JShellTool.java:3582)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.processSource(JShellTool.java:3550)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.processSourceCatchingReset(JShellTool.java:1301)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.processInput(JShellTool.java:1203)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.run(JShellTool.java:1176)
    at jdk.jshell/jdk.internal.jshell.tool.JShellTool.start(JShellTool.java:975)
    at jdk.jshell/jdk.internal.jshell.tool.JShellToolBuilder.start(JShellToolBuilder.java:254)
    at jdk.jshell/jdk.internal.jshell.tool.JShellToolProvider.main(JShellToolProvider.java:120)

Roman Ivanov

@romani

there is no such Check

Mincong Huang

@mincong-h

Thank you, Roman.

sreejith-sjrs

@sreejith-sjrs

Hello All,
Newbie here, so please go easy on me. I have some binary source files which I do not want to fingerprint. Obviously UTF-8 encoding is not correct. I was wondering if there was a way to avoid such error messages.

[CheckStyle] [-ERROR-] Can't create fingerprints for some files:
[CheckStyle] [-ERROR-] - 'C:/Jenkins/workspace/example_master/Add.vi', provided encoding 'UTF-8' seems to be wrong

My analysis step in my pipeline looks like this:

recordIssues(
enabledForFailure: true, forensicsDisabled: true, unstableTotalAll: 1, healthy: 1, unhealthy: 10,
tools: [checkStyle(pattern: 'build_temp\VIA_results.xml', reportEncoding: 'UTF-8')]

Please help.

Thanks in advance.

rnveach

@rnveach

Unfortunately that error is not coming from main Checkstyle jar, so I don't know how to help you. You would have to look more into jenkins

sreejith-sjrs

@sreejith-sjrs

OK. Thanks very much for getting back to me. I will try to reach out Jenkins folks

Roman Ivanov

@romani

https://checkstyle.org/releasenotes.html#Release_8.25 - release is done

Roman Ivanov

@romani

code freeze till release 8.26 completed

Roman Ivanov

@romani

https://checkstyle.org/releasenotes.html#Release_8.26 - done, thanks a lot to all contributors

Chethan Prakash

@chethan

Hi, Is there any easy way to add custom checkstyle rules, to fail build for using specific classes

Roman Ivanov

@romani

While checkstyle/checkstyle#6481 is not done, no very easy way, but you are welcome to contribute such implementation

Pavel Bludov

@pbludov

Pitest is broken because I messed up the System.err and System.out when migrating to Junit5. Soon there will be a PR with a fix.

rnveach

@rnveach

happy holidays

Roman Ivanov

@romani

Merry Christmas !

Suchet-Agg

@Suchet-Agg

Hi, I am Suchet Aggarwal and am new to this organization and would like to contribute to this organization, can someone help me get started...

rnveach

@rnveach

@Suchet-Agg Read over https://checkstyle.org/beginning_development.html . You can pick any issue from our repository of things needing fixing. If you want us to assign you an issue we think will be good for beginners, let us know. You just need to say "I am on it" in the issue you are working on to let others know.

Praveen Kumar

@pkpale

Hi, I am Praveen Kumar I am new to the Github and want to contribute to this organization, can anyone suggest me something

rnveach

@rnveach

@pkpale Please look over https://checkstyle.org/beginning_development.html to see how to setup your environment for checkstyle. You are free to work on any approved issues, just say you are working on it so someone else doesn't take it from you.

Roman Ivanov

@romani

Please read https://checkstyle.org/beginning_development.html, try to follow such instructions , ones you succeed to compile and debug any UT, please let us know and we can offer you very easy issues to resolve

Ashish Papanai

@ashishpapanai

Hello @romani sir, I would like to know if you have any core java issues or issues that require basic to intermediate level of coding skills.

amritk07

@amritk07

Hello, @romani sir, I would like to participate in GSoc 2020. I am looking foreword to contribute in checkstyle/checkstyle#6689 project. I have gone through https://checkstyle.sourceforge.io/beginning_development.html. And currently i am working on it. So please guide me how to proceed. Thanks

rnveach

@rnveach

@amritk07 and to any GSOC students. Please read over https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020 . As we were just accepted yesterday, we are working to identify issues to help get your "feet wet" when being introduced to the Checkstyle project. If you need an admin to assign you an issue, please each out to me or @romani . Questions or help on a specific issue should be asked inside the issue or PR.

HAIDER

@haider_aabbas_twitter

Hi! My name is Haider. I would like to contribute to checkstyle and become part of this awesome open source community.

@rnveach Please guide me through and assign an issue. I would love to work.

Ashish Papanai

@ashishpapanai

@rnveach @romani Sir, Please assign me an issue to work on.

Roman Ivanov

@romani

@ashishpapanai , please try checkstyle/checkstyle#5982 , if you agree please do comment " I am on it" to let others know that you are working on it

Where communities thrive

People

Repo info

Activity