Skip to content
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.

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

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

Conversation

kozlovvski
Copy link
Contributor

PR Checklist

Overview

Playground like with the reproduces issue

Issue summary
Currently the typeMethod selector in naming-convention rule options isn't applied to foo: () => void syntax. Instead it is caught by typeProperty selector.

What is changed
Only the naming-convention.ts file + related tests.

How the code works:
Instead of treating every TSPropertySignature as typeProperty selector, nodes with typeAnnotation.typeAnnotation.type equaling TSFunctionType are matched by typeMethod selector.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @kozlovvski!

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.

@netlify
Copy link

netlify bot commented Mar 15, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit e9b1e70
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6416f5eb63cd9b000807bab9
😎 Deploy Preview https://deploy-preview-6645--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

if (node.readonly) {
modifiers.add(Modifiers.readonly);
}
'TSPropertySignature[computed = false][typeAnnotation.typeAnnotation.type != "TSFunctionType"]':
Copy link
Contributor Author

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

@codecov
Copy link

codecov bot commented Mar 15, 2023

Codecov Report

Merging #6645 (e9b1e70) into main (59a5447) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6645      +/-   ##
==========================================
+ Coverage   85.16%   85.17%   +0.01%     
==========================================
  Files         383      383              
  Lines       13033    13033              
  Branches     3840     3840              
==========================================
+ Hits        11099    11101       +2     
+ Misses       1572     1570       -2     
  Partials      362      362              
Flag Coverage Δ
unittest 85.17% <100.00%> (+0.01%) ⬆️

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

Impacted Files Coverage Δ
...kages/eslint-plugin/src/rules/naming-convention.ts 90.15% <100.00%> (+1.03%) ⬆️

@bradzacher bradzacher added the bug Something isn't working label Mar 15, 2023
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Thus the complexity of naming-convention.ts continues its perpetual march towards infinity.

Thanks for this @kozlovvski, looks good! ✨

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Whoops, sorry for the fakeout - one untested line away from approval!

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

💯 thanks!

@JoshuaKGoldberg JoshuaKGoldberg merged commit 3fc5c63 into typescript-eslint:main Mar 19, 2023
40 checks passed
hasparus pushed a commit to hasparus/typescript-eslint that referenced this pull request Mar 22, 2023
…ation to typeMethod selector (typescript-eslint#6645)

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

* add a test for typeProperty readonly modifier

---------

Co-authored-by: Michał Kozłowski <michal.kozlowski@start-up.house>
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Mar 24, 2023
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.54.0` -> `5.56.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.54.0/5.56.0) |
| [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.54.0` -> `5.56.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.54.0/5.56.0) |

---

### Release Notes

<details>
<summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/eslint-plugin)</summary>

### [`v5.56.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5560-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5550v5560-2023-03-20)

[Compare Source](typescript-eslint/typescript-eslint@v5.55.0...v5.56.0)

##### Bug Fixes

-   **eslint-plugin:** \[member-ordering] check order when optionalityOrder is present with no optional members ([#&#8203;6619](typescript-eslint/typescript-eslint#6619)) ([6aff431](typescript-eslint/typescript-eslint@6aff431))
-   **eslint-plugin:** \[no-misused-promises] avoid unnecessary calls to getContextualType ([#&#8203;6193](typescript-eslint/typescript-eslint#6193)) ([745cfe4](typescript-eslint/typescript-eslint@745cfe4))
-   **eslint-plugin:** \[no-misused-promises] fix incorrect detection of void functions in JSX attributes ([#&#8203;6638](typescript-eslint/typescript-eslint#6638)) ([9e41cee](typescript-eslint/typescript-eslint@9e41cee))
-   **eslint-plugin:** \[strict-boolean-expression] support falsy and truthy literals simultaneously ([#&#8203;6672](typescript-eslint/typescript-eslint#6672)) ([62ef487](typescript-eslint/typescript-eslint@62ef487))
-   **eslint-plugin:** \[strict-boolean-expressions] handle truthy enums ([#&#8203;6618](typescript-eslint/typescript-eslint#6618)) ([0d0639f](typescript-eslint/typescript-eslint@0d0639f))
-   **eslint-plugin:** add TSPropertySignature with TSFunctionType annotation to typeMethod selector ([#&#8203;6645](typescript-eslint/typescript-eslint#6645)) ([3fc5c63](typescript-eslint/typescript-eslint@3fc5c63))

##### Features

-   **eslint-plugin:** add allowNever support to restrict-template-expressions ([#&#8203;6554](typescript-eslint/typescript-eslint#6554)) ([423f164](typescript-eslint/typescript-eslint@423f164))

### [`v5.55.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5550-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5541v5550-2023-03-13)

[Compare Source](typescript-eslint/typescript-eslint@v5.54.1...v5.55.0)

##### Bug Fixes

-   **eslint-plugin:** \[no-confusing-void-expression] check sequence expressions for void is in last position ([#&#8203;6597](typescript-eslint/typescript-eslint#6597)) ([d73d7d3](typescript-eslint/typescript-eslint@d73d7d3))
-   **eslint-plugin:** \[no-unnecessary-boolean-literal-compare] fixer should handle parentheses ([#&#8203;6569](typescript-eslint/typescript-eslint#6569)) ([2d8c196](typescript-eslint/typescript-eslint@2d8c196))

##### Features

-   **eslint-plugin:** \[lines-around-comment] add extension rule ([#&#8203;5327](typescript-eslint/typescript-eslint#5327)) ([d55211c](typescript-eslint/typescript-eslint@d55211c))
-   **eslint-plugin:** \[member-ordering] add support for grouping readonly fields ([#&#8203;6349](typescript-eslint/typescript-eslint#6349)) ([9d3bdfc](typescript-eslint/typescript-eslint@9d3bdfc))
-   **eslint-plugin:** \[no-unnecessary-cond] check logical assignments ([#&#8203;6594](typescript-eslint/typescript-eslint#6594)) ([dbc203a](typescript-eslint/typescript-eslint@dbc203a))
-   update TypeScript to 5.0 RC ([#&#8203;6570](typescript-eslint/typescript-eslint#6570)) ([36ef0e1](typescript-eslint/typescript-eslint@36ef0e1))
-   use [@&#8203;eslint-community](https://github.com/eslint-community) dependencies ([#&#8203;6603](typescript-eslint/typescript-eslint#6603)) ([5f6ed73](typescript-eslint/typescript-eslint@5f6ed73))

#### [5.54.1](typescript-eslint/typescript-eslint@v5.54.0...v5.54.1) (2023-03-06)

**Note:** Version bump only for package [@&#8203;typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin)

### [`v5.54.1`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5541-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5540v5541-2023-03-06)

[Compare Source](typescript-eslint/typescript-eslint@v5.54.0...v5.54.1)

**Note:** Version bump only for package [@&#8203;typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin)

</details>

<details>
<summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>

### [`v5.56.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5560-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5550v5560-2023-03-20)

[Compare Source](typescript-eslint/typescript-eslint@v5.55.0...v5.56.0)

**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)

### [`v5.55.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5550-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5541v5550-2023-03-13)

[Compare Source](typescript-eslint/typescript-eslint@v5.54.1...v5.55.0)

##### Features

-   **parser:** add exported meta object ([#&#8203;6586](typescript-eslint/typescript-eslint#6586)) ([d05c3d8](typescript-eslint/typescript-eslint@d05c3d8))

#### [5.54.1](typescript-eslint/typescript-eslint@v5.54.0...v5.54.1) (2023-03-06)

**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)

### [`v5.54.1`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5541-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5540v5541-2023-03-06)

[Compare Source](typescript-eslint/typescript-eslint@v5.54.0...v5.54.1)

**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNTcuMSIsInVwZGF0ZWRJblZlciI6IjM1LjE0LjEifQ==-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1811
Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [naming-convention] typeMethod selector doesn't support function expressions
3 participants