feat: Copy getScope() to SourceCode #17004

nzakas · 2023-03-21T18:43:57Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[x] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[x] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

This change moves the logic for context.getScope() into SourceCode and then makes context.getScope() call SourceCode#getScope().

I've marked context.getScope() as deprecated in documentation and updated all of the rules using context.getScope() to instead call SourceCode#getScope().

Refs #16999

Is there anything you'd like reviewers to focus on?

Refs #16999

netlify · 2023-03-21T18:44:05Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`7b187db`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/641c9d8903e75a00085b64a7
😎 Deploy Preview	https://deploy-preview-17004--docs-eslint.netlify.app/extend/custom-rules
📱 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.

docs/src/extend/custom-rules.md

lib/source-code/source-code.js

nzakas · 2023-03-23T18:42:47Z

Applied suggestions and also added a bit of caching. Going through the code base made me realize we are probably doing a lot of duplicate work with getScope(), so caching the result may help improve performance.

mdjermanovic

There are two places where context.getScope() is replaced with sourceCode.getScope(node) where the node argument is not the currently traversed node so it gets a different scope. However, I don't think it makes a difference for those particular cases but I'll leave comments just in case it turns out otherwise.

mdjermanovic · 2023-03-23T12:29:42Z

lib/rules/no-implied-eval.js

-                const staticValue = getStaticValue(firstArgument, context.getScope());
+                const staticValue = getStaticValue(firstArgument, sourceCode.getScope(node));


When this function is called from reportImpliedEvalViaGlobal, the scope it passes to getStaticValue will be the innermost scope around the node (CallExpression), while it used to be the global scope. However, this change doesn't make a functional difference for getStaticValue because it internally calculates the innermost scope around the given node anyways. It's actually more optimal to pass in the innermost scope right away, as it will be the case after this change.

mdjermanovic · 2023-03-24T10:24:33Z

lib/rules/prefer-regex-literals.js

-            const scope = context.getScope();
+            const scope = sourceCode.getScope(node);
            const variable = findVariable(scope, node);


Same as the above comment, this was the global scope before this change, but it shouldn't make a difference.

mdjermanovic · 2023-03-24T12:39:21Z

Applied suggestions and also added a bit of caching. Going through the code base made me realize we are probably doing a lot of duplicate work with getScope(), so caching the result may help improve performance.

I didn't notice a difference in performance when running npm run test:performance or npx eslint . on the eslint codebase (although the latter has ~100,000 cache hits) but it may depend on the rules being run.

mdjermanovic

LGTM, thanks!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.36.0` -> `8.37.0`](https://renovatebot.com/diffs/npm/eslint/8.36.0/8.37.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.37.0`](https://github.com/eslint/eslint/releases/tag/v8.37.0) [Compare Source](eslint/eslint@v8.36.0...v8.37.0) #### Features - [`b6ab8b2`](eslint/eslint@b6ab8b2) feat: `require-unicode-regexp` add suggestions ([#17007](eslint/eslint#17007)) (Josh Goldberg) - [`10022b1`](eslint/eslint@10022b1) feat: Copy getScope() to SourceCode ([#17004](eslint/eslint#17004)) (Nicholas C. Zakas) - [`1665c02`](eslint/eslint@1665c02) feat: Use plugin metadata for flat config serialization ([#16992](eslint/eslint#16992)) (Nicholas C. Zakas) - [`b3634f6`](eslint/eslint@b3634f6) feat: docs license ([#17010](eslint/eslint#17010)) (Samuel Roldan) - [`892e6e5`](eslint/eslint@892e6e5) feat: languageOptions.parser must be an object. ([#16985](eslint/eslint#16985)) (Nicholas C. Zakas) #### Bug Fixes - [`619f3fd`](eslint/eslint@619f3fd) fix: correctly handle `null` default config in `RuleTester` ([#17023](eslint/eslint#17023)) (Brad Zacher) - [`1fbf118`](eslint/eslint@1fbf118) fix: `getFirstToken`/`getLastToken` on comment-only node ([#16889](eslint/eslint#16889)) (Francesco Trotta) - [`129e252`](eslint/eslint@129e252) fix: Fix typo in `logical-assignment-operators` rule description ([#17000](eslint/eslint#17000)) (Francesco Trotta) #### Documentation - [`75339df`](eslint/eslint@75339df) docs: fix typos and missing info in id-match docs ([#17029](eslint/eslint#17029)) (Ed Lucas) - [`ec2d830`](eslint/eslint@ec2d830) docs: Fix typos in the `semi` rule docs ([#17012](eslint/eslint#17012)) (Andrii Lundiak) - [`e39f28d`](eslint/eslint@e39f28d) docs: add back to top button ([#16979](eslint/eslint#16979)) (Tanuj Kanti) - [`721c717`](eslint/eslint@721c717) docs: Custom Processors cleanup and expansion ([#16838](eslint/eslint#16838)) (Ben Perlmutter) - [`d049f97`](eslint/eslint@d049f97) docs: 'How ESLint is Maintained' page ([#16961](eslint/eslint#16961)) (Ben Perlmutter) - [`5251a92`](eslint/eslint@5251a92) docs: Describe guard options for guard-for-in ([#16986](eslint/eslint#16986)) (alope107) - [`6157d81`](eslint/eslint@6157d81) docs: Add example to guard-for-in docs. ([#16983](eslint/eslint#16983)) (alope107) - [`fd47998`](eslint/eslint@fd47998) docs: update `Array.prototype.toSorted` specification link ([#16982](eslint/eslint#16982)) (Milos Djermanovic) - [`3e1cf6b`](eslint/eslint@3e1cf6b) docs: Copy edits on Maintain ESLint docs ([#16939](eslint/eslint#16939)) (Ben Perlmutter) #### Chores - [`c67f299`](eslint/eslint@c67f299) chore: upgrade [@eslint/js](https://github.com/eslint/js)[@8](https://github.com/8).37.0 ([#17033](eslint/eslint#17033)) (Milos Djermanovic) - [`ee9ddbd`](eslint/eslint@ee9ddbd) chore: package.json update for [@eslint/js](https://github.com/eslint/js) release (ESLint Jenkins) - [`dddb475`](eslint/eslint@dddb475) chore: upgrade [@eslint/eslintrc](https://github.com/eslint/eslintrc)[@2](https://github.com/2).0.2 ([#17032](eslint/eslint#17032)) (Milos Djermanovic) - [`522431e`](eslint/eslint@522431e) chore: upgrade espree@9.5.1 ([#17031](eslint/eslint#17031)) (Milos Djermanovic) - [`f5f9a88`](eslint/eslint@f5f9a88) chore: upgrade eslint-visitor-keys@3.4.0 ([#17030](eslint/eslint#17030)) (Milos Djermanovic) - [`4dd8d52`](eslint/eslint@4dd8d52) ci: bump actions/stale from 7 to 8 ([#17026](eslint/eslint#17026)) (dependabot\[bot]) - [`ad9dd6a`](eslint/eslint@ad9dd6a) chore: remove duplicate scss, ([#17005](eslint/eslint#17005)) (Strek) - [`ada6a3e`](eslint/eslint@ada6a3e) ci: unpin Node 19 ([#16993](eslint/eslint#16993)) (Milos Djermanovic) - [`c3da975`](eslint/eslint@c3da975) chore: Remove triage label from template ([#16990](eslint/eslint#16990)) (Nicholas C. Zakas) - [`69bc0e2`](eslint/eslint@69bc0e2) ci: pin Node 19 to 19.7.0 ([#16987](eslint/eslint#16987)) (Milos Djermanovic) </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 this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- 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/1834 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: Copy getScope() to SourceCode

ba03d0d

Refs #16999

nzakas requested a review from a team as a code owner March 21, 2023 18:43

eslint-github-bot bot added triage An ESLint team member will look at this issue soon feature This change adds a new feature to ESLint labels Mar 21, 2023

nzakas added 2 commits March 21, 2023 11:51

Fix no-obj-calls

7838c41

Add getScope() tests

0763c49

mdjermanovic added core Relates to ESLint's core APIs and features accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Mar 22, 2023

mdjermanovic reviewed Mar 22, 2023

View reviewed changes

docs/src/extend/custom-rules.md Outdated Show resolved Hide resolved

mdjermanovic reviewed Mar 22, 2023

View reviewed changes

lib/source-code/source-code.js Show resolved Hide resolved

nzakas added 4 commits March 23, 2023 11:33

Throw error if argument is missing

0111ebd

Update docs

213bca7

Add caching

1d57d00

Clean up caching

7b187db

mdjermanovic reviewed Mar 24, 2023

View reviewed changes

mdjermanovic approved these changes Mar 24, 2023

View reviewed changes

mdjermanovic merged commit 10022b1 into main Mar 24, 2023
21 checks passed

mdjermanovic deleted the source-code-updates branch March 24, 2023 13:22

mdjermanovic mentioned this pull request Apr 5, 2023

docs: Custom Rules cleanup/expansion #16906

Merged

1 task

mdjermanovic mentioned this pull request Apr 25, 2023

Implement Language Plugins #16999

Open

39 tasks

github-actions bot mentioned this pull request May 2, 2023

Upgraded some dependencies - Attempt 2 AurorNZ/report-updated-dependencies#638

Merged

mdjermanovic mentioned this pull request May 27, 2023

Bug: Documentation licensed under non-OSS compatible license #17225

Closed

eslint-github-bot bot locked and limited conversation to collaborators Sep 21, 2023

eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Sep 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Copy getScope() to SourceCode #17004

feat: Copy getScope() to SourceCode #17004

nzakas commented Mar 21, 2023

netlify bot commented Mar 21, 2023 •

edited

nzakas commented Mar 23, 2023

mdjermanovic left a comment

mdjermanovic Mar 23, 2023

mdjermanovic Mar 24, 2023

mdjermanovic commented Mar 24, 2023

mdjermanovic left a comment

		const staticValue = getStaticValue(firstArgument, context.getScope());
		const staticValue = getStaticValue(firstArgument, sourceCode.getScope(node));

feat: Copy getScope() to SourceCode #17004

feat: Copy getScope() to SourceCode #17004

Conversation

nzakas commented Mar 21, 2023

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

netlify bot commented Mar 21, 2023 • edited

✅ Deploy Preview for docs-eslint ready!

nzakas commented Mar 23, 2023

mdjermanovic left a comment

Choose a reason for hiding this comment

mdjermanovic Mar 23, 2023

Choose a reason for hiding this comment

mdjermanovic Mar 24, 2023

Choose a reason for hiding this comment

mdjermanovic commented Mar 24, 2023

mdjermanovic left a comment

Choose a reason for hiding this comment

netlify bot commented Mar 21, 2023 •

edited