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

JoshuaKGoldberg · 2022-03-01T22:43:58Z

PR Checklist

Addresses an existing issue: fixes [no-parameter-properties] Support enforcing the inverse #103
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

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.

nx-cloud · 2022-03-01T22:43:59Z

☁️ 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 · 2022-03-01T22:44:02Z

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 · 2022-03-01T22:44:06Z

✅ 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... Use your smartphone camera to open QR code link.

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

codecov · 2022-03-03T12:26:28Z

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

packages/eslint-plugin/src/rules/index.ts

bradzacher · 2022-03-29T01:35:05Z

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

JoshuaKGoldberg · 2022-03-29T13:37:28Z

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 · 2022-03-29T18:30:58Z

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

JoshuaKGoldberg · 2022-03-29T19:08:44Z

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

bradzacher · 2022-04-08T23:21:51Z

packages/eslint-plugin/src/rules/parameter-properties.ts

+        }
+      },
+
+      'MethodDefinition[kind="constructor"]'(


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

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

packages/eslint-plugin/src/rules/parameter-properties.ts

bradzacher

this is great!

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 (@typescript-eslint/eslint-plugin)</summary> ### [`v5.21.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#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 ([#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 ([#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 ([#4848](typescript-eslint/typescript-eslint#4848)) ([d74d559](typescript-eslint/typescript-eslint@d74d559)) ##### Features - **eslint-plugin:** \[parameter-properties] add rule to replace `no-parameter-properties` ([#4622](typescript-eslint/typescript-eslint#4622)) ([88ed9ec](typescript-eslint/typescript-eslint@88ed9ec)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.21.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#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 [@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. --- - [ ] 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>

feat(eslint-plugin): allow 'prefer' in renamed parameter-properties rule

3bd4991

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

test: add test cases

1ac6b87

JoshuaKGoldberg added 3 commits March 5, 2022 13:05

chore: docs and a bit more testing

19f2e76

docs: reword

e7bba70

Merge branch 'main' into parameter-properties-prefer

405cc6b

JoshuaKGoldberg marked this pull request as ready for review March 5, 2022 18:10

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 added this to the 6.0.0 milestone Mar 7, 2022

JoshuaKGoldberg requested a review from bradzacher March 8, 2022 09:33

JoshuaKGoldberg commented Mar 8, 2022

View reviewed changes

packages/eslint-plugin/src/rules/index.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg added 6 commits March 26, 2022 11:43

chore: added back old rule as deprecated

698b760

Merge branch 'main' into parameter-properties-prefer

ced63da

chore: add rule back to index.ts

295fa9a

chore: add rule md, and replacedBy

4f3409a

chore: import order

b96865d

chore: ...and eslint-plugin/docs/rules/README.md

e67dd44

JoshuaKGoldberg requested review from bradzacher and removed request for bradzacher March 26, 2022 17:47

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

bradzacher reviewed Apr 8, 2022

View reviewed changes

bradzacher removed this from the 6.0.0 milestone Apr 8, 2022

Merge branch 'main' into parameter-properties-prefer

d234ad2

JoshuaKGoldberg requested a review from bradzacher April 12, 2022 21:53

bradzacher approved these changes Apr 22, 2022

View reviewed changes

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 merged commit 88ed9ec into typescript-eslint:main Apr 22, 2022

github-actions bot locked as resolved and limited conversation to collaborators May 23, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

JoshuaKGoldberg commented Mar 1, 2022 •

edited

nx-cloud bot commented Mar 1, 2022 •

edited

typescript-eslint bot commented Mar 1, 2022

netlify bot commented Mar 1, 2022 •

edited

codecov bot commented Mar 3, 2022 •

edited

bradzacher commented Mar 29, 2022

JoshuaKGoldberg commented Mar 29, 2022

bradzacher commented Mar 29, 2022

JoshuaKGoldberg commented Mar 29, 2022

bradzacher Apr 8, 2022

JoshuaKGoldberg Apr 12, 2022

bradzacher left a comment

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

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

Conversation

JoshuaKGoldberg commented Mar 1, 2022 • edited

PR Checklist

Overview

nx-cloud bot commented Mar 1, 2022 • edited

☁️ Nx Cloud Report

typescript-eslint bot commented Mar 1, 2022

netlify bot commented Mar 1, 2022 • edited

✅ Deploy Preview for typescript-eslint ready!

codecov bot commented Mar 3, 2022 • edited

Codecov Report

bradzacher commented Mar 29, 2022

JoshuaKGoldberg commented Mar 29, 2022

bradzacher commented Mar 29, 2022

JoshuaKGoldberg commented Mar 29, 2022

bradzacher Apr 8, 2022

Choose a reason for hiding this comment

JoshuaKGoldberg Apr 12, 2022

Choose a reason for hiding this comment

bradzacher left a comment

Choose a reason for hiding this comment

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

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

JoshuaKGoldberg commented Mar 1, 2022 •

edited

nx-cloud bot commented Mar 1, 2022 •

edited

netlify bot commented Mar 1, 2022 •

edited

codecov bot commented Mar 3, 2022 •

edited