[DRAFT1] migrate from prettier+eslint to biome

.github/workflows/build.yml

@@ -15,14 +15,17 @@ jobs:
       - uses: actions/checkout@v4
       - name: corepack
         run: corepack enable
+      - uses: biomejs/setup-biome@v2
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: "yarn"
       - name: install
         run: yarn
       - name: lint
-        run: yarn lint
+        run: biome lint
+      - name: format
+        run: biome format
       - name: build
         run: yarn build
       - name: test

.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-  "recommendations": []
+  "recommendations": ["biomejs.biome"]
 }

.vscode/settings.json

@@ -3,7 +3,7 @@
     "source.fixAll.eslint": "explicit"
   },
   "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.defaultFormatter": "biomejs.biome",
   "editor.rulers": [80, 120],
   "editor.tabSize": 2,
   "search.exclude": {

biome.json

@@ -0,0 +1,135 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.0/schema.json",
+  "files": {
+    "maxSize": 5242880,
+    "ignore": ["**/__fixtures__/**", "package.json"]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "lineWidth": 100
+  },
+  "linter": {
+    "rules": {
+      "recommended": true,
+      "complexity": {
+        "noBannedTypes": "error",
+        "noExtraBooleanCast": "error",
+        "noForEach": "off",
+        "noMultipleSpacesInRegularExpressionLiterals": "error",
+        "noUselessCatch": "error",
+        "noUselessTypeConstraint": "error",
+        "noWith": "error",
+        "useFlatMap": "off",
+        "useOptionalChain": "off"
+      },
+      "correctness": {
+        "noConstAssign": "error",
+        "noConstantCondition": "error",
+        "noEmptyCharacterClassInRegex": "error",
+        "noEmptyPattern": "error",
+        "noGlobalObjectCalls": "error",
+        "noInnerDeclarations": "error",
+        "noInvalidConstructorSuper": "error",
+        "noNewSymbol": "error",
+        "noNonoctalDecimalEscape": "error",
+        "noPrecisionLoss": "error",
+        "noSelfAssign": "error",
+        "noSetterReturn": "error",
+        "noSwitchDeclarations": "error",
+        "noUndeclaredVariables": "error",
+        "noUnreachable": "error",
+        "noUnreachableSuper": "error",
+        "noUnsafeFinally": "error",
+        "noUnsafeOptionalChaining": "error",
+        "noUnusedLabels": "error",
+        "noUnusedVariables": "error",
+        "useArrayLiterals": "off",
+        "useIsNan": "error",
+        "useValidForDirection": "error",
+        "useYield": "error"
+      },
+      "performance": {
+        "noAccumulatingSpread": "off"
+      },
+      "style": {
+        "noNamespace": "error",
+        "noNonNullAssertion": "off",
+        "noUnusedTemplateLiteral": "off",
+        "useAsConstAssertion": "error",
+        "useConsistentArrayType": {
+          "level": "error",
+          "options": { "syntax": "shorthand" }
+        },
+        "useImportType": "off",
+        "useNodejsImportProtocol": "off",
+        "useTemplate": "off"
+      },
+      "suspicious": {
+        "noAsyncPromiseExecutor": "error",
+        "noCatchAssign": "error",
+        "noClassAssign": "error",
+        "noCompareNegZero": "error",
+        "noControlCharactersInRegex": "error",
+        "noDebugger": "error",
+        "noDuplicateCase": "error",
+        "noDuplicateClassMembers": "error",
+        "noDuplicateObjectKeys": "error",
+        "noDuplicateParameters": "error",
+        "noEmptyBlockStatements": "error",
+        "noExplicitAny": "error",
+        "noExtraNonNullAssertion": "error",
+        "noFallthroughSwitchClause": "error",
+        "noFunctionAssign": "error",
+        "noGlobalAssign": "error",
+        "noImportAssign": "error",
+        "noMisleadingCharacterClass": "error",
+        "noMisleadingInstantiator": "error",
+        "noPrototypeBuiltins": "error",
+        "noRedeclare": "error",
+        "noShadowRestrictedNames": "error",
+        "noUnsafeDeclarationMerging": "error",
+        "noUnsafeNegation": "error",
+        "useGetterReturn": "error",
+        "useValidTypeof": "error"
+      }
+    },
+    "ignore": ["**/__fixtures__"]
+  },
+  "javascript": { "formatter": { "trailingCommas": "es5" } },
+  "overrides": [
+    {
+      "include": ["*.ts", "*.tsx", "*.mts", "*.cts"],
+      "linter": {
+        "rules": {
+          "correctness": {
+            "noConstAssign": "off",
+            "noGlobalObjectCalls": "off",
+            "noInvalidConstructorSuper": "off",
+            "noInvalidNewBuiltin": "off",
+            "noNewSymbol": "off",
+            "noSetterReturn": "off",
+            "noUndeclaredVariables": "off",
+            "noUnreachable": "off",
+            "noUnreachableSuper": "off"
+          },
+          "style": {
+            "noArguments": "error",
+            "noVar": "error",
+            "useConst": "error"
+          },
+          "suspicious": {
+            "noDuplicateClassMembers": "off",
+            "noDuplicateObjectKeys": "off",
+            "noDuplicateParameters": "off",
+            "noFunctionAssign": "off",
+            "noImportAssign": "off",
+            "noRedeclare": "off",
+            "noUnsafeNegation": "off",
+            "useGetterReturn": "off"
+          }
+        }
+      }
+    }
+  ]
+}

