Modernize dependencies and tooling: bun + Biome + TS 6

cinderblock · claude · cinderblock · commit 89f78eaf44fb · 2026-05-26T00:37:29.000-07:00
- Replace ESLint + Prettier (and the 5 config/plugin deps) with Biome
  for a single Rust-based lint+format tool. New `biome.json` mirrors
  the previous prettier settings (line width 120, single quotes,
  arrows without parens, trailing commas) and adds `recommended` lint
  rules. Drops `.eslintrc.json` and `.prettierrc`.
- Bump TypeScript 4 -&gt; 6, command-line-args 5 -&gt; 6, @types/bun and
  @types/command-line-args to latest. winston is already current.
- Rewrite tsconfig.json: drop the boilerplate of commented options,
  switch target to ESNext, module to Preserve, moduleResolution to
  bundler, types: ["bun"]. ts now just typechecks; bun runs the code.
- Add `typecheck`, `check`, `check:fix`, `format` npm scripts. README
  documents them.
- CI runs `bun run check` and `bun run typecheck` in addition to
  `bun test` on Ubuntu and Windows.

Biome's reformat picked up cleanup the previous setup missed: `node:`
prefixes for built-ins, `import type` for type-only imports, sorted
imports, `==`/`!=` -&gt; `===`/`!==`, and `let header` -&gt; `const header`.

Co-Authored-By: Claude Opus 4.7 &lt;noreply@anthropic.com&gt;
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -23,4 +23,6 @@ jobs:
 
       - run: bun install --frozen-lockfile
 
+      - run: bun run check
+      - run: bun run typecheck
       - run: bun test
