Refactor to use biome over ESLint and prettier (#1304)

* refactor: use biome formatting and check fix

* refactor: remove eslint disabled rules

* refactor: apply unsafe rules

* refactor: refactor to comply with biome rules

* fix: make biome default formatter

* refactor: last biome fixes

* test: adjust assertion

* test: adjust more tests to not skip them

* refactor: use codecov action

* fix: remove matrix

* chore: fix lockfile

* Create famous-hotels-accept.md

.changeset/famous-hotels-accept.md

@@ -0,0 +1,8 @@
+---
+"@promster/apollo": patch
+"@promster/express": patch
+"@promster/fastify": patch
+"@promster/hapi": patch
+---
+
+Refactor to use biome over ESLint and prettier

.github/workflows/test.yml

@@ -10,10 +10,6 @@ jobs:
   install:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [20.x, 22.x]
-
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -26,27 +22,28 @@ jobs:
       - name: Setup Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version-file: '.nvmrc'
           cache: pnpm
 
       - name: Install
         run: pnpm install
 
       - name: Lint
-        run: pnpm lint
+        run: pnpm biome check
 
       - name: Spell check
         uses: streetsidesoftware/cspell-action@main
         with:
-          files: '**/*.{md,ts}'
+          files: "**/*.{md,ts}"
 
       - name: Build
         run: pnpm build
 
-      - name: Test
-        if: startsWith(matrix.node-version , '22')
-        run: pnpm test:ci
-
       - name: Test (with coverage)
-        if: startsWith(matrix.node-version, '20')
         run: pnpm test:ci:coverage
+
+      - uses: codecov/codecov-action@v5
+        with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true

.mise.toml

@@ -1,2 +1,2 @@
 [tools]
-node = "22.8"
+node = "22"

.vscode/settings.json

@@ -1,6 +1,16 @@
 {
-    "workbench.colorCustomizations": {
-        "tab.unfocusedActiveBorder": "#fff0"
-    },
-    "gitdoc.enabled": false
-}
+  "workbench.colorCustomizations": {
+    "tab.unfocusedActiveBorder": "#fff0"
+  },
+  "gitdoc.enabled": false,
+  "editor.defaultFormatter": "biomejs.biome",
+  "editor.codeActionsOnSave": {
+    "quickfix.biome": "explicit"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  }
+}

biome.json

@@ -0,0 +1,92 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "vcs": {
+    "clientKind": "git",
+    "enabled": true,
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": true
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 80,
+    "ignore": [
+      "**/package.json",
+      "**/dist/**",
+      "**/.changeset",
+      "**/CHANGELOG.md",
+      "**/pnpm-lock.yaml",
+      "**/pnpm-workspace.yaml"
+    ]
+  },
+  "organizeImports": { "enabled": true },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "performance": {
+        "noAccumulatingSpread": "off"
+      },
+      "complexity": {
+        "noVoid": "error"
+      },
+      "correctness": {
+        "noUndeclaredVariables": "error",
+        "noUnreachableSuper": "error",
+        "noUnusedVariables": "error",
+        "useArrayLiterals": "error",
+        "useExhaustiveDependencies": "warn"
+      },
+      "style": {
+        "noNegationElse": "error",
+        "noRestrictedGlobals": {
+          "level": "error",
+          "options": { "deniedGlobals": ["event", "atob", "btoa"] }
+        },
+        "useBlockStatements": "error",
+        "useCollapsedElseIf": "error",
+        "useConsistentArrayType": {
+          "level": "error",
+          "options": { "syntax": "shorthand" }
+        },
+        "useForOf": "error",
+        "useFragmentSyntax": "error",
+        "useShorthandAssign": "error"
+      },
+      "suspicious": {
+        "noEmptyBlockStatements": "error",
+        "noSkippedTests": "warn",
+        "noExplicitAny": "off"
+      }
+    },
+    "ignore": ["**/node_modules/", "**/coverage/", "**/dist/"]
+  },
+  "javascript": {
+    "formatter": {
+      "jsxQuoteStyle": "double",
+      "quoteProperties": "asNeeded",
+      "trailingCommas": "es5",
+      "semicolons": "always",
+      "arrowParentheses": "always",
+      "bracketSpacing": true,
+      "quoteStyle": "single"
+    },
+    "globals": [
+      "it",
+      "describe",
+      "expect",
+      "jest",
+      "before",
+      "beforeAll",
+      "beforeEach",
+      "after",
+      "afterAll",
+      "afterEach"
+    ]
+  }
+}

commitlint.config.js

