Bug 1877304 - Allow exporting the lazy object. r=Standard8

Differential Revision: https://phabricator.services.mozilla.com/D200043
dothq · Jan 31, 2024 · 215ba94 · 215ba94
1 parent d324aaa
commit 215ba94
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 8 deletions.
diff --git a/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/valid-lazy.js b/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/valid-lazy.js
@@ -65,6 +65,7 @@ module.exports = {
   create(context) {
     let lazyProperties = new Map();
     let unknownProperties = [];
+    let isLazyExported = false;
 
     function addProp(node, name) {
       if (lazyProperties.has(name)) {
@@ -190,6 +191,16 @@ module.exports = {
         }
       },
 
+      ExportNamedDeclaration(node) {
+        for (const spec of node.specifiers) {
+          if (spec.local.name === "lazy") {
+            // If the lazy object is exported, do not check unused property.
+            isLazyExported = true;
+            break;
+          }
+        }
+      },
+
       "Program:exit": function () {
         for (let { name, node } of unknownProperties) {
           let property = lazyProperties.get(name);
@@ -203,13 +214,15 @@ module.exports = {
             property.used = true;
           }
         }
-        for (let [name, property] of lazyProperties.entries()) {
-          if (!property.used) {
-            context.report({
-              node: property.node,
-              messageId: "unusedProperty",
-              data: { name },
-            });
+        if (!isLazyExported) {
+          for (let [name, property] of lazyProperties.entries()) {
+            if (!property.used) {
+              context.report({
+                node: property.node,
+                messageId: "unusedProperty",
+                data: { name },
+              });
+            }
           }
         }
       },

diff --git a/tools/lint/eslint/eslint-plugin-mozilla/tests/valid-lazy.js b/tools/lint/eslint/eslint-plugin-mozilla/tests/valid-lazy.js
@@ -10,7 +10,9 @@
 var rule = require("../lib/rules/valid-lazy");
 var RuleTester = require("eslint").RuleTester;
 
-const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: "latest" } });
+const ruleTester = new RuleTester({
+  parserOptions: { ecmaVersion: "latest", sourceType: "module" },
+});
 
 // ------------------------------------------------------------------------------
 // Tests
@@ -95,6 +97,11 @@ ruleTester.run("valid-lazy", rule, {
        var { x = lazy.foo.bar() } = {};
        var [ y = lazy.foo.bar() ] = [];
      `,
+    `
+       const lazy = {};
+       ChromeUtils.defineLazyGetter(lazy, "foo", () => {});
+       export { lazy as Foo };
+     `,
   ],
   invalid: [
     invalidCode("if (x) { lazy.bar; }", "bar", "unknownProperty"),