ER check examples, more descriptive configuration for `maxClassNameLen`

l3r8yJ / oop-cop

The static analysis tool and a Maven plugin that will help you model your objects, classes, methods properly by rejecting your non-perfect code.

https://www.l3r8y.ru/oop-cop/

MIT License

9 stars 5 forks source link

ER check examples, more descriptive configuration for `maxClassNameLen` #112

Closed h1alexbel closed 8 months ago

h1alexbel commented 8 months ago

@l3r8yJ take a look, please

PR-Codex overview

This PR focuses on making changes to the codebase related to mutable objects, parsers, validators, controllers, utility classes, and long class names.

Detailed summary

Updated the README.md file to fix formatting and provide information about mutable objects and how to suppress checks.
Made changes to the MyInvalidClass and MyValidClass classes.
Added examples of valid and invalid classes in the Parsers, Validators, Controllers section of the README.md file.
Updated the Utility classes section in the README.md file.
Added an example of a valid class with a long name in the README.md file and provided information on how to configure the maximal reasonable length.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

zoeself commented 8 months ago

@h1alexbel thank you for your Pull Request. I'll assign someone to review it soon.

If this PR solves a todo from the code, please don't forget to remove it.

codecov-commenter commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

:exclamation: No coverage uploaded for pull request base (master@b301169). Click here to learn what that means.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #112 +/- ## ========================================= Coverage ? 73.68% Complexity ? 61 ========================================= Files ? 16 Lines ? 190 Branches ? 3 ========================================= Hits ? 140 Misses ? 45 Partials ? 5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

zoeself commented 8 months ago

@l3r8yJ please review this Pull Request. Deadline (when it should be merged or closed) is 2024-01-06T07:20:06.419599.

You should check if the requirements have been implemented (partially or in full), if there are unit tests covering the changes and if the CI build passes. Feel free to reject the PR or ask for changes if it's too big or not clear enough.

Estimation here is 30 minutes, that's how much you will be paid. You will be paid even if this PR gets rejected.

h1alexbel commented 8 months ago

@l3r8yJ refined, take a look

l3r8yJ commented 8 months ago

@h1alexbel seems like codecov action has just broken for sometime, i'll rerun it a bit later

sonarcloud[bot] commented 8 months ago

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

l3r8yJ commented 8 months ago

@h1alexbel can you, please, also add a info about new suppressions?

h1alexbel commented 8 months ago

@l3r8yJ already added

zoeself commented 8 months ago

@l3r8yJ thank you for resolving this ticket. I've just added it to your active invoice. You can always check all your invoices and more on the Contributor Dashboard.