fix: Revert "feat: add support for ignoring sync methods from certain…

… locations" (#416)
eslint-community · Mar 4, 2025 · 0779e2f · 0779e2f
1 parent 90de242
commit 0779e2f
Show file tree

Hide file tree

Showing 18 changed files with 9 additions and 543 deletions.
diff --git a/docs/rules/no-sync.md b/docs/rules/no-sync.md
@@ -61,7 +61,6 @@ fs.readFileSync(somePath).toString();
 #### ignores
 
 You can `ignore` specific function names using this option.
-Additionally, if you are using TypeScript you can optionally specify where the function is declared.
 
 Examples of **incorrect** code for this rule with the `{ ignores: ['readFileSync'] }` option:
 
@@ -79,62 +78,6 @@ Examples of **correct** code for this rule with the `{ ignores: ['readFileSync']
 fs.readFileSync(somePath);
 ```
 
-##### Advanced (TypeScript only)
-
-You can provide a list of specifiers to ignore. Specifiers are typed as follows:
-
-```ts
-type Specifier =
-| string
-| {
-    from: "file";
-    path?: string;
-    name?: string[];
-  }
-| {
-    from: "package";
-    package?: string;
-    name?: string[];
-  }
-| {
-    from: "lib";
-    name?: string[];
-  }
-```
-
-###### From a file
-
-Examples of **correct** code for this rule with the ignore file specifier:
-
-```js
-/*eslint n/no-sync: ["error", { ignores: [{ from: 'file', path: './foo.ts' }]}] */
-
-import { fooSync } from "./foo"
-fooSync()
-```
-
-###### From a package
-
-Examples of **correct** code for this rule with the ignore package specifier:
-
-```js
-/*eslint n/no-sync: ["error", { ignores: [{ from: 'package', package: 'effect' }]}] */
-
-import { Effect } from "effect"
-const value = Effect.runSync(Effect.succeed(42))
-```
-
-###### From the TypeScript library
-
-Examples of **correct** code for this rule with the ignore lib specifier:
-
-```js
-/*eslint n/no-sync: ["error", { ignores: [{ from: 'lib' }]}] */
-
-const stylesheet = new CSSStyleSheet()
-stylesheet.replaceSync("body { font-size: 1.4em; } p { color: red; }")
-```
-
 ## 🔎 Implementation
 
 - [Rule source](../../lib/rules/no-sync.js)

diff --git a/lib/rules/no-sync.js b/lib/rules/no-sync.js
@@ -4,14 +4,6 @@
  */
 "use strict"
 
-const typeMatchesSpecifier =
-    /** @type {import('ts-declaration-location').default} */ (
-        /** @type {unknown} */ (require("ts-declaration-location"))
-    )
-const getTypeOfNode = require("../util/get-type-of-node")
-const getParserServices = require("../util/get-parser-services")
-const getFullTypeName = require("../util/get-full-type-name")
-
 const selectors = [
     // fs.readFileSync()
     // readFileSync.call(null, 'path')
@@ -40,56 +32,7 @@ module.exports = {
                     },
                     ignores: {
                         type: "array",
-                        items: {
-                            oneOf: [
-                                { type: "string" },
-                                {
-                                    type: "object",
-                                    properties: {
-                                        from: { const: "file" },
-                                        path: {
-                                            type: "string",
-                                        },
-                                        name: {
-                                            type: "array",
-                                            items: {
-                                                type: "string",
-                                            },
-                                        },
-                                    },
-                                    additionalProperties: false,
-                                },
-                                {
-                                    type: "object",
-                                    properties: {
-                                        from: { const: "lib" },
-                                        name: {
-                                            type: "array",
-                                            items: {
-                                                type: "string",
-                                            },
-                                        },
-                                    },
-                                    additionalProperties: false,
-                                },
-                                {
-                                    type: "object",
-                                    properties: {
-                                        from: { const: "package" },
-                                        package: {
-                                            type: "string",
-                                        },
-                                        name: {
-                                            type: "array",
-                                            items: {
-                                                type: "string",
-                                            },
-                                        },
-                                    },
-                                    additionalProperties: false,
-                                },
-                            ],
-                        },
+                        items: { type: "string" },
                         default: [],
                     },
                 },
