refactor: add eslint-plugin-unicorn

danielpza · danielpza · commit 44ad2e02f9b5 · 2024-08-18T23:39:12.000-04:00
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -1,13 +1,16 @@
+// @ts-check
 import globals from "globals";
 import pluginJs from "@eslint/js";
 import tseslint from "typescript-eslint";
+import eslintPluginUnicorn from "eslint-plugin-unicorn";
 
 export default [
   { files: ["**/*.{js,mjs,cjs,ts}"] },
   { ignores: ["**/dist/", "test/projects/"] },
   { languageOptions: { globals: globals.node } },
   pluginJs.configs.recommended,
   ...tseslint.configs.recommended,
+  eslintPluginUnicorn.configs["flat/recommended"],
   {
     rules: {
       "@typescript-eslint/no-empty-object-type": ["error", { allowInterfaces: "with-single-extends" }],
@@ -25,7 +28,21 @@ export default [
   },
   {
     rules: {
+      // fix these warnings
       "@typescript-eslint/no-explicit-any": "warn",
+      "unicorn/consistent-function-scoping": "warn",
+      "unicorn/explicit-length-check": "warn",
+      "unicorn/import-style": "warn",
+      "unicorn/no-array-reduce": "warn",
+      "unicorn/no-nested-ternary": "warn",
+      "unicorn/prefer-regexp-test": "warn",
+      "unicorn/prefer-string-slice": "warn",
+      // disable strict rules/not applicable
+      "unicorn/empty-brace-spaces": "off", // conflict with prettier
+      "unicorn/no-array-callback-reference": "off",
+      "unicorn/prefer-module": "off",
+      "unicorn/prefer-ternary": "off",
+      "unicorn/prevent-abbreviations": "off",
     },
   },
 ];
diff --git a/package.json b/package.json
@@ -72,6 +72,7 @@
     "@types/typescript-4.7": "npm:typescript@4.7.x",
     "changelogen": "^0.5.5",
     "eslint": "9.x",
+    "eslint-plugin-unicorn": "^55.0.0",
     "globals": "^15.9.0",
     "prettier": "^3.3.3",
     "prettier-plugin-jsdoc": "^1.3.0",
diff --git a/src/harmony/versions/four-seven.ts b/src/harmony/versions/four-seven.ts
@@ -46,7 +46,7 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
   const factory = context.tsFactory as unknown as TsFourSevenModule.NodeFactory;
 
   switch (prop) {
-    case "updateImportDeclaration":
+    case "updateImportDeclaration": {
       return function (
         node: ImportDeclaration,
         _modifiers: readonly Modifier[] | undefined,
@@ -70,7 +70,8 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
           dsAssertClause,
         );
       };
-    case "updateExportDeclaration":
+    }
+    case "updateExportDeclaration": {
       return function (
         node: ExportDeclaration,
         _modifiers: readonly Modifier[] | undefined,
@@ -96,7 +97,8 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
           dsAssertClause,
         );
       };
-    case "updateModuleDeclaration":
+    }
+    case "updateModuleDeclaration": {
       return function (
         node: ModuleDeclaration,
         _modifiers: readonly Modifier[] | undefined,
@@ -107,8 +109,10 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
 
         return factory.updateModuleDeclaration(dsNode, dsNode.decorators, dsNode.modifiers, dsName, dsBody);
       };
-    default:
+    }
+    default: {
       return (...args: any) => (<any>factory)[prop](...args);
+    }
   }
 }
 
diff --git a/src/harmony/versions/three-eight.ts b/src/harmony/versions/three-eight.ts
@@ -65,9 +65,10 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
   const ts = context.tsInstance as unknown as typeof TsThreeEightModule;
 
   switch (prop) {
-    case "updateCallExpression":
+    case "updateCallExpression": {
       return (...args: any) => ts.updateCall.apply(void 0, args);
-    case "updateImportClause":
+    }
+    case "updateImportClause": {
       return function (
         node: ImportClause,
         _isTypeOnly: boolean,
@@ -77,7 +78,8 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
         // @ts-expect-error TODO investigate type issue
         return ts.updateImportClause.apply(void 0, downSample(node, name, namedBindings));
       };
-    case "updateImportDeclaration":
+    }
+    case "updateImportDeclaration": {
       return function (
         node: ImportDeclaration,
         _modifiers: readonly Modifier[] | undefined,
@@ -94,7 +96,8 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
           dsModuleSpecifier,
         );
       };
-    case "updateExportDeclaration":
+    }
+    case "updateExportDeclaration": {
       return function (
         node: ExportDeclaration,
         _modifiers: readonly Modifier[] | undefined,
@@ -112,7 +115,8 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
           dsNode.isTypeOnly,
         );
       };
