1880899 - Add a lint rule that prevents adding more globals to browser.js

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, task, P3)

Description

[:Gijs (he/him)]

bug 1880897 has some rationale.

There are some 200-odd globals listed in browser.js.

The lint rule should:

• only apply to browser.js
• iterate over all the variable, function and class declarations in the global scope
• hold an allowlist of known identifier strings
• complain if the list in browser.js does not match its list (ie items removed from browser.js will need removing from the lint rule, and the lint rule will complain if the file has new globals that are not in its allowlist.

This probably seems like overkill. Unfortunately my experience with https://searchfox.org/mozilla-central/source/browser/base/content/test/general/browser.toml is that people are quite happy to submit patches that add items to a list even if every other line in the file tells them not to (in all caps, to boot), dutifully copying the warning line. Hopefully the linter will help...

Comment 1

[Mark Banner (:standard8)]

We might be able to base something on or around the browser-window environment for ESLint.

We can already load that & generate a list of globals which we do for export purposes.

Comment 2

[:Gijs (he/him)]

Attachment: Bug 1880899 - add lint rule that prevents adding more browser.js globals, r?Standard8

Comment 3

[BugBot [:suhaib / :marco/ :calixte]]

The severity field is not set for this bug.
:andi, could you have a look please?

For more information, please visit BugBot documentation.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a65344e02551
add lint rule that prevents adding more browser.js globals, r=Standard8

Comment 5

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/a65344e02551