Skip to content

fix(eslint-plugin): [class-literal-property-style] allow getter when same key setter exists #8277

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 5 commits into from
Feb 2, 2024
Merged

fix(eslint-plugin): [class-literal-property-style] allow getter when same key setter exists #8277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9701126
fix(eslint-plugin): [class-literal-property-style] allow getter when …
yeonjuan Jan 20, 2024
b511b8a
apply review
yeonjuan Jan 29, 2024
dbf2f67
Update packages/eslint-plugin/tests/rules/class-literal-property-styl…
JoshuaKGoldberg Feb 1, 2024
58ced5a
Merge branch 'main' into fix#5961
bradzacher Feb 2, 2024
9af90d0
Merge branch 'main' into fix#5961
yeonjuan Feb 2, 2024
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
24 changes: 22 additions & 2 deletions packages/eslint-plugin/src/rules/class-literal-property-style.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';

import { createRule } from '../util';
import { createRule, getStaticStringValue } from '../util';

type Options = ['fields' | 'getters'];
type MessageIds =
Expand Down Expand Up @@ -66,6 +66,12 @@ export default createRule<Options, MessageIds>({
},
defaultOptions: ['fields'],
create(context, [style]) {
const sourceCode = getSourceCode(context);

function getMethodName(node: TSESTree.MethodDefinition): string {
return getStaticStringValue(node.key) ?? sourceCode.getText(node.key);
}

return {
...(style === 'fields' && {
MethodDefinition(node): void {
Expand All @@ -89,14 +95,28 @@ export default createRule<Options, MessageIds>({
return;
}

const name = getMethodName(node);

if (node.parent.type === AST_NODE_TYPES.ClassBody) {
const hasDuplicateKeySetter = node.parent.body.some(element => {
return (
element.type === AST_NODE_TYPES.MethodDefinition &&
element.kind === 'set' &&
getMethodName(element) === name
);
});
if (hasDuplicateKeySetter) {
return;
}
}

context.report({
node: node.key,
messageId: 'preferFieldStyle',
suggest: [
{
messageId: 'preferFieldStyleSuggestion',
fix(fixer): TSESLint.RuleFix {
const sourceCode = getSourceCode(context);
const name = sourceCode.getText(node.key);

let text = '';
Expand Down
42 changes: 42 additions & 0 deletions packages/eslint-plugin/tests/rules/class-literal-property-style.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,48 @@ abstract class Mx {
\`;
}
`,
`
class Mx {
set p1(val) {}
get p1() {
return '';
}
}
`,
`
let p1 = 'p1';
class Mx {
set [p1](val) {}
get [p1]() {
return '';
}
}
`,
`
let p1 = 'p1';
class Mx {
set [/* before set */ p1 /* after set */](val) {}
get [/* before get */ p1 /* after get */]() {
return '';
}
}
`,
`
class Mx {
set ['foo'](val) {}
get foo() {
return '';
}
set bar(val) {}
get ['bar']() {
return '';
}
set ['baz'](val) {}
get baz() {
return '';
}
}
`,
{
code: `
class Mx {
Expand Down