summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/eslint-plugin-mozilla/rules/import-globals-from.rst
blob: c2956ba05a25d89111e039608bdc0667ce2e94ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import-globals-from
===================

Parses a file for globals defined in various unique Mozilla ways.

When a ``/* import-globals-from <path> */`` comment is found in a file, then all
globals from the file at <path> will be imported in the current scope. This will
also operate recursively.

This is useful for scripts that are loaded as <script> tag in a window and rely
on each other's globals.

If <path> is a relative path, then it must be relative to the file being
checked by the rule.

Note: ``import-globals-from`` does not support loading globals from ES modules.
These should be imported as variable definitions directly, or the file where
they are imported should be referenced.