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.

Prathamesh Yadav

@creator-ehsaas

Hello! Prathamesh this side, I am newbie in Adv. Java but really interested to contribute in checkstyle in GSoC. It's my first time applying for GSoC. I have good exp with Python, MySQL, and HTML. Good Knowledge of Core Java, Swing, AWT, exception handling and oop.

1 reply

Shaluram71

@Shaluram71

Hey I am Shaalini Ramamoorthy and I have good experience in java and data structures. I stumbled upon a bunch of chats inquiring about GSOC while looking for information and have taken an interest in applying, so I was wondering how I can learn to contribute to check style as a beginner.

1 reply

Vishakhakumawat

@Vishakhakumawat

Hello vishakha this side I have good knowledge of basic Java .I am new newbie to open-source and I have just started using GitHub and Its my first time applying for checkstlye in gsoc .Can anyone tell me how to have start with the process !!

Roman Ivanov

@romani

To all new contributors, please read https://github.com/checkstyle/checkstyle/wiki/To-GSoC-participant and send Pull-request :)

Shubhra suman

@ShubhraSuman

Hi Shubhra here I have good knowledge of java, spring boot,git, Github, postman, Jenkins. I am currently new to open source field and wanted to contribute to project titled "Coverage of Documentation Comments Style Guide". Can you help me in starting off with it? How can I start my contributions. It will be really helpful. Thank you in advance!

Shubhra suman

@ShubhraSuman

Hi, I have cloned checkstyle repo but it is giving me some test case failure. What can be done.

4 replies

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.22.2:test (default-test) on project checkstyle: There are test failures.
[ERROR]
[ERROR] Please refer to /Users/shubhrasuman/Downloads/checkstyle/target/surefire-reports for the individual test results.
[ERROR] Please refer to dump files (if any exist) [date].dump, [date]-jvmRun[N].dump and [date].dumpstream.
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

Shubhra suman

@ShubhraSuman

AhmedHosny2

@AhmedHosny2

Hello! I am ahmed and I have good experience in java. It's my first time applying for check style in GSoC. I just need what is the requirements besides java basics to start contributing as I see some stuffs more than what I know

Roman Ivanov

@romani

Student need to prove that he/she can resolve issues , please try to fix checkstyle/checkstyle#11474

Read attentively https://github.com/checkstyle/checkstyle/wiki/To-GSoC-participant

Perin Mangukiya

@Perin-Mangukiya

Can someone help resolving this error?

[ERROR] JavadocPropertiesGeneratorTest.testNoInputSpecified:142 Unexpected error log
value of:
getCapturedData()
expected:
Missing required parameter: '<inputFile>'
Usage: java com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator [-hV]
--destfile=<outputFile> <inputFile>
<inputFile> The input file.
--destfile=<outputFile>
The output file.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.

but was:
Missing required parameter: '<inputFile>'
Usage: java com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator [-hV]
--destfile=<outputFile> <inputFile>
<inputFile> The input file.
--destfile=<outputFile>
The output file.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.

[ERROR] JavadocPropertiesGeneratorTest.testNonExistentArgument:112 Unexpected error log
value of:
getCapturedData()
expected:
▒inputFile>'
Usage: java com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator [-hV]
--destfile=<outputFile> <inputFile>
<inputFile> The input file.
--destfile=<outputFile>
The output file.
-h, --help Show this help message and exit.
-V, --version Print version i▒
but was:
▒inputFile>'
Usage: java com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator [-hV]
--destfile=<outputFile> <inputFile>
<inputFile> The input file.
--destfile=<outputFile>
The output file.
-h, --help Show this help message and exit.
-V, --version Print version i▒

3 replies

Roman Ivanov

@romani

You might run in Windows, please clone repo with https://github.com/checkstyle/checkstyle/blob/41f88055455c4adeedbb78578e9cff90194f1af2/appveyor.yml#L23 set before clone of repo

Shubhra suman

@ShubhraSuman

shubhrasuman@Shubhras-MacBook-Air checkstyle % git push --set-upstream origin MutableException-7613
Username for 'https://github.com': ShubhraSuman
Password for 'https://ShubhraSuman@github.com':
remote: Permission to checkstyle/checkstyle.git denied to ShubhraSuman.
fatal: unable to access 'https://github.com/checkstyle/checkstyle.git/': The requested URL returned error: 403

7 replies

When Trying to push I am getting this error

I have set upstream branch as checkstyle

Roman Ivanov

@romani

https://checkstyle.org/beginning_development.html @ShubhraSuman , please read this on how to collaborate in GitHub

1 reply

Perin Mangukiya

@Perin-Mangukiya

Can someone help resolving this error?
[ERROR] JavadocPropertiesGeneratorTest.testNoInputSpecified:142 Unexpected error log
value of:
getCapturedData()
expected:
Missing required parameter: '<inputFile>'
Usage: java com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator [-hV]
--destfile=<outputFile> <inputFile>
<inputFile> The input file.
--destfile=<outputFile>
The output file.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
but was:
Missing required parameter: '<inputFile>'
Usage: java com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator [-hV]
--destfile=<outputFile> <inputFile>
<inputFile> The input file.
--destfile=<outputFile>
The output file.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
[ERROR] JavadocPropertiesGeneratorTest.testNonExistentArgument:112 Unexpected error log
value of:
getCapturedData()
expected:
▒inputFile>'
Usage: java com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator [-hV]
--destfile=<outputFile> <inputFile>
<inputFile> The input file.
--destfile=<outputFile>
The output file.
-h, --help Show this help message and exit.
-V, --version Print version i▒
but was:
▒inputFile>'
Usage: java com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator [-hV]
--destfile=<outputFile> <inputFile>
<inputFile> The input file.
--destfile=<outputFile>
The output file.
-h, --help Show this help message and exit.
-V, --version Print version i▒