lefthook.yml

@@ -0,0 +1,5 @@
+pre-commit:
+  commands:
+    check:
+      glob: "*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}"
+      run: yarn biome check --write --no-errors-on-unmatched --files-ignore-unknown=true {staged_files} && git update-index --again

package.json

@@ -34,28 +34,22 @@
   },
   "scripts": {
     "build": "tsc",
-    "lint": "eslint 'src/**/*.ts'",
-    "prepare": "simple-git-hooks",
+    "lint": "biome lint",
+    "prepare": "lefthook install",
     "release": "yarn build && changeset publish",
     "test": "vitest"
   },
   "dependencies": {
     "jscodeshift": "0.15.2"
   },
   "devDependencies": {
+    "@biomejs/biome": "1.8.0",
     "@changesets/cli": "^2.27.1",
     "@tsconfig/node14": "^14.1.0",
     "@types/jscodeshift": "^0.11.11",
     "@types/node": "^14.18.33",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
-    "@typescript-eslint/parser": "^7.2.0",
     "aws-sdk": "2.1597.0",
-    "eslint": "^8.57.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-sort-export-all": "^1.4.1",
-    "lint-staged": "^15.2.2",
-    "prettier": "3.2.5",
-    "simple-git-hooks": "^2.11.0",
+    "lefthook": "^1.6.15",
     "tsx": "^4.7.1",
     "typescript": "~5.4.2",
     "vitest": "~1.6.0"
@@ -64,13 +58,6 @@
     "node": ">=14.0.0"
   },
   "packageManager": "[email protected]",
-  "lint-staged": {
-    "*.ts": [
-      "eslint --fix",
-      "prettier --write"
-    ],
-    "*.{json,md}": "prettier --write"
-  },
   "publishConfig": {
     "provenance": true
   }

scripts/generateClientTypesMap/getClientTypesMap.ts

@@ -125,6 +125,7 @@ export const getClientTypesMap = async (clientName: string): Promise<Record<stri
   });
 
   const updatedClientTypesMap = getClientTypesMapWithKeysRemovedFromValues(clientTypesMap);
+  // biome-ignore lint/complexity/useLiteralKeys: script
   clientTypesMap["ClientConfiguration"] = `${CLIENT_NAMES_MAP[clientName]}ClientConfig`;
 
   return Object.entries(updatedClientTypesMap)

src/cli.ts

@@ -21,7 +21,6 @@
 // Most of the code from here is from bin/jscodeshift.js
 // It's kept that way so that users can reuse jscodeshift options.
 
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-nocheck
 import path from "path";
 import Runner from "jscodeshift/dist/Runner";
