Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

feat(eslint-plugin): [explicit-member-accessibility] suggest adding explicit accessibility specifiers#5492

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

Conversation

jtbandes
Copy link
Contributor

PR Checklist

Overview

This PR adds auto-fix support toexplicit-member-accessibility's default mode (explicit) by automatically addingpublic to declarations without an existing accessibility level.

Re#4647 (comment):

If we simply autofixed every case to public then it would defeat the purpose of the rule.

I disagree that it defeats the purpose of the rule: the purpose is to make developers think explicitly about accessibility levels, and auto-addingpublic makes it obvious that the default accessibility is public.

I tested out this change on a large TS codebase:https://github.com/foxglove/studio/pull/4164

Another option, if you find this auto-fix undesirable, would be to make it asuggestion instead of a fix. What do you think?

omril1 reacted with rocket emoji
@nx-cloud
Copy link

nx-cloudbot commentedAug 17, 2022•
edited
Loading

☁️ Nx Cloud Report

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

Sent with 💌 fromNxCloud.

@typescript-eslint
Copy link
Contributor

Thanks for the PR,@jtbandes!

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 onhttps://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitorsper day.

@netlify
Copy link

netlifybot commentedAug 17, 2022•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commit5471380
🔍 Latest deploy loghttps://app.netlify.com/sites/typescript-eslint/deploys/630635be8118fb000822c849
😎 Deploy Previewhttps://deploy-preview-5492--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 yourNetlify site settings.

@jtbandesjtbandes changed the titlefeat(eslint-plugin): [explicit-member-accessibility] autofix missing accessibilityfeat(eslint-plugin): [explicit-member-accessibility] autofix missing accessibility by addingpublicAug 17, 2022
@codecov
Copy link

codecovbot commentedAug 17, 2022•
edited
Loading

Codecov Report

Merging#5492 (6395b8f) intomain (1b2601a) willincrease coverage by2.34%.
The diff coverage is100.00%.

❗ Current head6395b8f differs from pull request most recent head5471380. Consider uploading reports for the commit5471380 to get more accurate results

@@            Coverage Diff             @@##             main    #5492      +/-   ##==========================================+ Coverage   91.57%   93.92%   +2.34%==========================================  Files         132      290     +158       Lines        1496    10024    +8528       Branches      226     3016    +2790     ==========================================+ Hits         1370     9415    +8045- Misses         62      330     +268- Partials       64      279     +215
FlagCoverage Δ
unittest93.92% <100.00%> (+2.34%)⬆️

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

Impacted FilesCoverage Δ
...-plugin/src/rules/explicit-member-accessibility.ts97.43% <100.00%> (ø)
...src/configs/recommended-requiring-type-checking.ts100.00% <0.00%> (ø)
...nt-plugin/src/rules/consistent-type-definitions.ts97.29% <0.00%> (ø)
packages/eslint-plugin/src/rules/indent.ts92.85% <0.00%> (ø)
packages/eslint-plugin/src/rules/unbound-method.ts92.13% <0.00%> (ø)
...ackages/eslint-plugin/src/util/getWrappingFixer.ts100.00% <0.00%> (ø)
...eslint-plugin/src/rules/consistent-type-exports.ts97.70% <0.00%> (ø)
...plugin/src/rules/explicit-module-boundary-types.ts91.04% <0.00%> (ø)
packages/eslint-plugin/src/rules/array-type.ts97.14% <0.00%> (ø)
...ackages/eslint-plugin/src/rules/no-var-requires.ts90.00% <0.00%> (ø)
... and149 more

@bradzacher
Copy link
Member

bradzacher commentedAug 17, 2022•
edited
Loading

Thanks for the PR.
As per the issue - we will not be accepting autofix support for this rule.

the purpose is to make developers think explicitly about accessibility levels, and auto-adding public makes it obvious that the default accessibility is public.

The issue is that once you autofix to addpublic, then the rule no longer reports at all.
This is why I say that it defeats the purpose of the rule! If the rule doesn't report then you won't be prompted to think about the accessibility!

