feat(eslint-plugin): [member-ordering] add a required option for required vs. optional member ordering

[asdf93074]

PR Checklist

• Addresses an existing open issue: fixes Enhancement: [member-ordering] Port requiredFirst from eslint-plugin-typescript-sort-keys #5596
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Added a new property required to SortedOrderConfig.
Added a corresponding error message id for when a rule fails because of required being set to 'first' or 'last'.

If required is 'first', then before any sorting/grouping configurations, we ensure that the members array has all its required items first and all optional items afterwards. Afterwards, we perform the remaining sorting/grouping checks on the required subset and the optional subset.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 17c0595. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 47 targets

• Node 18 - nx test @typescript-eslint/eslint-plugin
• Node 14 - nx test @typescript-eslint/eslint-plugin --coverage=false
• Node 18 - nx test @typescript-eslint/typescript-estree
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/type-utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/utils --coverage=false
• Node 18 - nx test @typescript-eslint/scope-manager
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/visitor-keys
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=typecheck --all --parallel
• Node 14 - nx test @typescript-eslint/parser --coverage=false
• Node 14 - nx test @typescript-eslint/visitor-keys --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 18 - nx test @typescript-eslint/ast-spec
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/eslint-plugin-tslint --coverage=false
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=lint --all --parallel
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/parser
• Node 18 - nx test @typescript-eslint/eslint-plugin-internal
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/typescript-estree --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/scope-manager --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/type-utils --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website

---

Sent with 💌 from NxCloud.

[typescript-eslint]

Thanks for the PR, @asdf93074!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	17c0595
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6384d886051118000832fa09
😎 Deploy Preview	https://deploy-preview-5965--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[codecov]

Codecov Report

Merging #5965 (17c0595) into main (becd1f8) will increase coverage by 0.02%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5965      +/-   ##
==========================================
+ Coverage   91.24%   91.27%   +0.02%     
==========================================
  Files         366      366              
  Lines       12380    12417      +37     
  Branches     3621     3631      +10     
==========================================
+ Hits        11296    11333      +37     
  Misses        774      774              
  Partials      310      310              

Flag	Coverage Δ
unittest	91.27% <100.00%> (+0.02%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ackages/eslint-plugin/src/rules/member-ordering.ts	96.13% <100.00%> (+0.73%)	⬆️
packages/eslint-plugin/src/util/misc.ts	96.87% <100.00%> (+0.44%)	⬆️

[JoshuaKGoldberg]

Thanks for sending this in @asdf93074! I'm excited to get this feature in. 🎉

There's a lot of changed code in this PR and the member-ordering rule is already a lot of lines. We should be able to trim the changes down a bit to be easier to read & review. I can take a deeper look once the refactors are done. Let me know if anything's unclear or not right!

[JoshuaKGoldberg]

Thanks for making the changes @asdf93074! I actually personally find this a good deal easier to read, but maybe that's just my personal preference. If another maintainer wants to weigh in that'd be good too 😄 - I'm nervous about stomping over perfectly good code. (and to be fair, yours did work quite well before too!)

Just requesting changes on a bit more testing. Otherwise this looks good to me!

[JoshuaKGoldberg]

Fantastic, this is looking great. Thanks for sending this in and iterating on it with me @asdf93074! 🙌

[JoshuaKGoldberg]

I'll leave this open for a bit in case another maintainer wants to poke at it or suggest an alternative API name (which we can apply ourselves if you don't want to keep receiving extra work because of our indecision 😅). But I've set a reminder to merge it this weekend if nobody requests changes, so it'll be available in our next stable version.

Edit: see #5965 (comment), will go on Monday!

[JoshuaKGoldberg]

🙌