Rule proposal: disallow window.document/window.location/window.localStorage in favour of document/location/localStorage

[dimaMachina]

Description

since document/location/localStorage are global variables calling window.* is redundant

Fail

window.localStorage.getItem('foo')

Pass

localStorage.getItem('foo')

Additional Info

No response

[fisker]

Personally, I prefer only use ES globals, I even do globalThis.setTimeout(...). Anyway I didn't strictly follow this rule nowadays, I use document directly sometime.

[dimaMachina]

@fisker The generic rule for allowing/disallowing globalThis/window for global variables will satisfy both cases

[fregante]

It feels like this was already suggested maybe on eslint's repo, I can't find the issue here.

I do like the rule, I think window.* is either completely unnecessary or it indicates a bad pattern. The exceptions should be in tests and polyfills.

There are a couple of things to exclude though:

• properties and methods related to the window itself, like window.addEventListener, window.onerror and window.name

[dimaMachina]

It feels like this was already suggested maybe on eslint's repo, I can't find the issue here.

even it was already suggested they will reject this rule since it's stylistic rule

[silverwind]

Adding window or globalThis to globals can break stuff with dumb bundlers, thought that's 100% the bundler's fault of course.

But I do see value in enforcing globalThis or window on certain names so that one does not accidentially use the global when they meant to use a local variable, and I do emulate this to a degree in my config via:

no-restricted-globals: [2, addEventListener, blur, close, closed, confirm, defaultStatus, defaultstatus, error, event, external, find, focus, frameElement, frames, history, innerHeight, innerWidth, isFinite, isNaN, length, location, locationbar, menubar, moveBy, moveTo, name, onblur, onerror, onfocus, onload, onresize, onunload, open, opener, opera, outerHeight, outerWidth, pageXOffset, pageYOffset, parent, print, removeEventListener, resizeBy, resizeTo, screen, screenLeft, screenTop, screenX, screenY, scroll, scrollbars, self, scrollBy, scrollTo, scrollX, scrollY, status, statusbar, stop, toolbar, top]

[fregante]

Closing in favor of broader rules:

• Rule proposal: Avoid or prefer using globals as globalThis.something #2419
• Rule proposal: prefer-global-this #978