Add eslint rule to warn against using globals for addEventListener #26810
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ellatrix
requested review from
adamziel,
ajitbohra,
draganescu,
gziolo,
kevin940726,
nerrad,
noisysocks,
ntwb,
Soean,
talldan and
tellthemachines
as code owners
|
Size Change: -14 B (0%) Total Size: 1.21 MB
ℹ️ View Unchanged
|
6 tasks
ellatrix
force-pushed
the
try/global-listener-eslint-rule
branch
from
ff2fee7 to
18291ae
Compare
ellatrix
force-pushed
the
try/global-listener-eslint-rule
branch
from
18291ae to
ad54e03
Compare
hc0503
approved these changes
Nov 10, 2020
@ellatrix I wonder if there's any reference to back this up? Or a counter-example would also be nice! |
|
@ellatrix Can you please provide any info to back this up and why and where this can fail? And how exactly am I supposed to write this without disabling the rule. // eslint-disable-next-line @wordpress/no-global-event-listener
document.addEventListener('DOMContentLoaded', (): void => {
removeUnwantedStuff();
});The following seems a bit ridiculous, there is no rule for against selecting But am I guessing that I am supposed to work with some element I selected with document.body.ownerDocument.documentElement.addEventListener(
'DOMContentLoaded',
(): void => {
removeUnwantedStuff();
}
); |
|
It's only meant for React components. Not sure if there's a way to make it more specific... |
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a custom ESLint rule to warn against using globals (
windowanddocument) foraddEventListenerandremoveEventListener. It's good practice to access the document and window relatively through a ref with theownerDocumentanddefaultViewproperties.I've fixed a few instances in the code base, but it's quite a bit of work to convert and test all instances. Maybe this can be done over several PRs. Eventually, it would be good to error instead of warn.
How has this been tested?
Screenshots
Types of changes
Checklist: