feat: scope names

Author: RebeccaStevens

lib/rules/no-sync.js

@@ -10,6 +10,7 @@ const typeMatchesSpecifier =
     )
 const getTypeOfNode = require("../util/get-type-of-node")
 const getParserServices = require("../util/get-parser-services")
+const getNodeScopedName = require("../util/get-node-scoped-name")
 
 const selectors = [
     // fs.readFileSync()
@@ -115,6 +116,8 @@ module.exports = {
             [selector.join(",")](node) {
                 const parserServices = getParserServices(context)
                 let type = undefined
+                const nodeName =
+                    getNodeScopedName(node, parserServices) ?? node.name
 
                 for (const ignore of ignores) {
                     if (typeof ignore === "string") {
@@ -142,7 +145,7 @@ module.exports = {
                             type
                         ) &&
                         (ignore.name === undefined ||
-                            ignore.name.includes(node.name))
+                            ignore.name.includes(nodeName))
                     ) {
                         return
                     }
@@ -152,7 +155,7 @@ module.exports = {
                     node: node.parent,
                     messageId: "noSync",
                     data: {
-                        propertyName: node.name,
+                        propertyName: nodeName,
                     },
                 })
             },

lib/util/get-node-scoped-name.js

@@ -0,0 +1,76 @@
+"use strict"
+
+const ts = (() => {
+    try {
+        // eslint-disable-next-line n/no-unpublished-require
+        return require("typescript")
+    } catch {
+        return null
+    }
+})()
+
+const getTypeOfNode = require("./get-type-of-node")
+
+/**
+ * @param {import('estree').Node & {parent?: import('estree').Node}} node
+ * @param {import('@typescript-eslint/parser').ParserServices | null} parserServices
+ * @returns {string | null}
+ */
+module.exports = function getNodeScopedName(node, parserServices) {
+    if (ts === null || parserServices === null) {
+        return null
+    }
+
+    if (parserServices !== null) {
+        if (node.parent?.type === "MemberExpression") {
+            // Find the root node of the expression
+            return getNodeScopedName(node.parent, parserServices)
+        }
+    }
+
+    return getNodeScopedNameHelper(node, parserServices)
+}
+
+/**
+ * @param {import('estree').Node & {parent?: import('estree').Node}} node
+ * @param {import('@typescript-eslint/parser').ParserServices} parserServices
+ * @returns {string | null}
+ */
+function getNodeScopedNameHelper(node, parserServices) {
+    if (node.type === "MemberExpression") {
+        const objectType = getTypeOfNode(node.object, parserServices)
+        const tsNode = objectType?.symbol.valueDeclaration
+
+        if (tsNode === undefined) {
+            return null
+        }
+
+        // TODO: handle more cases
+        const scopeName =
+            tsNode.kind ===
+            /** @type {import('typescript')} */ (ts).SyntaxKind
+                .VariableDeclaration
+                ? /** @type {import('typescript').VariableDeclaration} */ (
+                      tsNode
+                  ).name.getText()
+                : null
+
+        if (scopeName === null) {
+            return null
+        }
+
+        const localName = getNodeScopedNameHelper(node.property, parserServices)
+
+        if (localName === null) {
+            return null
+        }
+
+        return `${scopeName}.${localName}`
+    }
+
+    if (node.type === "Identifier") {
+        return node.name
+    }
+
+    return null
+}

tests/lib/rules/no-sync.js

@@ -193,7 +193,7 @@ stylesheet.replaceSync("body { font-size: 1.4em; } p { color: red; }");
                     ignores: [
                         {
                             from: "lib",
-                            name: ["replaceSync"],
+                            name: ["CSSStyleSheet.replaceSync"],
                         },
                     ],
                 },
@@ -257,15 +257,15 @@ stylesheet.replaceSync("body { font-size: 1.4em; } p { color: red; }");
                     ignores: [
                         {
                             from: "file",
-                            name: ["replaceSync"],
+                            name: ["CSSStyleSheet.replaceSync"],
                         },
                     ],
                 },
             ],
             errors: [
                 {
                     messageId: "noSync",
-                    data: { propertyName: "replaceSync" },
+                    data: { propertyName: "CSSStyleSheet.replaceSync" },
                     type: "MemberExpression",
                 },
             ],