summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/eslint-plugin-mozilla/rules/reject-chromeutils-import.rst
blob: 5c310fb6071e04b541c7ef377b1488cdcf99467b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
reject-chromeutils-import
================================

While ``ChromeUtils.import`` supports the fallback to ESMified module,
in-tree files should use ``ChromeUtils.importESModule`` for ESMified modules.

Examples of incorrect code for this rule:
-----------------------------------------

.. code-block:: js

    ChromeUtils.import("resource://gre/modules/AppConstants.jsm");

    ChromeUtils.defineModuleGetter(
      obj, "AppConstants", "resource://gre/modules/AppConstants.jsm");
    XPCOMUtils.defineLazyModuleGetters(
      obj, { AppConstants: "resource://gre/modules/AppConstants.jsm" });

Examples of correct code for this rule:
---------------------------------------

.. code-block:: js

    ChromeUtils.importESModule("resource://gre/modules/AppConstants.sys.mjs");

    ChromeUtils.defineESModuleGetters(
      obj, { AppConstants: "resource://gre/modules/AppConstants.sys.mjs" });