-    case "updateModuleDeclaration":
+    }
+    case "updateModuleDeclaration": {
       return function (
         node: ModuleDeclaration,
         _modifiers: readonly Modifier[] | undefined,
@@ -123,7 +127,8 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
 
         return ts.updateModuleDeclaration(dsNode, dsNode.decorators, dsNode.modifiers, dsName, dsBody);
       };
-    case "updateImportTypeNode":
+    }
+    case "updateImportTypeNode": {
       return function (
         node: ImportTypeNode,
         argument: TypeNode,
@@ -136,8 +141,10 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
 
         return ts.updateImportTypeNode(dsNode, dsArgument, dsQualifier, dsTypeArguments, isTypeOf);
       };
-    default:
+    }
+    default: {
       return (...args: any) => (<any>ts)[prop](...args);
+    }
   }
 }
 
diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,5 @@
-import transformer from "./transformer";
-export default transformer;
-
 export type { TsTransformPathsConfig } from "./types";
 export { register } from "./register";
 export { nxTransformerPlugin } from "./plugins";
+
+export { default } from "./transformer";
diff --git a/src/plugins/nx-transformer-plugin.ts b/src/plugins/nx-transformer-plugin.ts
@@ -33,4 +33,4 @@ export const before: NxTransformerFactory = (pluginConfig, program) =>
   pluginConfig?.afterDeclarations ? voidTransformer : transformer(program, { ...pluginConfig });
 
 export const afterDeclarations: NxTransformerFactory = (pluginConfig, program) =>
-  !pluginConfig?.afterDeclarations ? voidTransformer : transformer(program, { ...pluginConfig });
+  pluginConfig?.afterDeclarations ? transformer(program, { ...pluginConfig }) : voidTransformer;
diff --git a/src/transformer.ts b/src/transformer.ts
@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import ts, { CompilerOptions } from "typescript";
 import { RunMode, TsNodeState, TsTransformPathsConfig, TsTransformPathsContext, VisitorContext } from "./types";
 import { nodeVisitor } from "./visitor";