@@ -114,64 +57,15 @@ module.exports = {
              * @returns {void}
              */
             [selector.join(",")](node) {
-                const parserServices = getParserServices(context)
-
-                /**
-                 * @type {import('typescript').Type | undefined | null}
-                 */
-                let type = undefined
-
-                /**
-                 * @type {string | undefined | null}
-                 */
-                let fullName = undefined
-
-                for (const ignore of ignores) {
-                    if (typeof ignore === "string") {
-                        if (ignore === node.name) {
-                            return
-                        }
-
-                        continue
-                    }
-
-                    if (
-                        parserServices === null ||
-                        parserServices.program === null
-                    ) {
-                        throw new Error(
-                            'TypeScript parser services not available. Rule "n/no-sync" is configured to use "ignores" option with a non-string value. This requires TypeScript parser services to be available.'
-                        )
-                    }
-
-                    type =
-                        type === undefined
-                            ? getTypeOfNode(node, parserServices)
-                            : type
-
-                    fullName =
-                        fullName === undefined
-                            ? getFullTypeName(type)
-                            : fullName
-
-                    if (
-                        typeMatchesSpecifier(
-                            parserServices.program,
-                            ignore,
-                            type
-                        ) &&
-                        (ignore.name === undefined ||
-                            ignore.name.includes(fullName ?? node.name))
-                    ) {
-                        return
-                    }
+                if (ignores.includes(node.name)) {
+                    return
                 }
 
                 context.report({
                     node: node.parent,
                     messageId: "noSync",
                     data: {
-                        propertyName: fullName ?? node.name,
+                        propertyName: node.name,
                     },
                 })
             },

diff --git a/lib/util/get-full-type-name.js b/lib/util/get-full-type-name.js
diff --git a/lib/util/get-parser-services.js b/lib/util/get-parser-services.js
diff --git a/lib/util/get-type-of-node.js b/lib/util/get-type-of-node.js
diff --git a/package.json b/package.json
@@ -18,23 +18,21 @@
     },
     "dependencies": {
         "@eslint-community/eslint-utils": "^4.4.1",
-        "@typescript-eslint/utils": "^8.21.0",
         "enhanced-resolve": "^5.17.1",
         "eslint-plugin-es-x": "^7.8.0",
         "get-tsconfig": "^4.8.1",
         "globals": "^15.11.0",
         "ignore": "^5.3.2",
         "minimatch": "^9.0.5",
-        "semver": "^7.6.3",
-        "ts-declaration-location": "^1.0.5"
+        "semver": "^7.6.3"
     },
     "devDependencies": {
         "@eslint/js": "^9.14.0",
         "@types/eslint": "^9.6.1",
         "@types/estree": "^1.0.6",
         "@types/node": "^20.17.5",
-        "@typescript-eslint/parser": "^8.21.0",
-        "@typescript-eslint/typescript-estree": "^8.21.0",
+        "@typescript-eslint/parser": "^8.12.2",
+        "@typescript-eslint/typescript-estree": "^8.12.2",
         "eslint": "^9.14.0",
         "eslint-config-prettier": "^9.1.0",
         "eslint-doc-generator": "^1.7.1",
@@ -54,7 +52,7 @@
         "rimraf": "^5.0.10",
         "ts-ignore-import": "^4.0.1",
         "type-fest": "^4.26.1",
-        "typescript": "^5.7"
+        "typescript": "~5.6"
     },
     "scripts": {
         "build": "node scripts/update",

diff --git a/tests/fixtures/no-sync/base/file.ts b/tests/fixtures/no-sync/base/file.ts
diff --git a/tests/fixtures/no-sync/base/tsconfig.json b/tests/fixtures/no-sync/base/tsconfig.json
diff --git a/tests/fixtures/no-sync/file.ts b/tests/fixtures/no-sync/file.ts
diff --git a/tests/fixtures/no-sync/ignore-package/file.ts b/tests/fixtures/no-sync/ignore-package/file.ts
diff --git a/tests/fixtures/no-sync/ignore-package/node_modules/aaa/index.d.ts b/tests/fixtures/no-sync/ignore-package/node_modules/aaa/index.d.ts
diff --git a/tests/fixtures/no-sync/ignore-package/node_modules/aaa/index.js b/tests/fixtures/no-sync/ignore-package/node_modules/aaa/index.js
diff --git a/tests/fixtures/no-sync/ignore-package/node_modules/aaa/package.json b/tests/fixtures/no-sync/ignore-package/node_modules/aaa/package.json
diff --git a/tests/fixtures/no-sync/ignore-package/package.json b/tests/fixtures/no-sync/ignore-package/package.json
diff --git a/tests/fixtures/no-sync/ignore-package/tsconfig.json b/tests/fixtures/no-sync/ignore-package/tsconfig.json
diff --git a/tests/fixtures/no-sync/tsconfig.json b/tests/fixtures/no-sync/tsconfig.json