I cloned the project and ran mvn verify command, I encountered this error. I also deleted the files and cloned many times but still facing same problems.

Hussein Albader

@HusseinAlbader

Greetings

I've got notification from google about summerofcoding internship I'm studying software engineering at turkey and wondering what i have to do to apply for this opportunity cuz it could be a game changer for me

1 reply

Kevin222004

@Kevin222004

Hello everyone
2-3 days back my pc has been crashed and My os has been deleted I have reinstalled it.

to setup the project I am following
https://checkstyle.org/beginning_development.html

While running mvn install or in mvn clean verify it is giving error like this

4 replies

Shaman SR

@shaman_sr10:matrix.org

[m]

Hello Everyone. I'm Shaman SR and a newbie contributor. So I found this issue "#11474" which looked beginner friendly and after going through several links in that issue tab I felt overwhelmed didn't know what to do so can anyone please help me out.

2 replies

Shaman SR

@shaman_sr10:matrix.org

[m]

Sure, Thanks

Roman Ivanov

@romani

reminder for all that we will not review proposal if you did not fixed issues with labels "first gsoc issue", "second gsoc issue", "third gsoc issue", you still have plenty of time to do this.

Kevin222004

@Kevin222004

@romani I am intrested in 3 Projects should I make several proposal

4 replies

Roman Ivanov

@romani

Reminder to all: put in proposal link(s) to your PRs, to let bind your real name and your nick in Github, please do not think we can remember everyone and we can mach shorted name(nick) to your real name

Shaman SR

@shaman_sr10:matrix.org

[m]

[INFO] Running com.puppycrawl.tools.checkstyle.meta.MetadataGeneratorUtilTest
[ERROR] Tests run: 1, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 26.385 s <<< FAILURE! - in com.puppycrawl.tools.checkstyle.meta.MetadataGeneratorUtilTest
[ERROR] testMetadataFilesGenerationAllFiles{Capturable} Time elapsed: 26.384 s <<< FAILURE!
com.google.common.truth.AssertionErrorWithFacts:
Expected and actual errors do not match
value of : array.asList()

missing (1): 43: javadoc.missed.html.close

expected : [31: Description for 'AbstractSuperCheck' is missing., 43: javadoc.missed.html.close, 45: Description for 'AbstractHeaderCheck' is missing., 42: Description for 'AbstractJavadocCheck' is missing., 45: Description for 'AbstractClassCouplingCheck' is missing., 26: Description for 'AbstractAccessControlNameCheck' is missing., 30: Description for 'AbstractNameCheck' is missing., 30: Description for 'AbstractParenPadCheck' is missing.]
but was : [31: Description for 'AbstractSuperCheck' is missing., 45: Description for 'AbstractHeaderCheck' is missing., 42: Description for 'AbstractJavadocCheck' is missing., 45: Description for 'AbstractClassCouplingCheck' is missing., 26: Description for 'AbstractAccessControlNameCheck' is missing., 30: Description for 'AbstractNameCheck' is missing., 30: Description for 'AbstractParenPadCheck' is missing.]
at com.puppycrawl.tools.checkstyle.meta.MetadataGeneratorUtilTest.testMetadataFilesGenerationAllFiles(MetadataGeneratorUtilTest.java:100)

Got this error while compiling for issue number #7662. Please help

3 replies

Roman Ivanov

@romani

in your proposal , please put a link to all your PRs

Prem2357

@Prem2357

Hello Sir,
Most humbly, I would like to inform you that my name is Prem Vaishnav, and I reside at Bhopal, Madhya Pradesh.

I am writing this mail regarding the available opportunity for Participation On GSoC 2022. I am a student of Industrial and Production Engineering at Shri Govindram Seksaria Institute Of Technology and Science. I am willing to do contribute at your renowned company. I want to do work on Optimization of distance between methods in single Java class. I create proposal documentation file, where i share ?

2 replies

shubham shah

@Shubhamxshah

2 replies

need help! whys maven install showin this error

shubham shah

@Shubhamxshah

mvn clean verify showin this error even when i am in the correct directory containing pom.xml

5 replies

shubham shah

@Shubhamxshah

please temme how to solve this

Austin Brown

@atb-brown

https://github.com/checkstyle/checkstyle/blob/master/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/FileLengthCheck.java

I was toying around with the idea of having some sort of configuration for the FileLengthCheck that would allow certain lines to be ignored (for instance javadoc lines) for certain file types. My use case would be that the check would only count actual lines of code in my Java classes, but would ignore Javadocs/comments in that count which (I'm hoping) would encourage more documentation.

Would this go against the ethos of the FileLength check?

7 replies

Austin Brown

@atb-brown

https://github.com/checkstyle/checkstyle/blob/master/src/test/java/com/puppycrawl/tools/checkstyle/JavadocPropertiesGeneratorTest.java

I'm running into a weird issue with this test. When I run the tests in my IDE, it works fine. But when I run the test in my bash (I use git bash) via mvn clean verify it fails because the output/result has coloring, i.e. https://gist.github.com/vratiu/9780109#file-bash_aliases-L15

Above is an example in the bash where you can actually see the coloring (although it took a bit of troubleshooting to actually realize that the coloring was the issue by looking at the bytes in the result).

Has anyone encountered this and is there a workaround?

3 replies

Roman Ivanov

@romani

To all GSOC contributors, please keep sending PRs to increase your chances to be selected. No PRs after proposal is send is not bad sign for us on how you interested in project.

Roman Ivanov

@romani

thanks a lot to all contributors - https://checkstyle.org/releasenotes.html#Release_10.2