[Fix] jsx-sort-props: sorted attributes now respect comments

[ROSSROSALES]

Fixes #2366

Previously comments were not sorted with rule.
With fix, comments are included during sort.

Special Attribute Conditions:

• if comment found between two attributes, attributes and comment are sorted to end (to be manually sorted if necessary)
• above condition also applies to block comments
• single-line comments on same attribute-line are sorted

[codecov]

Codecov Report

Merging #3358 (e1a6f56) into master (1656707) will increase coverage by 0.01%.
The diff coverage is 100.00%.

❗ Current head e1a6f56 differs from pull request most recent head c14e209. Consider uploading reports for the commit c14e209 to get more accurate results

@@            Coverage Diff             @@
##           master    #3358      +/-   ##
==========================================
+ Coverage   97.54%   97.55%   +0.01%     
==========================================
  Files         123      123              
  Lines        8873     8918      +45     
  Branches     3244     3255      +11     
==========================================
+ Hits         8655     8700      +45     
  Misses        218      218              

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

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[ljharb]

Looks like there's older eslint versions where sourceCode.getCommentsAfter doesn't exist, so we'll need to handle that both in the rule, and in the test cases

[ROSSROSALES]

Thank you for the review!
I really appreciate your time. I have learned many of my own faults with redundant code, naming variables, and conditional statements. I hope in the future to improve and reduce these nuances.

[ROSSROSALES]

Looks like there's older eslint versions where sourceCode.getCommentsAfter doesn't exist, so we'll need to handle that both in the rule, and in the test cases

For this change:
Would we need to modify the code to identify which ESLint version is being used?
Then create another function using older deprecated methods of ESLint?

I am unsure other ways of handling errors for older ESLint versions.

[ROSSROSALES]

@ljharb
I decided to go with latter of "work with newer ESLint versions". Other useful methods have been deprecated as well and would throw same previous error.

After changes,
I am getting a new error:
AssertionError: Did not specify errors for an invalid test of jsx-sort-props

I tried to search issue online and through other rule using older ESLint, but I had no luck.
How is this error handled?

[ljharb]

The invalid list needs to be changed from an array, to a [].concat() call.

I'm thinking about whether or not we need an option for this, or whether it should be the default behavior. Either way, there aren't any tests for the commentbetween option - so, let's either add those, or remove the code handling that option?

[ROSSROSALES]

The invalid list needs to be changed from an array, to a [].concat() call.

I'm thinking about whether or not we need an option for this, or whether it should be the default behavior. Either way, there aren't any tests for the commentbetween option - so, let's either add those, or remove the code handling that option?

I created the commentbetween as an option defaulted to true because of how I initially understood sort((a, b) => contextCompare(a, b, options))) . I agree with you that it should be the default behaviour of the rule. I will make sure to edit and remove the option so that the default behaviour reflects it. Please let me know in the next pull request if I made appropriate changes.

[ljharb]

adding some lint fixes

[ROSSROSALES]

Thank you for reviewing the changes! @ljharb