add biome for formatting/linting and shuutils for improved logging

Author: Shuunen

biome.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "files": {
+    "ignore": [
+      "node_modules/**",
+      "dist/**",
+      "coverage/**"
+    ],
+    "ignoreUnknown": false
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 300
+  },
+  "javascript": {
+    "formatter": {
+      "arrowParentheses": "asNeeded",
+      "bracketSpacing": true,
+      "quoteStyle": "single",
+      "semicolons": "asNeeded"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "overrides": [
+    {
+      "include": [
+        "**/suretype.ts"
+      ],
+      "linter": {
+        "rules": {
+          "style": {
+            "noParameterAssign": "off"
+          }
+        }
+      }
+    }
+  ],
+  "vcs": {
+    "clientKind": "git",
+    "enabled": false,
+    "useIgnoreFile": false
+  }
+}

package.json

@@ -20,6 +20,7 @@
   },
   "description": "Comparison of different TypeScript validation libraries",
   "devDependencies": {
+    "@biomejs/biome": "1.9.4",
     "@tsconfig/strictest": "^2.0",
     "@types/bun": "latest",
     "repo-check": "^1.42",
@@ -49,8 +50,8 @@
     "bench:node": "hyperfine --runs 10 'node dist/arktype.js' 'node dist/valibot.js' 'node dist/zod-mini.js' 'node dist/zod3.js' 'node dist/zod4.js'",
     "bench:node:strip": "hyperfine --runs 10 'node --experimental-strip-types src/arktype.ts' 'node --experimental-strip-types src/valibot.ts' 'node --experimental-strip-types src/zod-mini.ts' 'node --experimental-strip-types src/zod3.ts' 'node --experimental-strip-types src/zod4.ts'",
     "build": "bun scripts/build.ts && echo build success",
-    "check": "pnpm i && bun check:tsc && bun run build && bun check:once && echo check success",
-    "check:once": "bun src/arktype.ts && bun src/valibot.ts && bun src/zod-mini.ts && bun src/zod3.ts && bun src/zod4.ts && echo check:once success",
+    "check": "pnpm i && bun check:tsc && bun check:biome && bun run build && bun check:once && echo check success",
+    "check:biome": "biome check --error-on-warnings --write --unsafe src && echo check:biome success",
     "check:repo": "repo-check && echo check:repo success",
     "check:tsc": "tsc --noEmit && echo check:tsc success"
   },

scripts/build.ts

@@ -1,21 +1,29 @@
-import { Glob } from "bun"
+import { Glob, type BuildConfig } from "bun"
+import { green, kebabToPascalCase, red, yellow } from 'shuutils'
 
 const glob = new Glob("*.ts")
 const ignore = ['utils.ts']
 const outdir = './dist'
 const nameRegex = /dist[\/\\](?<name>[\w-]+)/
 