@@ -1,4 +1,3 @@
-/* eslint-disable */
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   parserPreset: {

demo/apollo.js

@@ -50,7 +50,7 @@ async function launchServer() {
   await server.listen().then(({ url }) => {
     console.log(`🚀  Apollo Server ready at ${url}`);
 
-    console.log(`Prometheus metrics available on http://localhost:8080`);
+    console.log('Prometheus metrics available on http://localhost:8080');
 
     signalIsUp();
   });

demo/express.js

@@ -14,7 +14,7 @@ async function launchServer() {
     detectKubernetes: false,
   });
 
-  app.get('/', (req, res) => {
+  app.get('/', (_req, res) => {
     res.send('I am the server!');
   });
 
@@ -25,7 +25,7 @@ async function launchServer() {
     signalIsUp();
   });
 
-  console.log(`Prometheus metrics available on http://localhost:8080`);
+  console.log('Prometheus metrics available on http://localhost:8080');
 }
 
 launchServer().catch(console.log);

lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-  'packages/**/*.{ts,js}': ['npm run fix:eslint', 'npm run format:js'],
-  '*.md': ['npm run format:md'],
+  '*': [
+    'biome check', // Format, sort imports, lint, and apply safe fixes
+  ],
 };

package.json

@@ -6,20 +6,18 @@
     "auth": "npm_config_registry=https://registry.npmjs.org npm whoami",
     "build:watch": "preconstruct watch",
     "build": "preconstruct build",
-    "changeset:version-and-format": "changeset version && prettier --write --parser json '**/package.json' && pnpm install --no-frozen-lockfile",
+    "changeset:version-and-format": "changeset version && pnpm format '**/package.json' && pnpm install --no-frozen-lockfile",
     "changeset": "changeset",
     "clean": "manypkg exec rm -rf build dist tsconfig.tsbuildinfo ts-build-cache",
-    "develop": "jest --projects .jestrc.*.json --watch",
-    "fix:eslint": "eslint --fix --format=node_modules/eslint-formatter-pretty",
-    "format:js": "prettier --write '**/packages/**/*.{js,ts}'",
-    "format:md": "prettier --parser markdown --write '*.md'",
-    "format:yaml": "prettier --parser yaml --write '*.yaml'",
-    "format": "npm run format:md && npm run format:js && npm run format:yaml",
-    "lint": "jest --config .jestrc.lint.json",
+    "develop": "jest --projects .jestrc.test.json --watch",
+    "biome:check": "biome check --write",
+    "biome:fix": "biome lint --write",
+    "format": "biome format --write",
+    "lint": "biome lint",
     "prerelease": "cross-env NODE_ENV=production pnpm auth && pnpm build",
     "release": "changeset publish",
     "setup": "husky install && preconstruct dev && manypkg check && check-node-version --package --print",
-    "test:ci:coverage": "cross-env NODE_ENV=test npm test -- --no-watchman --coverage && codecov",
+    "test:ci:coverage": "cross-env NODE_ENV=test npm test -- --no-watchman --coverage",
     "test:ci": "cross-env NODE_ENV=test npm test -- --no-watchman",
     "test:coverage": "cross-env NODE_ENV=test npm test -- --coverage",
     "test:watch": "cross-env NODE_ENV=test npm test -- --watch",
@@ -51,9 +49,9 @@
   "packageManager": "[email protected]",
   "dependencies": {
     "@babel/core": "7.25.2",
-    "@babel/eslint-parser": "7.25.1",
     "@babel/preset-env": "7.25.4",
     "@babel/preset-typescript": "7.24.7",
+    "@biomejs/biome": "1.9.4",
     "@changesets/changelog-github": "0.5.0",
     "@changesets/cli": "2.27.8",
     "@commitlint/cli": "19.5.0",
@@ -63,24 +61,12 @@
     "@tsconfig/node18": "18.2.4",
     "@types/node": "20.16.13",
     "@types/semver": "7.5.8",
-    "@typescript-eslint/eslint-plugin": "7.7.1",
-    "@typescript-eslint/parser": "7.7.1",
     "check-node-version": "4.2.1",
-    "codecov": "3.8.3",
     "cross-env": "7.0.3",
-    "eslint": "8.57.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-config-xo": "0.44.0",
-    "eslint-config-xo-typescript": "4.0.0",
-    "eslint-formatter-pretty": "5.0.0",
-    "eslint-plugin-jest": "28.3.0",
-    "eslint-plugin-prettier": "5.1.3",
     "husky": "9.0.11",
     "jest": "29.7.0",
-    "jest-runner-eslint": "2.2.0",
     "jest-watch-typeahead": "2.2.2",
     "lint-staged": "15.2.10",
-    "prettier": "3.2.5",
     "rimraf": "5.0.10",
     "ts-jest": "29.1.5",
     "typescript": "5.6.2"

packages/apollo/src/index.ts

@@ -1,17 +1,17 @@
 import {
-  type TPromsterOptions,
-  createPlugin,
-  signalIsUp,
-  signalIsNotUp,
-} from './plugin';
-import {
-  getSummary,
-  getContentType,
   Prometheus,
-  defaultRegister,
   defaultNormalizers,
+  defaultRegister,
+  getContentType,
+  getSummary,
   timing,
 } from '@promster/metrics';
+import {
+  type TPromsterOptions,
+  createPlugin,
+  signalIsNotUp,
+  signalIsUp,
+} from './plugin';
 
 export {
   type TPromsterOptions,