diff --git a/.prettierrc b/.prettierrc
diff --git a/README.md b/README.md
@@ -79,3 +79,14 @@ bun run dev:ewe --verbose ./samples/Temp.ewprj.xml
 ```
 
 Both use `bun --watch` for fast reload on source changes.
+
+## Lint, format, and typecheck
+
+```bash
+bun run check        # biome lint + format check (no changes)
+bun run check:fix    # apply all safe fixes
+bun run format       # format only
+bun run typecheck    # tsc --noEmit
+```
+
+CI on push/PR runs `check`, `typecheck`, and `test` on Ubuntu and Windows.
diff --git a/biome.json b/biome.json
@@ -0,0 +1,49 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.4.15/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "includes": ["src/**", "*.json", "*.md"]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 120
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "arrowParentheses": "asNeeded",
+      "trailingCommas": "all",
+      "semicolons": "always"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    }
+  },
+  "overrides": [
+    {
+      "includes": ["**/cSpell.json"],
+      "json": {
+        "parser": {
+          "allowComments": true,
+          "allowTrailingCommas": true
+        }
+      }
+    }
+  ]
+}
diff --git a/bun.lock b/bun.lock
diff --git a/package.json b/package.json
@@ -12,25 +12,24 @@
     "ewe": "bun run src/ewe.ts",
     "dev:ewd": "bun --watch run src/ewd.ts",
     "dev:ewe": "bun --watch run src/ewe.ts",
-    "test": "bun test"
+    "test": "bun test",
+    "typecheck": "tsc --noEmit",
+    "check": "biome check",
+    "check:fix": "biome check --write",
+    "format": "biome format --write"
   },
   "engines": {
     "bun": ">=1.0.0"
   },
   "dependencies": {
-    "command-line-args": "^5.1.1",
+    "command-line-args": "^6.0.2",
     "node-pkware": "github:cinderblock/node-pkware",
-    "winston": "^3.3.3"
+    "winston": "^3.19.0"
   },
   "devDependencies": {
-    "@types/bun": "^1.1.0",
-    "@types/command-line-args": "^5.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.28.0",
-    "@typescript-eslint/parser": "^4.28.0",
-    "eslint": "^7.29.0",
-    "eslint-config-airbnb": "^18.2.1",
-    "eslint-config-prettier": "^8.3.0",
-    "prettier": "^2.3.2",
-    "typescript": "^4.3.4"
+    "@biomejs/biome": "^2.4.15",
+    "@types/bun": "^1.3.14",
+    "@types/command-line-args": "^5.2.3",
+    "typescript": "^6.0.3"
   }
 }
diff --git a/src/decode.ts b/src/decode.ts
@@ -1,8 +1,9 @@
-import { promises as fs } from 'fs';
-import winston from 'winston';
-import { UnexpectedValue } from './util/UnexpectedValue';
+import { promises as fs } from 'node:fs';
+import { Readable } from 'node:stream';
 import { explode, stream } from 'node-pkware';
-import { Readable } from 'stream';
+import type winston from 'winston';
+import { UnexpectedValue } from './util/UnexpectedValue';
+
 const { streamToBuffer, through } = stream;
 
 async function decodeBlock(block: Buffer, expectedLength: number): Promise<Buffer> {
@@ -18,7 +19,7 @@ async function decodeBlock(block: Buffer, expectedLength: number): Promise<Buffe
   return ret;
 }
 
-export async function decode(filename: string, logger: winston.Logger, outFile = filename + '.xml'): Promise<void> {
+export async function decode(filename: string, logger: winston.Logger, outFile = `${filename}.xml`): Promise<void> {
   if (!filename) throw new Error('No filename provided');
 
   let expectedHeader: Buffer;
@@ -41,7 +42,7 @@ export async function decode(filename: string, logger: winston.Logger, outFile =
 
     pos += bytesRead;
 
-    if (bytesRead != length) {
+    if (bytesRead !== length) {
       throw new UnexpectedValue('Failed to read as many bytes as we expect', length, bytesRead);
     }
 
@@ -58,7 +59,7 @@ export async function decode(filename: string, logger: winston.Logger, outFile =
   async function readNumber(size: 8): Promise<number | bigint>;
   async function readNumber(size: number) {
     const buffer = await read(size);
-    if ((size == 8 && buffer[6] && buffer[7]) || (size == 7 && buffer[6])) {
+    if ((size === 8 && buffer[6] && buffer[7]) || (size === 7 && buffer[6])) {
       return buffer.readBigUInt64LE();
     }
 
@@ -77,7 +78,7 @@ export async function decode(filename: string, logger: winston.Logger, outFile =
     const outputFile = await fs.open(outFile, 'w');
 
     try {
-      let header = await read(expectedHeader.length);
+      const header = await read(expectedHeader.length);
 
       logger.silly('Read header successfully');
 
@@ -89,7 +90,7 @@ export async function decode(filename: string, logger: winston.Logger, outFile =
 
       const finalLength = await readNumber(8);
 
-      if (typeof finalLength == 'bigint') throw new Error('Cannot handle files this large');
+      if (typeof finalLength === 'bigint') throw new Error('Cannot handle files this large');
 
       logger.silly(`Full size: ${finalLength}`);
 
diff --git a/src/encode.ts b/src/encode.ts
@@ -1,7 +1,7 @@
-import { promises as fs } from 'fs';
-import winston from 'winston';
+import { promises as fs } from 'node:fs';
+import { Readable } from 'node:stream';
 import { constants, implode, stream } from 'node-pkware';
-import { Readable } from 'stream';
+import type winston from 'winston';
 
 const { COMPRESSION_ASCII, DICTIONARY_SIZE_LARGE } = constants;
 const { streamToBuffer, through } = stream;
diff --git a/src/ewd.ts b/src/ewd.ts
@@ -1,6 +1,6 @@
+import commandLineArgs from 'command-line-args';
 import winston from 'winston';
 import { decode } from './decode';
-import commandLineArgs from 'command-line-args';
 
 export async function main() {
   const { files, verbose, concurrent } = commandLineArgs([
diff --git a/src/ewe.ts b/src/ewe.ts
@@ -1,5 +1,5 @@
-import winston from 'winston';
 import commandLineArgs from 'command-line-args';
+import winston from 'winston';
 import { encode } from './encode';
 
 export async function main() {
diff --git a/src/roundtrip.test.ts b/src/roundtrip.test.ts
@@ -1,10 +1,10 @@
 import { afterAll, beforeAll, describe, expect, test } from 'bun:test';
-import { mkdtemp, readFile, rm, writeFile } from 'fs/promises';
-import { tmpdir } from 'os';
-import { join } from 'path';
+import { mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
 import winston from 'winston';
-import { encode } from './encode';
 import { decode } from './decode';
+import { encode } from './encode';
 
 const silentLogger = winston.createLogger({
   silent: true,
diff --git a/src/util/UnexpectedValue.ts b/src/util/UnexpectedValue.ts
@@ -1,5 +1,9 @@
 export class UnexpectedValue<T = string> extends Error {
-  constructor(name: string, public expected: T, public received: T) {
+  constructor(
+    name: string,
+    public expected: T,
+    public received: T,
+  ) {
     super(name);
   }
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,72 +1,15 @@
 {
   "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                         /* Enable incremental compilation */
-    "target": "es5",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
-    "module": "commonjs",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                                   /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                             /* Allow javascript files to be compiled. */
-    // "checkJs": true,                             /* Report errors in .js files. */
-    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
-    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
-    // "outFile": "./",                             /* Concatenate and emit output to single file. */
-    // "outDir": "./",                              /* Redirect output structure to the directory. */
-    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                           /* Enable project compilation */
-    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
-    // "removeComments": true,                      /* Do not emit comments to output. */
-    // "noEmit": true,                              /* Do not emit outputs. */
-    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                                 /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                    /* Enable strict null checks. */
-    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
-    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
-    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
-    // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
-    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                             /* List of folders to include type definitions from. */
-    // "types": [],                                 /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true,                           /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleResolution": "bundler",
+    "lib": ["ESNext"],
+    "types": ["bun"],
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
   }
 }