@@ -53,6 +52,8 @@ const disclaimerLines = [
 
 const parser = getJsCodeshiftParser();
 
+// biome-ignore lint/style/useSingleVarDeclarator: ignore
+// biome-ignore lint/suspicious/noImplicitAnyLet: ignore
 let options, positionalArguments;
 try {
   ({ options, positionalArguments } = parser.parse());
@@ -89,6 +90,7 @@ function run(paths, options) {
 
 if (options.stdin) {
   let buffer = "";
+  // biome-ignore lint/suspicious/noAssignInExpressions: ignore
   process.stdin.on("data", (data) => (buffer += data));
   process.stdin.on("end", () => run(buffer.split("\n"), options));
 } else {

src/transforms/v2-to-v3/apis/removePromiseForCallExpression.ts

@@ -15,6 +15,21 @@ export const removePromiseForCallExpression = (
       ).object;
       break;
     }
+    case "ArrowFunctionExpression":
+    case "AwaitExpression":
+    case "CallExpression":
+    case "ExpressionStatement":
+    case "ObjectProperty":
+    case "ReturnStatement":
+    case "VariableDeclarator": {
+      const currentCalleeObject = (callExpression.value.callee as MemberExpression)
+        .object as CallExpression;
+      if (currentCalleeObject.arguments.length > 0) {
+        callExpression.value.arguments = currentCalleeObject.arguments;
+      }
+      callExpression.value.callee = currentCalleeObject.callee;
+      break;
+    }
     default: {
       emitWarning(
         `Removal of .promise() not implemented for parentPath: ${callExpression.parentPath.value.type}\n` +
@@ -33,21 +48,6 @@ export const removePromiseForCallExpression = (
         )
       );
       callExpression.parentPath.node.comments = comments;
-    }
-    // eslint-disable-next-line no-fallthrough
-    case "ArrowFunctionExpression":
-    case "AwaitExpression":
-    case "CallExpression":
-    case "ExpressionStatement":
-    case "ObjectProperty":
-    case "ReturnStatement":
-    case "VariableDeclarator": {
-      const currentCalleeObject = (callExpression.value.callee as MemberExpression)
-        .object as CallExpression;
-      if (currentCalleeObject.arguments.length > 0) {
-        callExpression.value.arguments = currentCalleeObject.arguments;
-      }
-      callExpression.value.callee = currentCalleeObject.callee;
       break;
     }
   }

src/transforms/v2-to-v3/client-instances/getObjectWithUpdatedAwsConfigKeys.ts

@@ -113,7 +113,6 @@ export const getObjectWithUpdatedAwsConfigKeys = (
     })
     .filter((property) => property !== undefined);
 
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore is Argument is not assignable to parameter
   return j.objectExpression(updatedProperties);
 };

src/transforms/v2-to-v3/transformer.spec.ts

@@ -44,9 +44,9 @@ describe("v2-to-v3", () => {
         const output = await transform(input, {
           j: jscodeshift,
           jscodeshift,
-          // eslint-disable-next-line @typescript-eslint/no-empty-function
+          // biome-ignore lint/suspicious/noEmptyBlockStatements: test helper
           stats: () => {},
-          // eslint-disable-next-line @typescript-eslint/no-empty-function
+          // biome-ignore lint/suspicious/noEmptyBlockStatements: test helper
           report: () => {},
         });
 

src/transforms/v2-to-v3/ts-type/getTypeForString.ts

@@ -30,7 +30,7 @@ export const getTypeForString = (
     const typeArgument = getTypeForString(j, v2ClientLocalName, type);
     return j.tsTypeReference.from({
       typeName: j.identifier("Array"),
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+
       // @ts-ignore
       typeParameters: j.tsTypeParameterInstantiation([typeArgument]),
     });
@@ -42,7 +42,7 @@ export const getTypeForString = (
     const typeArgument = getTypeForString(j, v2ClientLocalName, type);
     return j.tsTypeReference.from({
       typeName: j.identifier("Record"),
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+
       // @ts-ignore
       typeParameters: j.tsTypeParameterInstantiation([j.tsStringKeyword(), typeArgument]),
     });

src/transforms/v2-to-v3/utils/getMostUsedStringLiteralQuote.ts

@@ -19,7 +19,6 @@ export const getMostUsedStringLiteralQuote = (
 
     // Check if the literal value is a string and contains single quotes
     if (typeof value === "string") {
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore Property 'raw' does not exist on type 'Literal'.
       const rawValue = path.node.raw || path.node.extra?.raw || "";
       if (rawValue.startsWith("'")) {

src/transforms/v2-to-v3/utils/isTrailingCommaUsed.ts

@@ -2,7 +2,6 @@ import { Collection, JSCodeshift } from "jscodeshift";
 
 export const isTrailingCommaUsed = (j: JSCodeshift, source: Collection<unknown>) => {
   for (const node of source.find(j.ObjectExpression).nodes()) {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore Property 'extra' does not exist on type 'ObjectExpression'.
     if (node.extra && node.extra.trailingComma) {
       return true;