chore: experiment with biomejs

Author: kuhe

biome.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.0.0/schema.json",
+  "files": {
+    "maxSize": 16000000,
+    "includes": [
+      "**/*.{mjs|js}",
+      "**/*.ts",
+      "**/*.json"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "lineWidth": 120,
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "bracketSpacing": true,
+    "bracketSameLine": false
+  },
+  "assist": {
+    "enabled": true,
+    "actions": {
+      "source": {
+        "useSortedKeys": "on",
+        "organizeImports": "on"
+      }
+    }
+  },
+  "linter": {
+    "rules": {
+      "recommended": true,
+      "complexity": {
+        "noForEach": "off"
+      },
+      "correctness": {
+        "noUndeclaredVariables": "error",
+        "noUnusedVariables": "info",
+        "noInvalidBuiltinInstantiation": "error"
+      },
+      "style": {
+        "noNamespace": "error",
+        "useConsistentArrayType": {
+          "level": "error",
+          "options": {
+            "syntax": "shorthand"
+          }
+        },
+        "noParameterAssign": "info",
+        "useAsConstAssertion": "error",
+        "useDefaultParameterLast": "info",
+        "useEnumInitializers": "error",
+        "useSelfClosingElements": "error",
+        "useSingleVarDeclarator": "error",
+        "noUnusedTemplateLiteral": "info",
+        "useNumberNamespace": "error",
+        "noInferrableTypes": "error",
+        "noUselessElse": "error"
+      },
+      "suspicious": {
+        "noEmptyBlockStatements": "info",
+        "noExplicitAny": "info",
+        "noImplicitAnyLet": "info",
+        "noEmptyBlock": "info",
+        "noEmptyInterface": "info",
+        "noAssignInExpressions": "info"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "trailingCommas": "es5"
+    }
+  },
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  }
+}

package.json

@@ -29,8 +29,9 @@
     "generate:clients:generic": "node ./scripts/generate-clients/generic",
     "generate:defaults-mode-provider": "./scripts/generate-defaults-mode-provider/index.js",
     "lerna:version": "lerna version --exact --conventional-commits --no-push --no-git-tag-version --no-commit-hooks --loglevel silent --yes",
-    "lint:ci": "lerna exec --since origin/main --exclude-dependents --ignore '@aws-sdk/client-*' --ignore '@aws-sdk/aws-*' 'eslint --quiet src/**/*.ts'",
-    "lint:release": "lerna exec --ignore '@aws-sdk/client-*' --ignore '@aws-sdk/aws-*' 'eslint --quiet src/**/*.ts'",
+    "lint": "node scripts/biome/run-biome.mjs",
+    "lint:ci": "node scripts/biome/run-biome.mjs",
+    "lint:release": "node scripts/biome/run-biome.mjs",
     "lint:versions": "node scripts/runtime-dependency-version-check/runtime-dep-version-check.js",
     "lint:dependencies": "node scripts/runtime-dependency-version-check/check-dependencies.js",
     "local-publish": "node ./scripts/verdaccio-publish/index.js",
@@ -62,30 +63,24 @@
   },
   "license": "UNLICENSED",
   "devDependencies": {
+    "@biomejs/biome": "2.0.0",
+    "@biomejs/js-api": "1.0.0",
+    "@biomejs/wasm-nodejs": "2.0.0",
     "@commitlint/cli": "17.0.2",
     "@commitlint/config-conventional": "17.0.2",
     "@cucumber/cucumber": "8.5.3",
     "@cucumber/pretty-formatter": "^1.0.0",
     "@fastify/formbody": "^7.4.0",
     "@microsoft/api-extractor": "7.52.7",
-    "@mixer/parallel-prettier": "2.0.3",
     "@tsconfig/recommended": "1.0.1",
     "@types/fs-extra": "^8.0.1",
     "@types/jest": "29.5.11",
     "@types/jsdom": "20.0.1",
-    "@typescript-eslint/eslint-plugin": "5.55.0",
-    "@typescript-eslint/parser": "5.55.0",
     "async": "3.2.4",
     "concurrently": "7.0.0",
     "decomment": "0.9.5",
     "downlevel-dts": "0.10.1",
     "esbuild": "0.25.0",
-    "eslint": "8.36.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-prettier": "4.0.0",
-    "eslint-plugin-simple-import-sort": "7.0.0",
-    "eslint-plugin-sort-export-all": "1.2.2",
-    "eslint-plugin-tsdoc": "0.2.17",
     "esprint": "3.6.0",
     "fastify": "^4.11.0",
     "figlet": "^1.5.0",
@@ -100,7 +95,6 @@
     "kill-port": "^2.0.1",
     "lerna": "5.5.2",
     "lint-staged": "^10.0.1",
-    "prettier": "2.8.5",
     "rimraf": "3.0.2",
     "ts-jest": "29.1.1",
     "ts-loader": "9.4.2",
@@ -135,10 +129,9 @@
   },
   "lint-staged": {
     "{lib,packages}/**/src/**/*.ts": [
-      "eslint --fix",
-      "prettier --write"
+      "echo yarn @biomejs/biome check --write"
     ],
-    "**/*.{ts,js,md,json}": "prettier --write"
+    "**/*.{ts,js,md,json}": "echo yarn @biomejs/biome check --write"
   },
   "packageManager": "[email protected]"
 }

