[New] jsx-sort-props: add sortFirst option to explicitly specify prop names to sort first

[loderunner]

Fixes: #3175 #3639 #3193

Warning

I had to pin the ESLint version in the published types test project, as the ESLint types break with TypeScript 4.0 starting with ESLint 9.39.0. This can also be fixed by dropping support for TypeScript 4.0.

Let me know if I should remove 4.0 from the matrix instead.

Adds a sortFirst option to enforce that specified props appear first, in the given order. Takes precedence over other sorting options (reservedFirst, shorthandFirst, callbacksLast, multiline).

Examples:

// Configuration: { sortFirst: ['className', 'id'] }

// ❌ Incorrect
<Hello name="John" className="test" id="test" />

<Hello id="test" className="test" />

// ✅ Correct
<Hello className="test" id="test" name="John" />

// Configuration: { sortFirst: ['className'], ignoreCase: true }

// ❌ Incorrect  
<Hello name="John" classname="test" />

// ✅ Correct
<Hello classname="test" name="John" />

Props in sortFirst maintain their specified order relative to each other, and all appear before other props.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.84%. Comparing base (f2869fd) to head (cc1c24c).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3965   +/-   ##
=======================================
  Coverage   97.84%   97.84%           
=======================================
  Files         136      136           
  Lines       10008    10041   +33     
  Branches     3717     3732   +15     
=======================================
+ Hits         9792     9825   +33     
  Misses        216      216           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[loderunner]

Converting to draft PR while I address the CI issues.

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	eslint@​9.38.0

View full report

[loderunner]

Just realized this is likely a duplicate of #3853, opened almost exactly one year ago. 😅

[mesqueeb]

@ljharb Given the other PR #3853 is abandoned, can we move ahead with this one? 👼🏻