Add CodeLimit workflow

[robvanderleek]

Overview

Thanks for this wonderful project.
Are you open to include a simple code quality check in the automated build system?
I'm developing an open source tool called CodeLimit that monitors function length.
Still in active development, looking for any kind of feedback from the community.
The generated report for this codebase is attached below.

CodeLimit Report

Overview

Language	Files	Functions	Lines of Code	⚠	⛌
Java	889	4768	25769	23	0
JavaScript	2	22	35	0	0
Totals	891	4790	25804	23	0

Summary

Easy / Verbose	Hard-to-maintain ⚠	Unmaintainable ⛌
96%	4%	0%

✅ 96% of the functions are maintainable, no refactoring necessary.

Findings

Function	Length	File
⚠ assertLinesMatchWithFastForward	54	junit-jupiter-api/src/main/java/org/junit/jupiter/api/AssertLinesMatch.java
⚠ resolve	48	junit-platform-engine/src/main/java/org/junit/platform/engine/support/discovery/EngineDiscoveryRequestResolution.java
⚠ provideArguments	48	junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/EmptyArgumentsProvider.java
⚠ orderChildrenTestDescriptors	47	junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/discovery/AbstractOrderingVisitor.java
⚠ walk	46	junit-platform-engine/src/main/java/org/junit/platform/engine/support/hierarchical/NodeTreeWalker.java
⚠ nullSafeToString	42	junit-platform-commons/src/main/java/org/junit/platform/commons/util/StringUtils.java
⚠ isWideningConversion	42	junit-platform-commons/src/main/java/org/junit/platform/commons/util/ReflectionUtils.java
⚠ assertArrayElementsEqual	41	junit-jupiter-api/src/main/java/org/junit/jupiter/api/AssertArrayEquals.java
⚠ toStream	41	junit-platform-commons/src/main/java/org/junit/platform/commons/util/CollectionUtils.java
⚠ addTestSource	41	junit-platform-reporting/src/main/java/org/junit/platform/reporting/open/xml/OpenTestReportGeneratingListener.java

13 more rows

---

I hereby agree to the terms of the JUnit Contributor License Agreement.

---

[marcphilipp]

Thanks for the initiative and the PR! We'll discuss whether to adopt this in our next team call.

❌ apply 61 junit-platform-commons/src/main/java/org/junit/platform/commons/function/Try.java

@robvanderleek That is not actually a function body. Something seems to throw off your parser. 🤔

[marcphilipp]

Moreover, please rebase since I've improved SuiteLauncherDiscoveryRequestBuilder (based on your findings) on main in the meantime. 🙂

[robvanderleek]

Hi @marcphilipp

Thank you for taking the time to look into CodeLimit.
Also, encouraging to see that a finding from the tool could be used to improve the code 🙂

I've rebased the branch and updated the report (when the CodeLimit action runs inside the repository it will update the report automatically).
Now only 1 critical finding remains which is indeed a parse error from the tool, as you mentioned.

I'm currently using a parsing implementation that aims to be performant, robust, versatile (in terms of language support), but also accurate. I will look into the issue.

Again, thanks for the valuable feedback.

[robvanderleek]

Hi @marcphilipp

I've fixed the parse error and updated the report above.
There are no critical errors left, only 13 findings of methods that could become critical with further growth.

A CodeLimit badge for this repo would now look like this:

Background on the meaning of the badge can be found here in the documentation.