Skip to content

fix(eslint-plugin): [member-ordering] correctly invert optionalityOrder #6256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 20, 2022
Merged

fix(eslint-plugin): [member-ordering] correctly invert optionalityOrder #6256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/eslint-plugin/src/rules/member-ordering.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -781,7 +781,7 @@ export default util.createRule<Options, MessageIds>({
data: {
member: getMemberName(member, context.getSourceCode()),
optionalOrRequired:
optionalityOrder === 'optional-first' ? 'required' : 'optional',
optionalityOrder === 'required-first' ? 'required' : 'optional',
},
});

Expand All @@ -790,7 +790,7 @@ export default util.createRule<Options, MessageIds>({
// have the correct optionality
if (
isMemberOptional(members[0]) !==
(optionalityOrder === 'required-first')
(optionalityOrder === 'optional-first')
) {
report(members[0]);
return false;
Expand Down
52 changes: 28 additions & 24 deletions packages/eslint-plugin/tests/rules/member-ordering/member-ordering-optionalMembers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const ruleTester = new RuleTester({

const grouped: TSESLint.RunTests<MessageIds, Options> = {
valid: [
// optionalityOrder - optional-first
// optionalityOrder - required-first
{
code: `
interface X {
Expand All @@ -24,7 +24,7 @@ interface X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand All @@ -42,7 +42,7 @@ interface X {
default: {
memberTypes: 'never',
order: 'as-written',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand All @@ -60,7 +60,7 @@ interface X {
default: {
memberTypes: 'never',
order: 'as-written',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand All @@ -78,7 +78,7 @@ class X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand All @@ -96,7 +96,7 @@ class X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand All @@ -114,7 +114,7 @@ class X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand All @@ -132,7 +132,7 @@ class X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand All @@ -150,7 +150,7 @@ interface X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand All @@ -169,12 +169,12 @@ interface X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
},
// optionalityOrder - required-first
// optionalityOrder - optional-first
{
code: `
interface X {
Expand All @@ -188,7 +188,7 @@ interface X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'required-first',
optionalityOrder: 'optional-first',
},
},
],
Expand All @@ -206,7 +206,7 @@ interface X {
default: {
memberTypes: 'never',
order: 'as-written',
optionalityOrder: 'required-first',
optionalityOrder: 'optional-first',
},
},
],
Expand All @@ -224,7 +224,7 @@ interface X {
default: {
memberTypes: 'never',
order: 'as-written',
optionalityOrder: 'required-first',
optionalityOrder: 'optional-first',
},
},
],
Expand All @@ -242,13 +242,13 @@ class X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'required-first',
optionalityOrder: 'optional-first',
},
},
],
},
],
// optionalityOrder - optional-first
// optionalityOrder - required-first
invalid: [
{
code: `
Expand All @@ -263,12 +263,16 @@ interface X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
errors: [
{
data: {
member: 'b',
beforeMember: 'd',
},
messageId: 'incorrectOrder',
line: 5,
column: 3,
Expand All @@ -288,7 +292,7 @@ interface X {
default: {
memberTypes: ['call-signature', 'field', 'method'],
order: 'as-written',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand Down Expand Up @@ -317,7 +321,7 @@ class X {
default: {
memberTypes: 'never',
order: 'as-written',
optionalityOrder: 'optional-first',
optionalityOrder: 'required-first',
},
},
],
Expand All @@ -333,7 +337,7 @@ class X {
},
],
},
// optionalityOrder - required-first
// optionalityOrder - optional-first
{
code: `
interface X {
Expand All @@ -347,7 +351,7 @@ interface X {
default: {
memberTypes: 'never',
order: 'alphabetically',
optionalityOrder: 'required-first',
optionalityOrder: 'optional-first',
},
},
],
Expand All @@ -372,7 +376,7 @@ interface X {
default: {
memberTypes: ['call-signature', 'field', 'method'],
order: 'as-written',
optionalityOrder: 'required-first',
optionalityOrder: 'optional-first',
},
},
],
Expand Down Expand Up @@ -405,7 +409,7 @@ class Test {
default: {
memberTypes: 'never',
order: 'as-written',
optionalityOrder: 'required-first',
optionalityOrder: 'optional-first',
},
},
],
Expand Down Expand Up @@ -436,7 +440,7 @@ class Test {
default: {
memberTypes: 'never',
order: 'as-written',
optionalityOrder: 'required-first',
optionalityOrder: 'optional-first',
},
},
],
Expand Down