Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(eslint-plugin): add TSPropertySignature with TSFunctionType annotation to typeMethod selector #6645

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 4 commits into from
Mar 19, 2023
Merged

fix(eslint-plugin): add TSPropertySignature with TSFunctionType annotation to typeMethod selector #6645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
04086f2
fix(eslint-plugin): add TSPropertySignature with TSFunctionType annot…
kozlovvski Mar 15, 2023
e5c76a1
Merge branch 'main' into 6617-add-property-functions-to-typemethod-se…
Mar 16, 2023
c6bd3c3
Merge branch 'typescript-eslint:main' into 6617-add-property-function…
Mar 19, 2023
e9b1e70
add a test for typeProperty readonly modifier
kozlovvski Mar 19, 2023
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
34 changes: 20 additions & 14 deletions packages/eslint-plugin/src/rules/naming-convention.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,20 +394,21 @@ export default util.createRule<Options, MessageIds>({
},
},

'TSPropertySignature[computed = false]': {
validator: validators.typeProperty,
handler: (
node: TSESTree.TSPropertySignatureNonComputedName,
validator,
): void => {
const modifiers = new Set<Modifiers>([Modifiers.public]);
if (node.readonly) {
modifiers.add(Modifiers.readonly);
}
'TSPropertySignature[computed = false][typeAnnotation.typeAnnotation.type != "TSFunctionType"]':
Copy link
Contributor Author

@kozlovvski kozlovvski Mar 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if this typeAnnotation.typeAnnotation.type part should be moved to some variable. It is later used in L466 in typeMethod selector

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You know, we've been leaning away from using these fancier queries, and instead towards simpler, more readable ones. eslint-community/eslint-plugin-eslint-plugin#339

Not requesting changes here as we haven't taken action on that yet & this file already has a lot of complex queries. Just food for thought. 😄

{
validator: validators.typeProperty,
handler: (
node: TSESTree.TSPropertySignatureNonComputedName,
validator,
): void => {
const modifiers = new Set<Modifiers>([Modifiers.public]);
if (node.readonly) {
modifiers.add(Modifiers.readonly);
}

handleMember(validator, node, modifiers);
handleMember(validator, node, modifiers);
},
},
},

// #endregion property

Expand Down Expand Up @@ -460,10 +461,15 @@ export default util.createRule<Options, MessageIds>({
},
},

'TSMethodSignature[computed = false]': {
[[
'TSMethodSignature[computed = false]',
'TSPropertySignature[computed = false][typeAnnotation.typeAnnotation.type = "TSFunctionType"]',
].join(', ')]: {
validator: validators.typeMethod,
handler: (
node: TSESTree.TSMethodSignatureNonComputedName,
node:
| TSESTree.TSMethodSignatureNonComputedName
| TSESTree.TSPropertySignatureNonComputedName,
validator,
): void => {
const modifiers = new Set<Modifiers>([Modifiers.public]);
Expand Down
4 changes: 4 additions & 0 deletions packages/eslint-plugin/tests/rules/naming-convention/cases/method.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,12 @@ createTestCases([
code: [
'interface Ignored { %(): string }',
'interface Ignored { "%"(): string }',
'interface Ignored { %: () => string }',
'interface Ignored { "%": () => string }',
'type Ignored = { %(): string }',
'type Ignored = { "%"(): string }',
'type Ignored = { %: () => string }',
'type Ignored = { "%": () => string }',
],
options: {
selector: 'typeMethod',
Expand Down
40 changes: 40 additions & 0 deletions packages/eslint-plugin/tests/rules/naming-convention/naming-convention.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,46 @@ ruleTester.run('naming-convention', rule, {
{ selector: 'variable', format: ['camelCase'] },
],
},
// treat properties with function expressions as typeMethod
{
code: `
interface SOME_INTERFACE {
SomeMethod: () => void;

some_property: string;
}
`,
options: [
{
selector: 'default',
format: ['UPPER_CASE'],
},
{
selector: 'typeMethod',
format: ['PascalCase'],
},
{
selector: 'typeProperty',
format: ['snake_case'],
},
],
},
{
code: `
type Ignored = {
ignored_due_to_modifiers: string;
readonly FOO: string;
};
`,
parserOptions,
options: [
{
selector: 'typeProperty',
modifiers: ['readonly'],
format: ['UPPER_CASE'],
},
],
},
{
code: `
const camelCaseVar = 1;
Expand Down