@@ -52,7 +52,7 @@ function getTsProperties(args: Parameters<typeof transformer>) {
       tsNodeState === TsNodeState.Full
         ? compilerOptions!
         : {
-            ...(program?.getCompilerOptions() ?? {}),
+            ...program?.getCompilerOptions(),
             ...tsNodeProps!.compilerOptions,
           };
   } else {
diff --git a/src/utils/general-utils.ts b/src/utils/general-utils.ts
@@ -1,5 +1,5 @@
-import url from "url";
-import path from "path";
+import url from "node:url";
+import path from "node:path";
 
 /* ****************************************************************************************************************** *
  * General Utilities & Helpers
diff --git a/src/utils/get-relative-path.ts b/src/utils/get-relative-path.ts
@@ -1,6 +1,6 @@
-import fs from "fs";
-import * as os from "os";
-import path from "path";
+import fs from "node:fs";
+import * as os from "node:os";
+import path from "node:path";
 
 /* ****************************************************************************************************************** */
 // region: Locals
@@ -21,7 +21,7 @@ function tryRmFile(fileName: string) {
 }
 
 function getIsFsCaseSensitive() {
-  if (isCaseSensitiveFilesystem != null) return isCaseSensitiveFilesystem;
+  if (isCaseSensitiveFilesystem != undefined) return isCaseSensitiveFilesystem;
 
   for (let i = 0; i < 1000; i++) {
     const tmpFileName = path.join(os.tmpdir(), `tstp~${i}.tmp`);
diff --git a/src/utils/resolve-module-name.ts b/src/utils/resolve-module-name.ts
@@ -1,6 +1,6 @@
 import { VisitorContext } from "../types";
 import { isBaseDir, isURL, maybeAddRelativeLocalPrefix } from "./general-utils";
-import * as path from "path";
+import * as path from "node:path";
 import { removeFileExtension, removeSuffix, ResolvedModuleFull, SourceFile } from "typescript";
 import { getOutputDirForSourceFile } from "./ts-helpers";
 import { getRelativePath } from "./get-relative-path";
@@ -32,7 +32,7 @@ function getPathDetail(moduleName: string, resolvedModule: ResolvedModuleFull) {
   const resolvedBaseNameNoExtension = resolvedBaseName && removeFileExtension(resolvedBaseName);
   const resolvedExtName = resolvedBaseName && path.extname(resolvedFileName);
 
-  let baseName = !implicitPackageIndex ? path.basename(moduleName) : void 0;
+  let baseName = implicitPackageIndex ? void 0 : path.basename(moduleName);
   let baseNameNoExtension = baseName && removeFileExtension(baseName);
   let extName = baseName && path.extname(moduleName);
 
diff --git a/src/utils/resolve-path-update-node.ts b/src/utils/resolve-path-update-node.ts
@@ -22,9 +22,9 @@ export function resolvePathAndUpdateNode(
 
   // Accommodate direct override via @transform-path tag
   if (tags.overridePath) {
-    const transformedPath = !isURL(tags.overridePath)
-      ? maybeAddRelativeLocalPrefix(normalizePath(tags.overridePath))
-      : tags.overridePath;
+    const transformedPath = isURL(tags.overridePath)
+      ? tags.overridePath
+      : maybeAddRelativeLocalPrefix(normalizePath(tags.overridePath));
     return updaterFn(factory.createStringLiteral(transformedPath));
   }
 
@@ -63,7 +63,7 @@ export function resolvePathAndUpdateNode(
     if (targetNode.pos >= 0) {
       try {
         const trivia = targetNode.getFullText(sourceFile).slice(0, targetNode.getLeadingTriviaWidth(sourceFile));
-        const regex = /^\s*\/\/\/?\s*@(transform-path|no-transform-path)(?:[^\S\r\n](.+?))?$/gim;
+        const regex = /^\s*\/{2,3}\s*@(transform-path|no-transform-path)(?:[^\S\n\r](.+?))?$/gim;
 
         for (let match = regex.exec(trivia); match; match = regex.exec(trivia))
           if (match[1]) commentTags.set(match[1], match[2]);
diff --git a/src/utils/ts-helpers.ts b/src/utils/ts-helpers.ts
@@ -1,5 +1,5 @@
 import ts, { GetCanonicalFileName, SourceFile } from "typescript";
-import path from "path";
+import path from "node:path";
 import { VisitorContext } from "../types";
 import type { REGISTER_INSTANCE } from "ts-node";
 
@@ -78,10 +78,10 @@ export function getTsNodeRegistrationProperties(tsInstance: typeof ts) {
     // eslint-disable-next-line @typescript-eslint/no-require-imports
     tsNodeSymbol = require("ts-node")?.["REGISTER_INSTANCE"];
   } catch {
-    return undefined;
+    return;
   }
 
-  if (!global.process[tsNodeSymbol]) return undefined;
+  if (!global.process[tsNodeSymbol]) return;
 
   const { config, options } = global.process[tsNodeSymbol]!;
 
diff --git a/test/config.ts b/test/config.ts
@@ -1,9 +1,7 @@
 import ts from "typescript";
 import tsThree from "typescript-3";
 import tsFourSeven from "typescript-4.7";
-import path from "path";
-
-export { ts };
+import path from "node:path";
 
 export const tsModules = <const>[
   ["3.6.5", tsThree, "typescript-3"],
@@ -16,3 +14,5 @@ export const transformerPath = require.resolve("typescript-transform-paths");
 export const builtTransformerPath = require.resolve("typescript-transform-paths");
 
 Error.stackTraceLimit = 120;
+
+export { default as ts } from "typescript";
diff --git a/test/jest.config.ts b/test/jest.config.ts
@@ -3,7 +3,7 @@ import type { JestConfigWithTsJest } from "ts-jest";
 const config: JestConfigWithTsJest = {
   testEnvironment: "node",
   preset: "ts-jest",
-  testRegex: ".*(test|spec)\\.tsx?$",
+  testRegex: String.raw`.*(test|spec)\.tsx?$`,
   moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
 };
 
diff --git a/test/tests/extras.test.ts b/test/tests/extras.test.ts
@@ -1,9 +1,9 @@
 import { createTsProgram, getEmitResultFromProgram, ModuleNotFoundError } from "../utils";
 import { projectsPaths } from "../config";
-import path from "path";
+import path from "node:path";
 import ts from "typescript";
 import * as config from "../config";
-import { execSync } from "child_process";
+import { execSync } from "node:child_process";
 
 /* ****************************************************************************************************************** *
  * Tests
diff --git a/test/tests/project-ref.test.ts b/test/tests/project-ref.test.ts
@@ -1,5 +1,5 @@
 // noinspection ES6UnusedImports
-import * as path from "path";
+import * as path from "node:path";
 import { createTsSolutionBuilder, EmittedFiles } from "../utils";
 import { projectsPaths, ts } from "../config";
 
diff --git a/test/tests/register.test.ts b/test/tests/register.test.ts
@@ -24,14 +24,14 @@ const configs = {
 const configMap = Object.entries(configs).map(([label, cfg]) => {
   let hasBefore: boolean = false;
   let hasAfterDeclarations: boolean = false;
-  const transformers = [cfg]
-    .flat()
-    .map((c) => {
+  const transformers = [
+    ...[cfg].flat().map((c) => {
       if ((<any>c).before || !(<any>c).afterDeclarations) hasBefore = true;
       if ((<any>c).afterDeclarations) hasAfterDeclarations = true;
       return { transform: "typescript-transform-paths", ...c, ...pluginOptions } as PluginConfig;
-    })
-    .concat([otherTransformer]);
+    }),
+    otherTransformer,
+  ] as PluginConfig[];
 
   return { label, transformers, hasBefore, hasAfterDeclarations };
 });
@@ -140,14 +140,17 @@ describe(`Register script`, () => {
 
       let existingTransformers: CustomTransformers | ((p: Program) => CustomTransformers) | undefined;
       switch (configKind) {
-        case "Existing Transformer Config Factory":
+        case "Existing Transformer Config Factory": {
           existingTransformers = transformerFactoryFn;
           break;
-        case "Existing Transformer Config":
+        }
+        case "Existing Transformer Config": {
           existingTransformers = { ...fakeTransformerConfig };
           break;
-        case "No Existing Transformers":
+        }
+        case "No Existing Transformers": {
           existingTransformers = void 0;
+        }
       }
 
       describe.each(configMap)(`$label`, ({ transformers, hasBefore, hasAfterDeclarations }) => {
diff --git a/test/tests/transformer/general.test.ts b/test/tests/transformer/general.test.ts
@@ -1,5 +1,5 @@
 // noinspection ES6UnusedImports
-import * as path from "path";
+import * as path from "node:path";
 import { createTsProgram, EmittedFiles, getEmitResultFromProgram } from "../../utils";
 import { ts, tsModules, projectsPaths } from "../../config";
 
@@ -15,8 +15,8 @@ const makeRelative = (tsInstance: typeof ts, fileName: string, p: string, rootDi
 
 const getExpected = (tsInstance: typeof ts, fileName: string, original: string, rootDir: string): string =>
   original
-    .replace(/"@(.*)"/g, (_, p) => makeRelative(tsInstance, fileName, p, rootDir))
-    .replace(/"#utils\/(.*)"/g, (_, p) =>
+    .replaceAll(/"@(.*)"/g, (_, p) => makeRelative(tsInstance, fileName, p, rootDir))
+    .replaceAll(/"#utils\/(.*)"/g, (_, p) =>
       makeRelative(tsInstance, fileName, path.join(p === "hello" ? "secondary" : "utils", p), rootDir),
     )
     .replace('"path"', '"https://external.url/path.js"')
diff --git a/test/tests/transformer/specific.test.ts b/test/tests/transformer/specific.test.ts
diff --git a/test/utils/helpers.ts b/test/utils/helpers.ts
diff --git a/yarn.lock b/yarn.lock
