feat: Migrate Prettier to Biome

.github/workflows/tests.yml

@@ -9,6 +9,29 @@ on:
       - main
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    name: Lint
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "npm"
+
+      - name: Install dependencies
+        run: |
+          npm install
+
+      - name: Run lint
+        run: |
+          npm run lint
+
   test:
     runs-on: ubuntu-latest
 
@@ -26,7 +49,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-          cache: 'npm'
+          cache: "npm"
 
       - name: Install dependencies
         run: |

.vscode/extensions.json

@@ -1,8 +1,7 @@
 {
   "recommendations": [
     // JS Language plugins (~required)
-    "dbaeumer.vscode-eslint",
-    "esbenp.prettier-vscode",
+    "biomejs.biome",
 
     // Highly recommended
     "EditorConfig.editorconfig"

.vscode/settings.json

@@ -1,4 +1,11 @@
 {
-  "editor.formatOnSave": true,
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome",
+    "editor.formatOnSave": true
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome",
+    "editor.formatOnSave": true
+  },
   "typescript.tsdk": "node_modules/typescript/lib"
 }

biome.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "organizeImports": { "enabled": true },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "lineEnding": "lf",
+    "indentWidth": 2,
+    "indentStyle": "space"
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "arrowParentheses": "always",
+      "bracketSameLine": false,
+      "bracketSpacing": true,
+      "quoteProperties": "asNeeded",
+      "quoteStyle": "single",
+      "semicolons": "asNeeded",
+      "trailingCommas": "es5"
+    }
+  },
+  "overrides": [
+    {
+      "include": ["*.json"],
+      "formatter": {
+        "indentWidth": 2
+      }
+    }
+  ]
+}

package.json

@@ -23,10 +23,12 @@
     "build": "tsup src/index.ts --format esm,cjs --dts",
     "dev": "npm run build -- --watch",
     "test": "jest",
-    "format": "prettier \"src/**/*.{js,ts}\" --write",
+    "lint": "biome lint --error-on-warnings ./src",
+    "format": "biome format --write ./src",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
+    "@biomejs/biome": "1.8.3",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.12.7",
     "jest": "^29.7.0",

src/agency.ts

@@ -1,6 +1,6 @@
-import { Blutui } from './blutui'
-
 import { Brand, Domains } from './resources/agency'
+
+import type { Blutui } from './blutui'
 import type { GetOptions, PostOptions } from './types'
 
 export class Agency {
@@ -12,11 +12,11 @@ export class Agency {
     private readonly blutui: Blutui
   ) {}
 
-  async get<Result = any>(path: string, options: GetOptions = {}) {
+  async get<Result>(path: string, options: GetOptions = {}) {
     return this.blutui.get<Result>(this.getAgencyPath(path), options)
   }
 
-  async post<Result = any, Entity = any>(
+  async post<Result, Entity>(
     path: string,
     entity: Entity,
     options: PostOptions = {}
@@ -28,7 +28,7 @@ export class Agency {
     )
   }
 
-  async patch<Result = any, Entity = any>(
+  async patch<Result, Entity>(
     path: string,
     entity: Entity,
     options: PostOptions = {}
@@ -40,13 +40,16 @@ export class Agency {
     )
   }
 
-  async delete<Result = any>(path: string, options: PostOptions = {}) {
+  async delete<Result>(path: string, options: PostOptions = {}) {
     return this.blutui.delete<Result>(this.getAgencyPath(path), options)
   }
 
+  /**
+   * Get the path for the current agency.
+   */
   private getAgencyPath(path: string): string {
-    path = path.startsWith('/') ? path.replace('/', '') : path
+    const newPath = path.startsWith('/') ? path.replace('/', '') : path
 
-    return `/agencies/${this.username}/${path}`
+    return `/agencies/${this.username}/${newPath}`
   }
 }

src/blutui.spec.ts

@@ -1,5 +1,5 @@
 import fetch from 'jest-fetch-mock'
-import fs from 'fs/promises'
+import fs from 'node:fs/promises'
 
 import { Agency } from './agency'
 import { Blutui } from './blutui'
@@ -16,7 +16,7 @@ describe('Blutui', () => {
     beforeEach(() => {
       jest.resetModules()
       process.env = { ...OLD_ENV }
-      delete process.env.NODE_ENV
+      process.env.NODE_ENV = undefined
     })
 
     afterEach(() => {