-function showFileSize (path: string) {
+function showFileSize(path: string) {
   const name = nameRegex.exec(path)?.groups?.name
   if (!name) throw new Error(`Failed to extract name from ${path}`)
   const stats = Bun.file(path)
   const kb = Math.round(stats.size / 1024)
-  console.log(name.padStart(10), kb, 'KB')
+  const color = kb < 30 ? green : kb < 100 ? yellow : red
+  console.log(color(kebabToPascalCase(name).padEnd(8)), 'minified build size :', color(`${kb}`), 'KB')
 }
 
-function build (file: string) {
+function build(file: string) {
   const entrypoints = [`./src/${file}`]
-  Bun.build({ entrypoints, outdir, minify: true }).then((data) => {
+  const options = {
+    entrypoints,
+    external: ['shuutils'],
+    outdir,
+    minify: true
+  } satisfies BuildConfig
+  Bun.build(options).then((data) => {
     if (data.outputs[0]?.path) showFileSize(data.outputs[0].path)
   }).catch((err) => { console.error('Build failed:', err) })
 }

src/arktype.ts

@@ -1,37 +1,38 @@
-import { type } from "arktype"
-import { checkUserA, checkUserB, checkUserC, nbIterations } from './utils.ts'
+import { type } from 'arktype'
+import { checkUserA, checkUserB, checkUserC, logExecTime, nbIterations } from './utils.ts'
 
 const startTime = performance.now()
 
 for (let i = 0; i < nbIterations; i++) {
-
   const userSchema = type({
     name: type.string,
     age: type.number.default(42),
-    phone: type.string.or(type.number).pipe(phone => typeof phone === 'number' ? phone.toString() : phone).default("123-456-7890"),
+    phone: type.string
+      .or(type.number)
+      .pipe(phone => (typeof phone === 'number' ? phone.toString() : phone))
+      .default('123-456-7890'),
   })
 
   type User = typeof userSchema.inferOut
 
   type UserInput = typeof userSchema.inferIn
 
-  const userA = userSchema({ name: "Jordan" })
+  const userA = userSchema({ name: 'Jordan' })
   // @ts-expect-error Argument of type '{ name: string; age: number; } | ArkErrors' is not assignable to parameter of type 'User'.
   checkUserA(userA)
 
-  function createUser (input: UserInput) {
+  function createUser(input: UserInput) {
     const user = userSchema(input)
     if (user instanceof type.errors) return userA as User // :'''''(
     return user
   }
 
-  const userB = createUser({ name: "Romain", age: 35, phone: 1234567890 })
+  const userB = createUser({ name: 'Romain', age: 35, phone: 1234567890 })
   checkUserB(userB)
 
   // @ts-expect-error age should be a number
-  const userC = createUser({ name: "Romain", age: "35" })
+  const userC = createUser({ name: 'Romain', age: '35' })
   checkUserC(userC)
-
 }
 
-console.log(`ArkType exec time for ${nbIterations} iterations :`, performance.now() - startTime, 'ms')
+logExecTime('ArkType', startTime)

src/utils.ts

@@ -1,23 +1,33 @@
+import { green, red, yellow } from 'shuutils'
+
 type User = {
-  name: string;
-  age?: number;
-  phone: string;
-};
+  name: string
+  age?: number
+  phone: string
+}
 
 export function checkUserA(userA: User) {
-  console.assert(userA.age === 42, "userA.age should be 42");
+  console.assert(userA.name === 'Jordan', `userA.name should be "Jordan" but got "${userA.name}"`)
+  console.assert(userA.age === 42, `userA.age should be 42 but got "${userA.age}"`)
+  console.assert(userA.phone === '123-456-7890', `userA.phone should be "123-456-7890" but got "${userA.phone}"`)
 }
 
 export function checkUserB(userB: User) {
-  console.assert(userB.age === 35, "userB.age should be 35");
-  console.assert(
-    userB.phone === "1234567890",
-    "userB.phone should be 1234567890"
-  );
+  console.assert(userB.name === 'Romain', `userB.name should be "Romain" but got "${userB.name}"`)
+  console.assert(userB.age === 35, `userB.age should be 35 but got "${userB.age}"`)
+  console.assert(userB.phone === '1234567890', `userB.phone should be "1234567890" but got "${userB.phone}"`)
 }
 
 export function checkUserC(userC: User) {
-  console.assert(userC.name === "Jordan", "userC.name should be Jordan");
+  console.assert(userC.name === 'Jordan', `userC.name should be "Jordan" but got "${userC.name}"`)
+  console.assert(userC.age === 42, `userC.age should be 42 but got "${userC.age}"`)
+  console.assert(userC.phone === '123-456-7890', `userC.phone should be "123-456-7890" but got "${userC.phone}"`)
 }
 
-export const nbIterations = 1000;
+export const nbIterations = 1000
+
+export function logExecTime(name: string, startTime: number) {
+  const ms = Math.round(performance.now() - startTime)
+  const color = ms < 100 ? green : ms < 200 ? yellow : red
+  console.log(`${color(name.padEnd(8))} lib exec time :`, color(`${ms}`.padStart(4)), 'ms')
+}

src/valibot.ts

@@ -1,16 +1,15 @@
-import { number, union, object, optional, parse, safeParse, string, type InferInput, type InferOutput, pipe, transform } from 'valibot'
-import { checkUserA, checkUserB, checkUserC, nbIterations } from './utils.ts'
+import { type InferInput, type InferOutput, number, object, optional, parse, pipe, safeParse, string, transform, union } from 'valibot'
+import { checkUserA, checkUserB, checkUserC, logExecTime, nbIterations } from './utils.ts'
 
 const startTime = performance.now()
 
 for (let i = 0; i < nbIterations; i++) {
-
   const userSchema = object({
     name: string(),
     age: optional(number(), 42),
     phone: pipe(
-      optional(union([string(), number()]), "123-456-7890"),
-      transform((phone) => typeof phone === 'number' ? phone.toString() : phone)
+      optional(union([string(), number()]), '123-456-7890'),
+      transform(phone => (typeof phone === 'number' ? phone.toString() : phone)),
     ),
   })
 
@@ -19,22 +18,21 @@ for (let i = 0; i < nbIterations; i++) {
 
   type UserInput = InferInput<typeof userSchema>
 
-  const userA = parse(userSchema, { name: "Jordan" })
+  const userA = parse(userSchema, { name: 'Jordan' })
   checkUserA(userA)
 
-  function createUser (input: UserInput) {
+  function createUser(input: UserInput) {
     const result = safeParse(userSchema, input)
     if (!result.success) return userA
     return result.output
   }
 
-  const userB = createUser({ name: "Romain", age: 35, phone: 1234567890 })
+  const userB = createUser({ name: 'Romain', age: 35, phone: 1234567890 })
   checkUserB(userB)
 
   // @ts-expect-error age should be a number
-  const userC = createUser({ name: "Romain", age: "35" })
+  const userC = createUser({ name: 'Romain', age: '35' })
   checkUserC(userC)
-
 }
 
-console.log(`Valibot exec time for ${nbIterations} iterations :`, performance.now() - startTime, 'ms')
+logExecTime('Valibot', startTime)

src/zod-mini.ts

@@ -1,56 +1,36 @@
-import {
-  string,
-  number,
-  object,
-  type infer as InferOutput,
-  type input as InferInput,
-  refine,
-  optional,
-  _default,
-} from "@zod/mini";
-import { checkUserA, checkUserB, checkUserC, nbIterations } from "./utils.ts";
-
-const startTime = performance.now();
+import { type input as InferInput, type infer as InferOutput, _default, number, object, optional, refine, string } from '@zod/mini'
+import { checkUserA, checkUserB, checkUserC, logExecTime, nbIterations } from './utils.ts'
+
+const startTime = performance.now()
 
 for (let i = 0; i < nbIterations; i++) {
   const userSchema = object({
     name: string(),
     age: _default(optional(number()), 42),
-    phone: _default(
-      optional(
-        string().check(
-          refine((phone) => (typeof phone === "number" ? String(phone) : phone))
-        )
-      ),
-      "123-456-7890"
-    ),
-  });
+    phone: _default(optional(string().check(refine(phone => (typeof phone === 'number' ? String(phone) : phone)))), '123-456-7890'),
+  })
 
   // @ts-expect-error not exported, it's ok :p
-  type User = InferOutput<typeof userSchema>;
+  type User = InferOutput<typeof userSchema>
 
-  type UserInput = InferInput<typeof userSchema>;
+  type UserInput = InferInput<typeof userSchema>
 
-  const userA = userSchema.parse({ name: "Jordan" });
-  checkUserA(userA);
+  const userA = userSchema.parse({ name: 'Jordan' })
+  checkUserA(userA)
 
   function createUser(input: UserInput) {
-    const result = userSchema.safeParse(input);
-    if (!result.success) return userA;
-    return result.data;
+    const result = userSchema.safeParse(input)
+    if (!result.success) return userA
+    return result.data
   }
   // (╯°□°）╯︵ ┻━┻
   // Zod mini doesn't support "or" so a string is given for phone instead of a number like in other scripts
-  const userB = createUser({ name: "Romain", age: 35, phone: "1234567890" });
-  checkUserB(userB);
+  const userB = createUser({ name: 'Romain', age: 35, phone: '1234567890' })
+  checkUserB(userB)
 
   // @ts-expect-error age should be a number
-  const userC = createUser({ name: "Romain", age: "35" });
-  checkUserC(userC);
+  const userC = createUser({ name: 'Romain', age: '35' })
+  checkUserC(userC)
 }
 
-console.log(
-  `Zod mini exec time for ${nbIterations} iterations :`,
-  performance.now() - startTime,
-  "ms"
-);
+logExecTime('Zod mini', startTime)

src/zod3.ts

@@ -1,50 +1,38 @@
-import {
-  string,
-  number,
-  object,
-  type infer as InferOutput,
-  type input as InferInput,
-} from "zod3";
-import { checkUserA, checkUserB, checkUserC, nbIterations } from "./utils.ts";
+import { type input as InferInput, type infer as InferOutput, number, object, string } from 'zod3'
+import { checkUserA, checkUserB, checkUserC, logExecTime, nbIterations } from './utils.ts'
 
-const startTime = performance.now();
+const startTime = performance.now()
 
 for (let i = 0; i < nbIterations; i++) {
   const userSchema = object({
     name: string(),
     age: number().default(42),
     phone: string()
       .or(number())
-      .default("123-456-7890")
-      .transform((phone) =>
-        typeof phone === "number" ? phone.toString() : phone
-      ),
-  });
+      .default('123-456-7890')
+      .transform(phone => (typeof phone === 'number' ? phone.toString() : phone)),
+  })
 
   // @ts-expect-error not exported, it's ok :p
-  type User = InferOutput<typeof userSchema>;
+  type User = InferOutput<typeof userSchema>
 
-  type UserInput = InferInput<typeof userSchema>;
+  type UserInput = InferInput<typeof userSchema>
 
-  const userA = userSchema.parse({ name: "Jordan" });
-  checkUserA(userA);
+  const userA = userSchema.parse({ name: 'Jordan' })
+  checkUserA(userA)
 
   function createUser(input: UserInput) {
-    const result = userSchema.safeParse(input);
-    if (!result.success) return userA;
-    return result.data;
+    const result = userSchema.safeParse(input)
+    if (!result.success) return userA
+    return result.data
   }
 
-  const userB = createUser({ name: "Romain", age: 35, phone: 1234567890 });
-  checkUserB(userB);
+  const userB = createUser({ name: 'Romain', age: 35, phone: 1234567890 })
+  checkUserB(userB)
 
   // @ts-expect-error age should be a number
-  const userC = createUser({ name: "Romain", age: "35" });
-  checkUserC(userC);
+  const userC = createUser({ name: 'Romain', age: '35' })
+  checkUserC(userC)
 }
 
-console.log(
-  `Zod v3 exec time for ${nbIterations} iterations :`,
-  performance.now() - startTime,
-  "ms"
-);
+logExecTime('Zod v3', startTime)