arkitect icon indicating copy to clipboard operation
arkitect copied to clipboard

Add CLI param to group output by rules

Open ricfio opened this issue 4 years ago • 7 comments

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

ricfio avatar Nov 11 '21 17:11 ricfio

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? :slightly_smiling_face:

fain182 avatar Nov 15 '21 09:11 fain182

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.

ricfio avatar Nov 15 '21 12:11 ricfio

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

micheleorselli avatar Nov 21 '21 10:11 micheleorselli

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.

ricfio avatar Nov 21 '21 11:11 ricfio

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 ?

AlessandroMinoccheri avatar Dec 02 '21 08:12 AlessandroMinoccheri

@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.

ricfio avatar Dec 02 '21 21:12 ricfio

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?

AlessandroMinoccheri avatar Dec 03 '21 07:12 AlessandroMinoccheri