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): [no-shadow] add shadowed variable location to the error message #5183

Merged
merged 2 commits into from Jun 26, 2022

Conversation

bradzacher
Copy link
Member

@bradzacher bradzacher commented Jun 13, 2022

PR Checklist

Overview

I noticed that we had missed eslint/eslint#13841. This is a pretty valuable upstream change which greatly improves the error message.

Whilst I was here I also followed the same test structure for no-unused-vars where we separate the tests from upstream eslint into a separate file from our local tests.
I did this now because I noticed that someone had added tests for our logic to the "eslint tests" section - so when I pasted the upstream tests I deleted a bunch of tests!
It shouldn't be an issue in future.

@bradzacher bradzacher added the enhancement New feature or request label Jun 13, 2022
@nx-cloud
Copy link

@nx-cloud nx-cloud bot commented Jun 13, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit a58c221. 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 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

@typescript-eslint typescript-eslint bot commented Jun 13, 2022

Thanks for the PR, @bradzacher!

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 netlify bot commented Jun 13, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit a58c221
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/62b8b9ec3eac3f00097e87dd
😎 Deploy Preview https://deploy-preview-5183--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 codecov bot commented Jun 13, 2022

Codecov Report

Merging #5183 (a58c221) into main (2600f7f) will increase coverage by 2.43%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #5183      +/-   ##
==========================================
+ Coverage   91.33%   93.76%   +2.43%     
==========================================
  Files         132      287     +155     
  Lines        1488     9868    +8380     
  Branches      224     2952    +2728     
==========================================
+ Hits         1359     9253    +7894     
- Misses         65      335     +270     
- Partials       64      280     +216     
Flag Coverage Δ
unittest 93.76% <100.00%> (+2.43%) ⬆️

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

Impacted Files Coverage Δ
packages/eslint-plugin/src/rules/no-shadow.ts 75.84% <100.00%> (ø)
...plugin/src/rules/naming-convention-utils/shared.ts 100.00% <0.00%> (ø)
...rc/rules/indent-new-do-not-use/BinarySearchTree.ts 100.00% <0.00%> (ø)
...ackages/eslint-plugin/src/rules/no-for-in-array.ts 100.00% <0.00%> (ø)
...slint-plugin/src/rules/no-unnecessary-condition.ts 98.30% <0.00%> (ø)
...ackages/eslint-plugin/src/rules/no-invalid-this.ts 80.00% <0.00%> (ø)
.../eslint-plugin/src/rules/promise-function-async.ts 98.03% <0.00%> (ø)
.../src/rules/sort-type-union-intersection-members.ts 90.74% <0.00%> (ø)
packages/eslint-plugin/src/rules/unbound-method.ts 92.13% <0.00%> (ø)
...src/rules/naming-convention-utils/parse-options.ts 100.00% <0.00%> (ø)
... and 146 more

JoshuaKGoldberg
JoshuaKGoldberg previously approved these changes Jun 25, 2022
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Super, thank you!

packages/eslint-plugin/src/rules/no-shadow.ts Outdated Show resolved Hide resolved
return {
global: true,
};
}
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg Jun 25, 2022

Choose a reason for hiding this comment

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

Nitty nit: could be simplified to return identifier ? { ... } : { ... };.

Copy link
Member Author

@bradzacher bradzacher Jun 26, 2022

Choose a reason for hiding this comment

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

you really do love your ternaries 😄
personally I prefer to only use ternaries for when I want an expression.
I find in this case where I can do everything with statements - using an if statement is clearer and cleaner.

@bradzacher bradzacher merged commit 8ca08e9 into main Jun 26, 2022
39 checks passed
@bradzacher bradzacher deleted the shadowed-variable-loc branch Jun 26, 2022
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this issue Jun 28, 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.29.0` -> `5.30.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.29.0/5.30.0) |
| [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.29.0` -> `5.30.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.29.0/5.30.0) |

---

### Release Notes

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

### [`v5.30.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5300-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5290v5300-2022-06-27)

[Compare Source](typescript-eslint/typescript-eslint@v5.29.0...v5.30.0)

##### Features

-   **eslint-plugin:** \[no-shadow] add shadowed variable location to the error message ([#&#8203;5183](typescript-eslint/typescript-eslint#5183)) ([8ca08e9](typescript-eslint/typescript-eslint@8ca08e9))
-   treat `this` in `typeof this` as a `ThisExpression` ([#&#8203;4382](typescript-eslint/typescript-eslint#4382)) ([b04b2ce](typescript-eslint/typescript-eslint@b04b2ce))

</details>

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

### [`v5.30.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5300-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5290v5300-2022-06-27)

[Compare Source](typescript-eslint/typescript-eslint@v5.29.0...v5.30.0)

**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, 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/1436
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 Jul 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants