feat(eslint-plugin): added member group support to member-ordering rule

[grabofus]

PR Checklist

• Addresses an existing issue: fixes [member-ordering] migrating from v4.28.x to v5.1: how treat field, get and set equally #4038
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

This PR introduces member groupping support for the member-ordering rule. For example makes it possible to group fields, getters, and setters at the same rank.

Screen.Recording.2022-02-11.at.02.02.27.mov

Config used in video:

{
    default: {
        memberTypes: [
            // Fields
            'public-static-field',
            'public-field',
            'protected-static-field',
            'protected-field',
            'private-static-field',
            'private-field',
            // Constructors
            'public-constructor',
            'protected-constructor',
            'private-constructor',
            // Getters & Setters
            ['public-get', 'public-set'],
            ['protected-get', 'protected-set'],
            ['private-get', 'private-set'],
            // Index signatures
            'signature',
            // Methods
            'public-static-method',
            'public-method',
            'protected-static-method',
            'protected-method',
            'private-static-method',
            'private-method'
        ],
    order: 'alphabetically'
}

[nx-cloud]

☁️ Nx Cloud Report

CI ran the following commands for commit df0de90. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 48 targets

• Node 16.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 16.x - nx test @typescript-eslint/eslint-plugin
• Node 12.x - nx test @typescript-eslint/eslint-plugin-internal
• Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 12.x - nx test @typescript-eslint/eslint-plugin
• Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 12.x - nx test @typescript-eslint/eslint-plugin
• Node 14.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 14.x - nx test @typescript-eslint/eslint-plugin
• Node 12.x - nx run-many --target=typecheck --all --parallel
• Node 16.x - nx test @typescript-eslint/parser
• Node 16.x - nx test @typescript-eslint/type-utils
• Node 16.x - nx test @typescript-eslint/utils
• Node 16.x - nx test @typescript-eslint/scope-manager
• Node 16.x - nx test @typescript-eslint/visitor-keys
• Node 12.x - nx test @typescript-eslint/parser
• Node 16.x - nx test @typescript-eslint/typescript-estree
• Node 12.x - nx test @typescript-eslint/type-utils
• Node 12.x - nx test @typescript-eslint/utils
• Node 16.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx test @typescript-eslint/scope-manager
• Node 12.x - nx test @typescript-eslint/visitor-keys
• Node 12.x - nx test @typescript-eslint/typescript-estree
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx test @typescript-eslint/parser
• Node 12.x - nx test @typescript-eslint/type-utils
• Node 12.x - nx test @typescript-eslint/utils
• Node 12.x - nx test @typescript-eslint/scope-manager
• Node 14.x - nx test @typescript-eslint/parser
• Node 12.x - nx test @typescript-eslint/visitor-keys
• Node 14.x - nx test @typescript-eslint/type-utils
• Node 12.x - nx test @typescript-eslint/typescript-estree
• Node 14.x - nx test @typescript-eslint/utils
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14.x - nx test @typescript-eslint/scope-manager
• Node 14.x - nx test @typescript-eslint/visitor-keys
• Node 14.x - nx test @typescript-eslint/typescript-estree
• Node 14.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 16.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 14.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types

---

Sent with 💌 from NxCloud.

[typescript-eslint]

Thanks for the PR, @grabofus!

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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

[netlify]

❌ Deploy Preview for typescript-eslint failed.

🔨 Explore the source changes: df0de90

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/6217a81038963400073930d8

[codecov]

Codecov Report

Merging #4538 (df0de90) into main (823b945) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #4538      +/-   ##
==========================================
+ Coverage   94.62%   94.64%   +0.01%     
==========================================
  Files         149      150       +1     
  Lines        8072     8101      +29     
  Branches     2581     2589       +8     
==========================================
+ Hits         7638     7667      +29     
  Misses        239      239              
  Partials      195      195              

Flag	Coverage Δ
unittest	94.64% <100.00%> (+0.01%)	⬆️

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

Impacted Files	Coverage Δ
packages/eslint-plugin/src/configs/all.ts	100.00% <ø> (ø)
...ckages/eslint-plugin/src/util/getESLintCoreRule.ts	75.00% <ø> (ø)
...ackages/eslint-plugin/src/rules/member-ordering.ts	95.68% <100.00%> (+0.12%)	⬆️
...ges/eslint-plugin/src/rules/space-before-blocks.ts	100.00% <100.00%> (ø)

[splincode]

Please, add support decorated-get, decorated-set, so that you can write like this:

 // Index signature
  "signature",
  // Fields
  "decorated-field",
  "decorated-set",
  "field",
  // Constructors
  "constructor",
  // Getters and Setters at the same rank
  ["decorated-get", "get", "set"],
  // Methods
  "method"

we do this in angular projects

[grabofus]

@splincode that should already be supported by this PR. I didn't add explicit support for get / set. You can use any of the pre-existing member types in a group.

You config would result in this:

(There is another get / set pair above the constructor, just hidden by the popup)

[JoshuaKGoldberg]

Implementation looks great so far, thanks @grabofus!

Just requesting changes on getting a little more test coverage in.

[JoshuaKGoldberg]

Great, thanks @grabofus!