So if someone is paying little attention and just runs--fix then they won't ever see the lint report on the member.
Similarly if the user has autofix-on-save turned on then they will add a new member, save the file andpublic is auto-added - again they never see the lint report to prompt them to consider which modifier is right!

We don't want this rule to have a fixer that people use to codemod their codebase (like you did in your linked PR) - lint features last forever and need to support the normal, non-codemod usecase.

If you'd like to make this a suggestion fixer - I'm happy to accept that. We could have a suggestion fixer for each of the accessibility modifiers.
That would allow people to quickly choose and add the relevant modifier with a single click.

jtbandes reacted with thumbs up emoji

@bradzacherbradzacher added enhancementNew feature or request awaiting responseIssues waiting for a reply from the OP or another party labelsAug 17, 2022
@jtbandes
Copy link
ContributorAuthor

jtbandes commentedAug 18, 2022•
edited
Loading

Updated to suggest 3 fixes for each error, addingpublic,private, andprotected.

Screen.Recording.2022-08-17.at.6.41.16.PM.mov

@jtbandes
Copy link
ContributorAuthor

And although it's no longer relevant since I've changed them to suggestions, I just want to give my perspective on:

The issue is that once you autofix to add public, then the rule no longer reports at all.
This is why I say that it defeats the purpose of the rule! If the rule doesn't report then you won't be prompted to think about the accessibility!

There's a step where you do still notice the change: code review :)

@bradzacherbradzacher removed the awaiting responseIssues waiting for a reply from the OP or another party labelAug 18, 2022
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Started reviewing and found blockers in the codecov report and unifying the message IDs. Left a few other questions too 🙂 . I'll review in more detail (so many new lines of test code! yay!) once those are answered. Thanks for sending this in! ✨

