typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star16k

fix(eslint-plugin): replace auto-fix of class literal property style rule with suggestion#7054

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

JoshuaKGoldberg merged 9 commits intotypescript-eslint:mainfromMelandra:issue-5962-replace-auto-fix-with-suggestion

Jul 9, 2023

Merged

fix(eslint-plugin): replace auto-fix of class literal property style rule with suggestion#7054

JoshuaKGoldberg merged 9 commits intotypescript-eslint:mainfromMelandra:issue-5962-replace-auto-fix-with-suggestion

Jul 9, 2023

Conversation

Copy link

Contributor

Melandra commentedMay 23, 2023•
edited
Loading

PR Checklist

Addresses an existing open issue:fixesBug: [class-literal-property-style] The overridden literal getter does not pass lint and incorrectly auto-fix #5962
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

This PR changes the fixer for the class literal property style rule in the eslint-plugin package from an autofixer to a suggestion fixer.

Melandra added3 commits

May 23, 2023 08:18

Complete sentence documenting turning on parserOptions.project

a05601f

fix: replace auto-fix with suggestion

1533ead

test: adapt tests to expect suggestion rather than output from auto-fix

421e29b

Copy link

Contributor

typescript-eslintbot commentedMay 23, 2023

Thanks for the PR,@Melandra!

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.

Copy link

netlifybot commentedMay 23, 2023•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`8fdefa1`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/64ab0bfc771b4e000877943b
😎 Deploy Preview	https://deploy-preview-7054--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 yourNetlify site configuration.

Copy link

nx-cloudbot commentedMay 23, 2023•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit8fdefa1. 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 25 targets

Sent with 💌 fromNxCloud.

fix: add return type

b66f06e

Copy link

codecovbot commentedMay 23, 2023•
edited
Loading

Codecov Report

Merging#7054 (ba8be5b) intomain (5166a00) willincrease coverage by0.02%.
The diff coverage is100.00%.

❗ Current headba8be5b differs from pull request most recent head8fdefa1. Consider uploading reports for the commit8fdefa1 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@##             main    #7054      +/-   ##==========================================+ Coverage   87.38%   87.41%   +0.02%==========================================  Files         386      386                Lines       13193    13216      +23       Branches     3867     3879      +12     ==========================================+ Hits        11529    11553      +24+ Misses       1298     1296       -2- Partials      366      367       +1

Flag	Coverage Δ
unittest	`87.41% <100.00%> (+0.02%)`	⬆️

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

Impacted Files	Coverage Δ
...t-plugin/src/rules/class-literal-property-style.ts	`100.00% <100.00%> (ø)`

... and7 files with indirect coverage changes

Melandra marked this pull request as ready for review

May 23, 2023 18:52

Melandra commented

May 23, 2023

View reviewed changes

packages/eslint-plugin/src/rules/class-literal-property-style.ts Outdated

		messages:{
		preferFieldStyle:'Literals should be exposed using readonly fields.',
		preferFieldStyleSuggestion:
		'Try replacing the literals with readonly fields.',

Copy link

ContributorAuthor

MelandraMay 23, 2023

Choose a reason for hiding this comment

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

I wasn't sure what messaging to use here, I'm open for other suggestions 🙂

Copy link

Member

JoshuaKGoldbergJul 8, 2023

Choose a reason for hiding this comment

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

Ah yeah these can be tricky. Searching around other rules that havehasSuggestions: true, we normally go with language like"Do X with Y". Here I think that'd be:

- 'Try replacing the literals with readonly fields.'+ 'Replace the literals with readonly fields.'

What do you think about that?

Copy link

ContributorAuthor

MelandraJul 9, 2023

Choose a reason for hiding this comment

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

Yes, that sounds good, I've updated both suggestion messages.

Revert "Complete sentence documenting turning on parserOptions.project"

1d39475

This reverts commita05601f.

JoshuaKGoldberg requested changes

Jul 8, 2023

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

🙌 The code looks great - love a clean swap like this one!

Just requesting changes to suggest a change to the text, as you brought up. Thoughts?

If you're happy with the suggestion or have one of your own then ✅ we can merge!

(sorry for the delay in reviewing - we've been focusing onv6...)

JoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party label

Jul 8, 2023

Melandra added2 commits

July 9, 2023 12:25

Replace text with suggestion

b46a10e

Replace both suggestion messages

fe73d6d

Copy link

ContributorAuthor

Melandra commentedJul 9, 2023

No worries 🙂
I've update the messages as you proposed.

Formatting

ba8be5b

JoshuaKGoldberg removed the awaiting responseIssues waiting for a reply from the OP or another party label

Jul 9, 2023

JoshuaKGoldberg previously approved these changes

Jul 9, 2023

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment•
edited
Loading

Choose a reason for hiding this comment

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

🙌 Super, thanks@Melandra!

yarn format

8fdefa1

JoshuaKGoldberg dismissed theirstale review via8fdefa1

July 9, 2023 19:35

JoshuaKGoldberg merged commita8c824a intotypescript-eslint:main

Jul 9, 2023

github-actionsbot locked asresolvedand limited conversation to collaborators

Jul 17, 2023

Labels

None yet

Movatterモバイル変換

Uh oh!

fix(eslint-plugin): replace auto-fix of class literal property style rule with suggestion#7054

fix(eslint-plugin): replace auto-fix of class literal property style rule with suggestion#7054

Uh oh!

Conversation

Melandra commentedMay 23, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslintbot commentedMay 23, 2023

Uh oh!

netlifybot commentedMay 23, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

nx-cloudbot commentedMay 23, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

codecovbot commentedMay 23, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

MelandraMay 23, 2023

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldbergJul 8, 2023

Choose a reason for hiding this comment

Uh oh!

MelandraJul 9, 2023

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Melandra commentedJul 9, 2023

Uh oh!

JoshuaKGoldberg left a comment• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Melandra commentedMay 23, 2023•
edited
Loading

netlifybot commentedMay 23, 2023•
edited
Loading

nx-cloudbot commentedMay 23, 2023•
edited
Loading

codecovbot commentedMay 23, 2023•
edited
Loading

JoshuaKGoldberg left a comment•
edited
Loading