noRestrictedGlobals

JavaScript (and super languages)

Summary

Rule available since: v1.0.0
Diagnostic Category: lint/style/noRestrictedGlobals
This rule doesn’t have a fix.
The default severity of this rule is warning.
Sources:
- Same as no-restricted-globals

Description

This rule allows you to specify global variable names that you don’t want to use in your application.

References to the global identifiers error and event are always disallowed by this rule.

Disallowing usage of specific global variables can be useful if you want to allow a set of global variables by enabling an environment, but still want to disallow some of those.

Examples

Invalid

1
console.log(event)

code-block.js:1:13 lint/style/noRestrictedGlobals ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Do not use the global variable event.
  
  > 1 │ console.log(event)
      │             ^^^^^
    2 │ 
  
  ℹ Use a local variable instead.

Valid

1
function f(event) {
2
    console.log(event)
3
}

Options

Use the options to specify additional globals that you want to restrict in your source code.

1
{
2
    "options": {
3
        "deniedGlobals": {
4
            "$": "jQuery is not allowed. Use native DOM manipulation instead.",
5
            "MooTools": "Do not use MooTools, use MeowTools instead."
6
        }
7
    }
8
}

In the example above, the rule will emit a diagnostics if tried to use $ or MooTools without creating a local variable.

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noRestrictedGlobals": "error"
6
      }
7
    }
8
  }
9
}