scripts/benchmark-size/runner/calculate-size/generate-project.ts

@@ -1,7 +1,6 @@
 import { execa as exec } from "execa";
 import { promises as fsPromise } from "fs";
 import { join } from "path";
-import prettier from "prettier";
 
 import { PackageContext } from "../load-test-scope";
 import type { PackageSizeReportOptions } from "./index";
@@ -14,9 +13,9 @@ export const generateProject = async (projectDir: string, options: PackageSizeRe
   };
   for (const [name, template] of Object.entries(options.templates)) {
     const filePath = join(projectDir, name);
-    const file = prettier.format(template(contextWithPeerDep), {
-      filepath: filePath,
-    });
+    const { formatCode } = await import("../../../biome/biome.mjs");
+    const file = await formatCode(template(contextWithPeerDep), filePath);
+
     await fsPromise.writeFile(filePath, file);
   }
 

scripts/biome/biome.mjs

@@ -0,0 +1,68 @@
+import { dirname, join } from "node:path";
+import { promises, readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import { Biome, Distribution } from "@biomejs/js-api";
+import walk from "../utils/walk.js";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const biome = await Biome.create({
+  distribution: Distribution.NODE,
+});
+
+const biomeConfigPath = join(__dirname, "..", "..", "biome.json");
+const config = JSON.parse(readFileSync(biomeConfigPath, "utf-8"));
+
+const { projectKey } = biome.openProject(biomeConfigPath);
+biome.applyConfiguration(projectKey, config);
+
+const skip = /browser-build|node_modules|dist-(es|cjs|types)|ruleset\.ts$/;
+const match = /\.(m?js|ts|json)$/;
+
+export async function formatDir(dir) {
+  const concurrency = [];
+
+  for await (const file of walk(dir, ["node_modules"])) {
+    if (file.match(skip)) {
+      continue;
+    }
+    if (file.match(match)) {
+      concurrency.push(
+        promises
+          .readFile(file, "utf-8")
+          .then((contents) => {
+            const formatted = formatCode(contents, file);
+            if (formatted) {
+              const linted = lintCode(formatted, file);
+              return promises.writeFile(file, linted, "utf-8");
+            }
+            return Promise.resolve();
+          })
+          .catch(console.error)
+      );
+    }
+  }
+
+  await Promise.all(concurrency);
+}
+
+export function formatCode(code, filePath) {
+  const format = biome.formatContent(projectKey, code, {
+    filePath,
+  });
+  return format.content;
+}
+
+export function lintCode(code, filePath) {
+  const lint = biome.lintContent(projectKey, code, {
+    filePath,
+  });
+  for (const diagnostic of lint.diagnostics) {
+    if (diagnostic.severity === "error" || diagnostic.severity === "fatal") {
+      const { category, severity, description, location } = diagnostic;
+      console.log(`${category} - ${severity}\n\t${description}`);
+      console.log(`\t\t${location.path.file.split("aws-sdk-js-v3")[1]}:${location.span.join(":")}`);
+    }
+  }
+  return lint.content;
+}

scripts/biome/run-biome.mjs

@@ -0,0 +1,9 @@
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { formatDir } from "./biome.mjs";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+await formatDir(join(__dirname));
+await formatDir(join(__dirname, "..", "..", "packages", "middleware-sdk-s3"));
+await formatDir(join(__dirname, "..", "..", "clients", "client-s3"));

scripts/downlevel-dts/downlevelWorkspace.mjs

@@ -3,7 +3,6 @@ import { exec } from "child_process";
 import decomment from "decomment";
 import { access, readFile, writeFile } from "fs/promises";
 import { join } from "path";
-import prettier from "prettier";
 import { promisify } from "util";
 
 import { getAllFiles } from "./getAllFiles.mjs";
@@ -42,7 +41,8 @@ export const downlevelWorkspace = async (workspacesDir, workspaceName) => {
         const content = await readFile(downlevelTypesFilepath, "utf8");
         const decommentedContent = decomment(content);
         try {
-          const formatted = prettier.format(decommentedContent, { parser: "typescript" });
+          const { formatCode } = await import("../biome/biome.mjs");
+          const formatted = await formatCode(decommentedContent, downlevelTypesFilepath);
           await writeFile(downlevelTypesFilepath, formatted);
         } catch (error) {
           console.warn(`Failed to format "${downlevelTypesFilepath}". Skipping...`);

scripts/generate-clients/code-eslint-fix.js

@@ -1,16 +1,6 @@
-// @ts-check
-const { spawnProcess } = require("../utils/spawn-process");
-const path = require("path");
-
 const prettifyCode = async (dir) => {
-  await spawnProcess(path.join(__dirname, "..", "..", "node_modules", ".bin", "pprettier"), [
-    "--write",
-    `${dir}/*/typescript-codegen/**/*.{ts,js,md,json}`,
-  ]);
-  await spawnProcess(path.join(__dirname, "..", "..", "node_modules", ".bin", "pprettier"), [
-    "--write",
-    `${dir}/*/typescript-ssdk-codegen/**/*.{ts,js,md,json}`,
-  ]);
+  const { formatDir } = await import("../biome/biome.mjs");
+  await formatDir(dir);
 };
 
 module.exports = {

scripts/generate-clients/code-prettify.js

@@ -1,7 +1,6 @@
 // @ts-check
 const { join } = require("path");
 const { copySync, removeSync } = require("fs-extra");
-const prettier = require("prettier");
 const semver = require("semver");
 const { readdirSync, lstatSync, readFileSync, existsSync, writeFileSync } = require("fs");
 
@@ -178,7 +177,7 @@ const copyToClients = async (sourceDir, destinationDir, solo) => {
           ] = `node ../../scripts/generate-clients/single-service --solo ${serviceName}`;
         }
 
-        writeFileSync(destSubPath, prettier.format(JSON.stringify(mergedManifest), { parser: "json-stringify" }));
+        writeFileSync(destSubPath, JSON.stringify(mergedManifest, null, 2));
       } else if (packageSub === "typedoc.json") {
         // Skip writing typedoc.json
         // ToDo: Remove if typedoc.json is config driven or removed in smithy-typescript.
@@ -235,7 +234,7 @@ const copyServerTests = async (sourceDir, destinationDir) => {
           // don't generate documentation for private packages
           delete mergedManifest.scripts["build:docs"];
         }
-        writeFileSync(destSubPath, prettier.format(JSON.stringify(mergedManifest), { parser: "json-stringify" }));
+        writeFileSync(destSubPath, JSON.stringify(mergedManifest, null, 2));
       } else if (packageSub === "typedoc.json") {
         // Skip writing typedoc.json
         // ToDo: Remove if typedoc.json is config driven or removed in smithy-typescript.

scripts/generate-clients/copy-to-clients.js

@@ -5,7 +5,6 @@ const { generateGenericClient } = require("./code-gen");
 const { copyToClients } = require("./copy-to-clients");
 const { CODE_GEN_GENERIC_CLIENT_OUTPUT_DIR } = require("./code-gen-dir");
 const { prettifyCode } = require("./code-prettify");
-const { eslintFixCode } = require("./code-eslint-fix");
 
 const PRIVATE_CLIENTS_DIR = path.normalize(path.join(__dirname, "..", "..", "private"));
 
@@ -14,7 +13,6 @@ const PRIVATE_CLIENTS_DIR = path.normalize(path.join(__dirname, "..", "..", "pri
   try {
     await generateGenericClient();
 
-    await eslintFixCode();
     await prettifyCode(CODE_GEN_GENERIC_CLIENT_OUTPUT_DIR);
     await copyToClients(CODE_GEN_GENERIC_CLIENT_OUTPUT_DIR, PRIVATE_CLIENTS_DIR);
     emptyDirSync(CODE_GEN_GENERIC_CLIENT_OUTPUT_DIR);