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

grabofus · 2022-02-11T02:03:17Z

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 · 2022-02-11T02:03:19Z

☁️ 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

Sent with 💌 from NxCloud.

typescript-eslint · 2022-02-11T02:03:22Z

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 · 2022-02-11T02:03:26Z

❌ 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 · 2022-02-11T02:11:34Z

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 · 2022-02-11T06:51:11Z

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 · 2022-02-11T09:21:39Z

@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.

packages/eslint-plugin/tests/rules/member-ordering.test.ts

JoshuaKGoldberg

Great, thanks @grabofus!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.12.1` -> `5.13.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.12.1/5.13.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.12.1` -> `5.13.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.12.1/5.13.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.13.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5130-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5121v5130-2022-02-28) [Compare Source](typescript-eslint/typescript-eslint@v5.12.1...v5.13.0) ##### Bug Fixes - **eslint-plugin:** \[sort-type-union-intersection-members] Wrap the constructorType in parentheses ([#4590](typescript-eslint/typescript-eslint#4590)) ([851bb90](typescript-eslint/typescript-eslint@851bb90)) ##### Features - **eslint-plugin:** \[no-misused-promises] check more places for checksVoidReturn ([#4541](typescript-eslint/typescript-eslint#4541)) ([052cf51](typescript-eslint/typescript-eslint@052cf51)) - **eslint-plugin:** add `no-redundant-type-constituents` rule ([#4378](typescript-eslint/typescript-eslint#4378)) ([63d051e](typescript-eslint/typescript-eslint@63d051e)) - **eslint-plugin:** add `no-useless-empty-export` rule ([#4380](typescript-eslint/typescript-eslint#4380)) ([823b945](typescript-eslint/typescript-eslint@823b945)) - **eslint-plugin:** add extension rule `space-before-blocks` ([#1606](typescript-eslint/typescript-eslint#1606)) ([#4184](typescript-eslint/typescript-eslint#4184)) ([208b6d0](typescript-eslint/typescript-eslint@208b6d0)) - **eslint-plugin:** added member group support to member-ordering rule ([#4538](typescript-eslint/typescript-eslint#4538)) ([6afcaea](typescript-eslint/typescript-eslint@6afcaea)) #### [5.12.1](typescript-eslint/typescript-eslint@v5.12.0...v5.12.1) (2022-02-21) ##### Bug Fixes - **eslint-plugin:** \[no-unnecessary-type-arguments] fix comparison of types ([#4555](typescript-eslint/typescript-eslint#4555)) ([fc3936e](typescript-eslint/typescript-eslint@fc3936e)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.13.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5130-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5121v5130-2022-02-28) [Compare Source](typescript-eslint/typescript-eslint@v5.12.1...v5.13.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.12.1](typescript-eslint/typescript-eslint@v5.12.0...v5.12.1) (2022-02-21) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Renovate will not automatically rebase this PR, because other commits have been found. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Co-authored-by: 6543 <6543@noreply.codeberg.org> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1192 Reviewed-by: 6543 <6543@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

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

59a1655

bradzacher added the enhancement: plugin rule option New rule option for an existing eslint-plugin rule label Feb 11, 2022

Merge branch 'main' into feat/member-ordering-groups

59f96c5

JoshuaKGoldberg requested changes Feb 23, 2022

View reviewed changes

packages/eslint-plugin/tests/rules/member-ordering.test.ts Show resolved Hide resolved

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Feb 23, 2022

grabofus added 2 commits February 24, 2022 14:08

test(eslint-plugin): added more test cases for member-ordering

13a7c9b

test(eslint-plugin): added more test cases for member-ordering

7988384

JoshuaKGoldberg approved these changes Feb 24, 2022

View reviewed changes

Merge branch 'main' into feat/member-ordering-groups

df0de90

JoshuaKGoldberg merged commit 6afcaea into typescript-eslint:main Feb 24, 2022

github-actions bot locked as resolved and limited conversation to collaborators May 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

grabofus commented Feb 11, 2022 •

edited

Loading

nx-cloud bot commented Feb 11, 2022 •

edited

Loading

typescript-eslint bot commented Feb 11, 2022

netlify bot commented Feb 11, 2022 •

edited

Loading

codecov bot commented Feb 11, 2022 •

edited

Loading

splincode commented Feb 11, 2022

grabofus commented Feb 11, 2022 •

edited

Loading

JoshuaKGoldberg left a comment •

edited

Loading

JoshuaKGoldberg left a comment

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

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

Conversation

grabofus commented Feb 11, 2022 • edited Loading

PR Checklist

Overview

nx-cloud bot commented Feb 11, 2022 • edited Loading

☁️ Nx Cloud Report

typescript-eslint bot commented Feb 11, 2022

netlify bot commented Feb 11, 2022 • edited Loading

codecov bot commented Feb 11, 2022 • edited Loading

Codecov Report

splincode commented Feb 11, 2022

grabofus commented Feb 11, 2022 • edited Loading

JoshuaKGoldberg left a comment • edited Loading

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

grabofus commented Feb 11, 2022 •

edited

Loading

nx-cloud bot commented Feb 11, 2022 •

edited

Loading

netlify bot commented Feb 11, 2022 •

edited

Loading

codecov bot commented Feb 11, 2022 •

edited

Loading

grabofus commented Feb 11, 2022 •

edited

Loading

JoshuaKGoldberg left a comment •

edited

Loading