replace Prettier with Biome

Author: niedzielski

.prettierignore

@@ -1 +1 @@
-{"typescript.tsdk": "node_modules/typescript/lib"}
+{ "typescript.tsdk": "node_modules/typescript/lib" }

.vscode/settings.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
+  "formatter": { "indentStyle": "space" },
+  "javascript": {
+    "formatter": {
+      "arrowParentheses": "asNeeded",
+      "bracketSpacing": false,
+      "indentStyle": "space",
+      "jsxQuoteStyle": "single",
+      "quoteStyle": "single",
+      "semicolons": "asNeeded",
+      "trailingComma": "none"
+    }
+  },
+  "json": {
+    "formatter": { "indentStyle": "space" },
+    "parser": { "allowComments": true }
+  },
+  "linter": {
+    "rules": {
+      "style": { "noInferrableTypes": "off", "noNonNullAssertion": "off" }
+    }
+  },
+  "vcs": { "enabled": true, "clientKind": "git" }
+}

biome.jsonc

@@ -11,10 +11,10 @@
   },
   "devDependencies": {
     "@ampproject/filesize": "4.3.0",
+    "@biomejs/biome": "1.7.3",
     "@types/jsdom": "21.1.6",
     "@types/node": "18.19.31",
     "mem-font": "11.0.0-2",
-    "prettier": "3.2.5",
     "typescript": "5.5.0-beta",
     "vitest": "1.6.0"
   },
@@ -34,22 +34,10 @@
     }
   },
   "homepage": "https://github.com/oidoid/void",
-  "keywords": [
-    "game engine",
-    "webgl"
-  ],
+  "keywords": ["game engine", "webgl"],
   "license": "AGPL-3.0-only",
   "main": "dist/index.js",
   "name": "@oidoid/void",
-  "prettier": {
-    "arrowParens": "avoid",
-    "bracketSpacing": false,
-    "jsxSingleQuote": true,
-    "proseWrap": "always",
-    "semi": false,
-    "singleQuote": true,
-    "trailingComma": "none"
-  },
   "publishConfig": {
     "access": "public"
   },