const lastDecorator = node.decorators[node.decorators.length - 1];
const nextToken = sourceCode.getTokenAfter(lastDecorator);
if (!nextToken) {
return null;

Choose a reason for hiding this comment

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

We generally expect most new code -and ideally all new rule code- to be covered by tests. Codecov is rightfully showing here that this isn't. One of two cases is true:

  • This case can be tested and should be
  • This case is impossible and the type system is wrong
    • Meaning: use a! to show that thenextToken does always exist

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

I expect it isprobably impossible, because I can't think of any situation where there wouldn't be any tokens after the last decorator, but it feels wrong to simply! the output ofgetTokenAfter just because I believe that (perhaps erroneously), so I was trying to code defensively. But that also means I can't think of any test cases to add test coverage here. What would you recommend doing?

Choose a reason for hiding this comment

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

I say! it. If there are decorators they must be decorating something for this to be valid syntax.

In an ideal world,sourceCode.getTokenAfter would know that if it's given a node that must have an after, the returned token is defined. If we eventually get rich enough types the! will be linted as unnecessary.

jtbandes reacted with thumbs up emoji
@JoshuaKGoldbergJoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party labelAug 18, 2022
@jtbandes
Copy link
ContributorAuthor

Not sure what's going on with thewebsite tests – could that be related to my changes? Seems unlikely?

@jtbandesjtbandes changed the titlefeat(eslint-plugin): [explicit-member-accessibility] autofix missing accessibility by addingpublicfeat(eslint-plugin): [explicit-member-accessibility] suggest adding explicit accessibility specifiersAug 19, 2022
@jtbandes
Copy link
ContributorAuthor

@JoshuaKGoldberg@bradzacher friendly ping, anything else you'd like me to change here?

@JoshuaKGoldberg
Copy link
Member

Nope this looks great, thanks!

Re the website tests: 🤷 I have given up on them. They do what they want to do. We have no power here.

bradzacher reacted with laugh emoji

Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

✨

jtbandes reacted with hooray emoji
@JoshuaKGoldbergJoshuaKGoldbergenabled auto-merge (squash)August 24, 2022 14:35
@JoshuaKGoldbergJoshuaKGoldberg merged commit0edb94a intotypescript-eslint:mainAug 24, 2022
@jtbandesjtbandes deleted the fix-explicit-member-accessibility branchAugust 24, 2022 14:48
@jtbandes
Copy link
ContributorAuthor

Thanks for all the review!

@bradzacher
Copy link
Member

lgtm15.jpg

omril1 and guilhermesimoes reacted with rocket emoji

crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull requestSep 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.33.1` -> `5.35.1`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.33.1/5.35.1) || [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.33.1` -> `5.35.1`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.33.1/5.35.1) |---### Release Notes<details><summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/eslint-plugin)</summary>### [`v5.35.1`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5351-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5350v5351-2022-08-24)[Compare Source](typescript-eslint/typescript-eslint@v5.35.0...v5.35.1)##### Bug Fixes-   **eslint-plugin:** correct rule schemas to pass ajv validation ([#&#8203;5531](typescript-eslint/typescript-eslint#5531)) ([dbf8b56](typescript-eslint/typescript-eslint@dbf8b56))### [`v5.35.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5350-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5340v5350-2022-08-24)[Compare Source](typescript-eslint/typescript-eslint@v5.34.0...v5.35.0)##### Features-   **eslint-plugin:** \[explicit-member-accessibility] suggest adding explicit accessibility specifiers ([#&#8203;5492](typescript-eslint/typescript-eslint#5492)) ([0edb94a](typescript-eslint/typescript-eslint@0edb94a))### [`v5.34.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5340-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5331v5340-2022-08-22)[Compare Source](typescript-eslint/typescript-eslint@v5.33.1...v5.34.0)##### Bug Fixes-   **eslint-plugin:** \[no-useless-constructor] handle parameter decorator ([#&#8203;5450](typescript-eslint/typescript-eslint#5450)) ([864dbcf](typescript-eslint/typescript-eslint@864dbcf))##### Features-   **eslint-plugin:** \[prefer-optional-chain] support suggesting `!foo || !foo.bar` as a valid match for the rule ([#&#8203;5266](typescript-eslint/typescript-eslint#5266)) ([aca935c](typescript-eslint/typescript-eslint@aca935c))#### [5.33.1](typescript-eslint/typescript-eslint@v5.33.0...v5.33.1) (2022-08-15)##### Bug Fixes-   missing placeholders in violation messages for `no-unnecessary-type-constraint` and `no-unsafe-argument` (and enable `eslint-plugin/recommended` rules internally) ([#&#8203;5453](typescript-eslint/typescript-eslint#5453)) ([d023910](typescript-eslint/typescript-eslint@d023910))</details><details><summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>### [`v5.35.1`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5351-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5350v5351-2022-08-24)[Compare Source](typescript-eslint/typescript-eslint@v5.35.0...v5.35.1)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)### [`v5.35.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5350-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5340v5350-2022-08-24)[Compare Source](typescript-eslint/typescript-eslint@v5.34.0...v5.35.0)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)### [`v5.34.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5340-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5331v5340-2022-08-22)[Compare Source](typescript-eslint/typescript-eslint@v5.33.1...v5.34.0)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)#### [5.33.1](typescript-eslint/typescript-eslint@v5.33.0...v5.33.1) (2022-08-15)**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.--- - [x] <!-- 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).<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xNjkuMSIsInVwZGF0ZWRJblZlciI6IjMyLjE3My4wIn0=-->Co-authored-by: cabr2-bot <cabr2.help@gmail.com>Co-authored-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>Reviewed-on:https://codeberg.org/Calciumdibromid/CaBr2/pulls/1519Reviewed-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-actionsgithub-actionsbot locked asresolvedand limited conversation to collaboratorsSep 24, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@JoshuaKGoldbergJoshuaKGoldbergJoshuaKGoldberg approved these changes

Assignees
No one assigned
Labels
awaiting responseIssues waiting for a reply from the OP or another partyenhancementNew feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@jtbandes@bradzacher@JoshuaKGoldberg
[8]ページ先頭
©2009-2025 Movatter.jp