[SPIKE] spotless or checkstyle

[fengyuanyang]

Background
Check coding style by using gradle check might be time consuming for users.
Need to import checkstyle.xml and execute gradle check.
Then check that html file and format corresponding files one by one.
We might consider another way to make code style consistent.

How
Spotless might be a good way
tor format the code (with the Gradle task spotlessApply)
Reference

Expect
If spotless is easier for users, remove checkstyle plugin and and import spotless

[januslinhc]

Checkstyle has plugins for IDEs like Intellij Idea and VSCode... And you actually dont need gradle for code style check when you are going to implement the code since there are many tools available. Gradle Code check is for CI only.

[fengyuanyang]

you prefer checkstyle? I how do you think?
Is there a proper way to avoid user commit a code without blocked in CI and need to commit another one just for formatting the style?

[fengyuanyang]

Just now there is one developer try to file a pr and is blocked in checkstyle here
https://github.com/fengyuanyang/JavaTDD/pull/40/checks?check_run_id=1254215471

[januslinhc]

you prefer checkstyle? I how do you think?
Is there a proper way to avoid user commit a code without blocked in CI and need to commit another one just for formatting the style?

That depends on your configuration in your build.gradle.
Currently, there is a rule that the contributors required to submit the code which meet Google style requirement in order to make the code in our repository consistent.
However, you can disable this restriction. (i.e. ignore the warnings)

checkstyle {
    toolVersion '8.36.2'
    ignoreFailures = false <<---
    maxWarnings = 0
}

[fengyuanyang]

Thanks @januslinhc , that's really helpful
Would you like to become one of the collaborators in this project? I saw that you are willing to review codes.
it would be great to have you here.

[fengyuanyang]

you prefer checkstyle? I how do you think?
Is there a proper way to avoid user commit a code without blocked in CI and need to commit another one just for formatting the style?

That depends on your configuration in your build.gradle.
Currently, there is a rule that the contributors required to submit the code which meet Google style requirement in order to make the code in our repository consistent.
However, you can disable this restriction. (i.e. ignore the warnings)

checkstyle {
    toolVersion '8.36.2'
    ignoreFailures = false <<---
    maxWarnings = 0
}

well, do you mind ignoring failures for now , i would like not to block user's pull request.
I mean, it's great for now to follow the style , but i don't mean to enforce them. I will they can enjoy writing tests.

[januslinhc]

you prefer checkstyle? I how do you think?
Is there a proper way to avoid user commit a code without blocked in CI and need to commit another one just for formatting the style?

That depends on your configuration in your build.gradle.
Currently, there is a rule that the contributors required to submit the code which meet Google style requirement in order to make the code in our repository consistent.
However, you can disable this restriction. (i.e. ignore the warnings)

checkstyle {
    toolVersion '8.36.2'
    ignoreFailures = false <<---
    maxWarnings = 0
}

well, do you mind ignoring failures for now , i would like not to block user's pull request.
I mean, it's great for now to follow the style , but i don't mean to enforce them. I will they can enjoy writing tests.

Sure, I will disable it.