refactor: replace synckit with make-synchronized (#1366)

Author: fisker

package.json

@@ -12,10 +12,10 @@
     "escape-string-regexp": "^4.0.0",
     "espree": "^10.1.0",
     "esquery": "^1.6.0",
+    "make-synchronized": "^0.3.0",
     "parse-imports": "^2.1.1",
     "semver": "^7.6.3",
-    "spdx-expression-parse": "^4.0.0",
-    "synckit": "^0.9.1"
+    "spdx-expression-parse": "^4.0.0"
   },
   "description": "JSDoc linting rules for ESLint.",
   "devDependencies": {
@@ -146,7 +146,7 @@
   "scripts": {
     "tsc": "tsc",
     "tsc-build": "tsc -p tsconfig-prod.json",
-    "build": "rimraf ./dist && cross-env NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && cp src/import-worker.mjs dist/import-worker.mjs && pnpm tsc-build",
+    "build": "rimraf ./dist && cross-env NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build",
     "check-docs": "babel-node ./src/bin/generateDocs.js --check",
     "create-docs": "npm run create-options && babel-node ./src/bin/generateDocs.js",
     "create-rule": "babel-node ./src/bin/generateRule.js",

pnpm-lock.yaml

@@ -0,0 +1,11 @@
+import makeSynchronized from 'make-synchronized';
+
+// ESLint doesn't support async rules
+export default makeSynchronized(import.meta.url, async (imprt) => {
+  const {parseImports} = await import('parse-imports')
+  try {
+    return [...await parseImports(imprt)];
+  } catch (err) {
+    return false;
+  }
+})

src/getImports.js

@@ -1,13 +1,10 @@
 import { dirname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
-import { createSyncFn } from 'synckit';
 import semver from 'semver';
 import spdxExpressionParse from 'spdx-expression-parse';
 import iterateJsdoc from '../iterateJsdoc.js';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const pathName = join(__dirname, '../import-worker.mjs');
+import getImports from '../getImports.js';
 
 const allowedKinds = new Set([
   'class',
@@ -175,7 +172,6 @@ export default iterateJsdoc(({
         ? `${typePart}${name} ${description}`
         : `${typePart}${name}`);
 
-      const getImports = createSyncFn(pathName);
       if (!getImports(imprt)) {
         report(
           `Bad @import tag`,

src/import-worker.mjs

@@ -1,7 +1,6 @@
 import { dirname, join } from 'path';
 import { fileURLToPath } from 'url';
 
-import { createSyncFn } from 'synckit';
 import {
   getJSDocComment,
   parse as parseType,
@@ -11,9 +10,7 @@ import {
 import iterateJsdoc, {
   parseComment,
 } from '../iterateJsdoc.js';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const pathName = join(__dirname, '../import-worker.mjs');
+import getImports from '../getImports.js';
 
 const extraTypes = [
   'null', 'undefined', 'void', 'string', 'boolean', 'object',
@@ -152,7 +149,6 @@ export default iterateJsdoc(({
       ? `${typePart}${name} ${description}`
       : `${typePart}${name}`);
 
-    const getImports = createSyncFn(pathName);
     const imports = /** @type {import('parse-imports').Import[]} */ (getImports(imprt));
     if (!imports) {
       return null;

src/rules/checkValues.js

@@ -18,7 +18,6 @@
     "test/**/*.js",
     "typings/gitdown.d.ts",
     "typings/babel__eslint-parser.d.ts",
-    "src/import-worker.mjs"
   ],
   "exclude": ["node_modules"]
 }