@@ -60,13 +48,13 @@
   "scripts": {
     "build": "tsc --build",
     "clean": "rm -rf dist",
-    "format": "npm run formatter -- --write",
-    "formatter": "prettier --cache --log-level warn './**/*.{js,json,md,ts,yaml}'",
+    "format": "npm run formatter -- --apply",
+    "formatter": "biome check --error-on-warnings .",
     "preversion": "[ -z \"$(git status -z)\" ]",
     "prepublishOnly": "! git symbolic-ref --quiet HEAD || git push --follow-tags origin \"$(git branch --show-current)\"",
     "start": "npm run build -- --watch",
     "test": "npm run test:format && npm run test:unit && npm run build && npm run test:size",
-    "test:format": "npm run formatter -- --check",
+    "test:format": "npm run formatter",
     "test:size": "npx esbuild --bundle --format=esm --metafile=dist/void.meta.json --minify --outfile=dist/void.js --sourcemap=linked --target=es2022 src/index.ts && filesize",
     "test:unit": "vitest --config=tools/vitest.config.ts run",
     "version": "npm test"

package-lock.json

@@ -1,5 +1,5 @@
 import type {Bitmap} from '../renderer/bitmap.js'
-import {boxHits, type Box, type WH, type XY} from '../types/2d.js'
+import {type Box, type WH, type XY, boxHits} from '../types/2d.js'
 import type {Anim, TagFormat} from './anim.js'
 import type {Atlas} from './atlas.js'
 

package.json

@@ -6,7 +6,7 @@ import type {Tileset} from './graphics/tileset.js'
 import {Input, type StandardButton} from './input/input.js'
 import {Random} from './random.js'
 import {BitmapAttribBuffer, TileAttribBuffer} from './renderer/attrib-buffer.js'
-import {type Bitmap} from './renderer/bitmap.js'
+import type {Bitmap} from './renderer/bitmap.js'
 import {Cam} from './renderer/cam.js'
 import {FrameListener} from './renderer/frame-listener.js'
 import {Renderer} from './renderer/renderer.js'

src/graphics/sprite.ts

@@ -1,10 +1,10 @@
-import {Cam} from '../renderer/cam.js'
+import type {Cam} from '../renderer/cam.js'
 import type {XY} from '../types/2d.js'
 import {KeyPoller} from './key-poller.js'
 import {PadPoller} from './pad-poller.js'
 import {PointerPoller} from './pointer-poller.js'
 
-// prettier-ignore
+// biome-ignore format:
 export type StandardButton =
   'L' | 'R' | 'U' | 'D' | // Dpad.
   'A' | 'B' | 'C' | // Primary, secondary, tertiary.
@@ -198,7 +198,7 @@ export class Input<T extends string> {
   }
 
   #map(button: T): number {
-    return (this.#bitByButton[button] ??=
-      1 << Object.keys(this.#bitByButton).length)
+    this.#bitByButton[button] ??= 1 << Object.keys(this.#bitByButton).length
+    return this.#bitByButton[button]
   }
 }

src/index.ts

@@ -1,4 +1,4 @@
-import {Cam} from '../renderer/cam.js'
+import type {Cam} from '../renderer/cam.js'
 import type {XY} from '../types/2d.js'
 
 export class PointerPoller {

src/input/input.ts

@@ -1,7 +1,7 @@
-import {Input} from '../input/input.js'
+import type {Input} from '../input/input.js'
 import type {AttribBuffer} from './attrib-buffer.js'
-import {Cam} from './cam.js'
-import {Renderer} from './renderer.js'
+import type {Cam} from './cam.js'
+import type {Renderer} from './renderer.js'
 
 export class FrameListener {
   /** The running lifetime in milliseconds. */

src/input/pointer-poller.ts

@@ -1,8 +1,8 @@
 import type {Atlas} from '../graphics/atlas.js'
 import type {AttribBuffer} from './attrib-buffer.js'
-import {Cam} from './cam.js'
+import type {Cam} from './cam.js'
 import {fragGLSL} from './frag.glsl.js'
-import {Shader, type GL} from './shader.js'
+import {type GL, Shader} from './shader.js'
 import {spriteVertGLSL} from './sprite-vert.glsl.js'
 import {tileVertGLSL} from './tile-vert.glsl.js'
 

src/renderer/frame-listener.ts

@@ -14,5 +14,5 @@
     "tsBuildInfoFile": "../../dist/test/tsconfig.tsbuildinfo"
   },
   "include": ["**/*", "../**/*.test.ts"],
-  "references": [{"path": ".."}]
+  "references": [{ "path": ".." }]
 }

src/renderer/renderer.ts

@@ -1,4 +1,4 @@
-import {memProp5x5, type Font} from 'mem-font'
+import {type Font, memProp5x5} from 'mem-font'
 import {describe, expect, test} from 'vitest'
 import {layoutText, layoutWord} from './text-layout.js'
 
@@ -608,7 +608,7 @@ describe('layoutWord()', () => {
       }
     ]
   ]).entries()) {
-    test(`case ${caseNumber}: xy=${(xy.x, xy.y)}, width=${width}, string="${string}", index=${index}.`, () =>
+    test(`case ${caseNumber}: xy=(${xy.x}, ${xy.y}), width=${width}, string="${string}", index=${index}.`, () =>
       expect(layoutWord(font, xy, width, string, index)).toStrictEqual(
         expected
       ))

src/test/tsconfig.json

@@ -15,7 +15,7 @@ export function layoutText(font: Font, str: string, maxW: number): TextLayout {
   while (chars.length < str.length) {
     const i = chars.length
     const char = str[i]!
-    let layout
+    let layout: TextLayout
     if (char === '\n') layout = layoutNewline(font, cursor)
     else if (/^\s*$/.test(char)) {
       layout = layoutSpace(font, cursor, maxW, tracking(font, char, str[i + 1]))
@@ -54,14 +54,15 @@ export function layoutWord(
     const span = tracking(font, char, word[index + 1])
     if (x > 0 && x + span > maxW) ({x, y} = nextLine(font, y))
 
-    // Width is not span since, with kerning, that may exceed the actual
-    // width of the character's sprite. For example, if w has the maximal
+    // width is not span since, with kerning, that may exceed the actual
+    // width of the character's sprite. for example, if w has the maximal
     // character width of five pixels and a one pixel kerning for a given pair
     // of characters, it will have a span of six pixels which is greater than
     // the maximal five pixel sprite that can be rendered.
     chars.push({x, y, w: fontCharWidth(font, char), h: font.cellHeight})
     x += span
 
+    // biome-ignore lint/style/noParameterAssign:
     index++
   }
   return {chars, cursor: {x, y}}
@@ -76,7 +77,7 @@ function layoutNewline(font: Font, cursor: Readonly<XY>): TextLayout {
 }
 
 /**
- * @arg span  The distance in pixels from the start of the current character to
+ * @arg span  the distance in pixels from the start of the current character to
  *            the start of the next including scale.
  */
 function layoutSpace(
@@ -92,7 +93,7 @@ function layoutSpace(
   return {chars: [undefined], cursor: nextCursor}
 }
 
-/** Returns the distance in pixels from the start of lhs to the start of rhs. */
+/** @return the distance in pixels from the start of lhs to the start of rhs. */
 function tracking(font: Font, lhs: string, rhs: string | undefined): number {
   return fontCharWidth(font, lhs) + fontKerning(font, lhs, rhs)
 }

src/text/text-layout.test.ts

@@ -15,5 +15,5 @@
     "types": ["node"]
   },
   "include": ["**/*", "../package.json"],
-  "references": [{"path": "../src"}]
+  "references": [{ "path": "../src" }]
 }