[New] jsx-sort-props: support multiline prop groups

[duhamelgm]

Hello 👋

This PR Adds a new multiline group for the jsx-sort-props rule. Related to the issue: #3170

The shorthand and callback rules take precedence over the multiline rule set

[ljharb]

Rather than two mutually exclusive boolean props, this would be better as an enum value for "multiline" - ignore (default), first, or last, perhaps?

[duhamelgm]

We have a limitation with the current implementation here, whenever conflicting groups are in order between themselves, but in disorder with other props, only the group with higher hierarchy will be reported.

For example here we enabled { multiline: 'last', shorthandLast: true }, but only the shorthand prop is being reported as an error, since multiline thinks that it's in order.

I feel like there's no easy way to fix this unless we change the way in which jsx-sort-props checks and order the props, so that it check props by groups instead of the direct adjacent neighbors of each prop. I wouldn't mind working on that, but I feel like that's out of the scope of this PR...

[ljharb]

I agree; that sounds like a great improvement, but belongs in another PR.

[duhamelgm]

@ljharb I was able to work on the given feedback, now the property is an enum rather than two mutually exclusive props, and the tests are now expecting line numbers for each specific error. There was a little issue regarding how the shorthandFirst property gave its report so I changed that as well. Let me know what you think, and thanks for taking the time to look into this!

[ljharb]

I agree; that sounds like a great improvement, but belongs in another PR.

[ljharb]

Nicely done, and very thorough.

[codecov-commenter]

Codecov Report

Merging #3198 (f47deef) into master (cfb4d6b) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #3198   +/-   ##
=======================================
  Coverage   97.62%   97.63%           
=======================================
  Files         121      121           
  Lines        8381     8416   +35     
  Branches     3011     3025   +14     
=======================================
+ Hits         8182     8217   +35     
  Misses        199      199           

Impacted Files	Coverage Δ
lib/rules/jsx-sort-props.js	98.96% <100.00%> (+0.22%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cfb4d6b...f47deef. Read the comment docs.

[ljharb]

One more change, because node < 6 doesn't have array .includes :-)