Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CLI param to group output by rules #187

Open
ricfio opened this issue Nov 11, 2021 · 7 comments
Open

Add CLI param to group output by rules #187

ricfio opened this issue Nov 11, 2021 · 7 comments
Labels
enhancement New feature or request

Comments

@ricfio
Copy link
Contributor

ricfio commented Nov 11, 2021

Feature Request

Add CLI param to request output grouped by rules instead of by classes (actual default)

Q A
New Feature yes
RFC yes
BC Break no

Summary

Such as above

@AlessandroMinoccheri AlessandroMinoccheri added the enhancement New feature or request label Nov 11, 2021
@fain182
Copy link
Collaborator

fain182 commented Nov 15, 2021

I suppose that choose just one of the two ways would be better..
So, to understand the best option, why did you find more practical having the results grouped by rules? 🙂

@ricfio
Copy link
Contributor Author

ricfio commented Nov 15, 2021

By grouping by rules you can focus more quickly on resolving in your source code.
I think resolving by rules is more efficient than resolving by files because in this last case you would have to jump frequently from a rule context to another.

Also, I would like to use this approach as the default approach, but I think also that it's best give to the developers the option to switch to the file-by-file approach based on their preferences or needs at a specific time.

@micheleorselli
Copy link
Contributor

My 2cents: consistency with other tools in the PHP ecosystem is also important so I would check what other tools like psalm and deptrac do and stick to that

@ricfio
Copy link
Contributor Author

ricfio commented Nov 21, 2021

Thanks @micheleorselli, I think your suggestion is very acceptable, but in my head the reasoning was this:

When using PHPUnit you focus on class-by-class testing, so it's okay that the output is grouped by classes / test files, but when using PHPArkitect your focus is on the rules (for me it is) so should be more useful grouping by rules.

Also, I believe that in my very little experience with tools like psalm the approach is rightly the same of PHPUnit.

@AlessandroMinoccheri
Copy link
Member

Psalm, PHPUnit and deptrac I think that they don't allow you to group by rules instead of files. Have you ever tried those tools grouping by rules @ricfio ?

@ricfio
Copy link
Contributor Author

ricfio commented Dec 2, 2021

@AlessandroMinoccheri
It's true that the others tools does not grouping by rules, but its are focused on single classes/files instead on the whole application.

In my opinion PHKArkitect should be more focused on rules (involving the architecture of the whole application), so could be more useful grouping by rules instead that by files... or simply to have this option.

@AlessandroMinoccheri
Copy link
Member

In my opinion, it's better to have the list of files sorted by name because I can fix those in order.
But, do you wanna try to create a PR for this feature?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants