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

feat(eslint-plugin): [parameter-properties] add rule to replace no-parameter-properties #4622

Merged

Conversation

JoshuaKGoldberg
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg commented Mar 1, 2022

PR Checklist

Overview

Adds a prefer option to the rule that defaults to "class-properties" but can be switched to "parameter-properties". In "parameter-properties" mode, the rule will issue a report when:

  • A class property and constructor parameter have the same name and type
  • The constructor parameter is assigned to the class property at the beginning of the constructor

I would have loved to use the type checker to determine whether the types are the same, but microsoft/TypeScript#9879.

@JoshuaKGoldberg JoshuaKGoldberg added DO NOT MERGE PRs which should not be merged yet breaking change This change will require a new major version to be released labels Mar 1, 2022
@nx-cloud
Copy link

nx-cloud bot commented Mar 1, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit d234ad2. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


Successfully ran 43 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

typescript-eslint bot commented Mar 1, 2022

Thanks for the PR, @JoshuaKGoldberg!

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
Copy link

netlify bot commented Mar 1, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit d234ad2
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6255f4d0dadecf0008ff577c
😎 Deploy Preview https://deploy-preview-4622--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.

@codecov
Copy link

codecov bot commented Mar 3, 2022

Codecov Report

Merging #4622 (d234ad2) into main (18a81cb) will increase coverage by 0.30%.
The diff coverage is 94.11%.

@@            Coverage Diff             @@
##             main    #4622      +/-   ##
==========================================
+ Coverage   93.96%   94.26%   +0.30%     
==========================================
  Files         172      152      -20     
  Lines        9818     8271    -1547     
  Branches     3105     2690     -415     
==========================================
- Hits         9225     7797    -1428     
+ Misses        353      263      -90     
+ Partials      240      211      -29     
Flag Coverage Δ
unittest 94.26% <94.11%> (+0.30%) ⬆️

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% <ø> (ø)
...eslint-plugin/src/rules/no-parameter-properties.ts 94.11% <ø> (ø)
...es/eslint-plugin/src/rules/parameter-properties.ts 94.11% <94.11%> (ø)
...ges/typescript-estree/src/create-program/shared.ts
...lugin-internal/src/rules/plugin-test-formatting.ts
...pt-estree/src/create-program/createWatchProgram.ts
...internal/src/rules/no-typescript-default-import.ts
...t-estree/src/create-program/useProvidedPrograms.ts
...estree/src/create-program/createIsolatedProgram.ts
packages/typescript-estree/src/node-utils.ts
... and 14 more

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review Mar 5, 2022
@JoshuaKGoldberg JoshuaKGoldberg added enhancement: plugin rule option New rule option for an existing eslint-plugin rule and removed DO NOT MERGE PRs which should not be merged yet labels Mar 5, 2022
@bradzacher bradzacher added this to the 6.0.0 milestone Mar 7, 2022
@JoshuaKGoldberg JoshuaKGoldberg requested a review from bradzacher Mar 8, 2022
@JoshuaKGoldberg JoshuaKGoldberg requested review from bradzacher and removed request for bradzacher Mar 26, 2022
@bradzacher
Copy link
Member

bradzacher commented Mar 29, 2022

This isn't specifically breaking, is it because you have just deprecated the old rule?

@JoshuaKGoldberg
Copy link
Contributor Author

JoshuaKGoldberg commented Mar 29, 2022

This might just be me not knowing what is or isn't breaking 😄 -- is it not breaking to rename a rule in the recommended set?

@bradzacher
Copy link
Member

bradzacher commented Mar 29, 2022

Changing the recommended set - yes - but these rules aren't recommended!

@JoshuaKGoldberg
Copy link
Contributor Author

JoshuaKGoldberg commented Mar 29, 2022

Oh! Yes, you're totally right - thank you :)

@JoshuaKGoldberg JoshuaKGoldberg removed the breaking change This change will require a new major version to be released label Mar 29, 2022
}
},

'MethodDefinition[kind="constructor"]'(
Copy link
Member

@bradzacher bradzacher Apr 8, 2022

Choose a reason for hiding this comment

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

side note: we should add these sorts of things to our types so that we don't need to annotate manually every time.

Copy link
Contributor Author

@JoshuaKGoldberg JoshuaKGoldberg Apr 12, 2022

Choose a reason for hiding this comment

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

Yes! I'd love to tackle #4065 once I have ... much more time 😄

@bradzacher bradzacher removed this from the 6.0.0 milestone Apr 8, 2022
@JoshuaKGoldberg JoshuaKGoldberg requested a review from bradzacher Apr 12, 2022
Copy link
Member

@bradzacher bradzacher left a comment

this is great!

@bradzacher bradzacher changed the title feat(eslint-plugin): allow 'prefer' in renamed parameter-properties rule feat(eslint-plugin): [parameter-properties] add rule to replace no-parameter-properties Apr 22, 2022
@bradzacher bradzacher merged commit 88ed9ec into typescript-eslint:main Apr 22, 2022
18 checks passed
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this issue May 1, 2022
This PR contains the following updates:

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

---

### Release Notes

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

### [`v5.21.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5210-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5200v5210-2022-04-25)

[Compare Source](typescript-eslint/typescript-eslint@v5.20.0...v5.21.0)

##### Bug Fixes

-   **eslint-plugin:** \[no-misused-promises] prioritize false returns when checking whether a function returns only void ([#&#8203;4841](typescript-eslint/typescript-eslint#4841)) ([ccadb60](typescript-eslint/typescript-eslint@ccadb60))
-   **eslint-plugin:** \[no-namespace] fix false positive for exported namespaces when allowDeclarations=true ([#&#8203;4844](typescript-eslint/typescript-eslint#4844)) ([4e7c9be](typescript-eslint/typescript-eslint@4e7c9be))
-   **eslint-plugin:** \[space-infix-ops] fix no error when right type is function ([#&#8203;4848](typescript-eslint/typescript-eslint#4848)) ([d74d559](typescript-eslint/typescript-eslint@d74d559))

##### Features

-   **eslint-plugin:** \[parameter-properties] add rule to replace `no-parameter-properties` ([#&#8203;4622](typescript-eslint/typescript-eslint#4622)) ([88ed9ec](typescript-eslint/typescript-eslint@88ed9ec))

</details>

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

### [`v5.21.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5210-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5200v5210-2022-04-25)

[Compare Source](typescript-eslint/typescript-eslint@v5.20.0...v5.21.0)

**Note:** Version bump only for package [@&#8203;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**: 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, 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>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1319
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 May 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement: plugin rule option New rule option for an existing eslint-plugin rule
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants