Merge pull request #80 from MatthewWid/biome

Migrate from Prettier and ESLint to Biome

.github/workflows/lint.yaml

@@ -0,0 +1,14 @@
+name: lint
+on: [push, pull_request]
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: pnpm/action-setup@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version-file: "package.json"
+                  cache: "pnpm"
+            - run: pnpm install
+            - run: pnpm run ci

biome.json

@@ -0,0 +1,54 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true,
+		"defaultBranch": "master"
+	},
+	"files": {
+		"ignore": [
+			"docs/src/content/snippets/*.ts",
+			"docs/src/**/*.astro",
+			"examples/*/public/*.js"
+		],
+		"ignoreUnknown": false
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "tab",
+		"indentWidth": 2,
+		"lineEnding": "lf",
+		"lineWidth": 80,
+		"bracketSpacing": true
+	},
+	"organizeImports": { "enabled": true },
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"correctness": {
+				"noUnusedVariables": "warn"
+			},
+			"complexity": {
+				"useLiteralKeys": "off"
+			},
+			"suspicious": {
+				"noEmptyBlockStatements": "error"
+			},
+			"style": {
+				"useTemplate": "off"
+			}
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"quoteProperties": "asNeeded",
+			"trailingCommas": "es5",
+			"semicolons": "always",
+			"arrowParentheses": "always",
+			"quoteStyle": "double",
+			"bracketSpacing": false
+		}
+	}
+}

docs/astro.config.ts

@@ -1,5 +1,5 @@
-import {defineConfig} from "astro/config";
 import starlight from "@astrojs/starlight";
+import {defineConfig} from "astro/config";
 
 export default defineConfig({
 	site: "https://matthewwid.github.io",

docs/src/env.d.ts

@@ -1 +1 @@
-/// <reference path="../.astro/types.d.ts" />
+/// <reference path="../.astro/types.d.ts" />

examples/benchmarks/benchmark.ts

@@ -1,5 +1,7 @@
 import {suite as suiteChannelPushManySessions} from "./suites/channel-push-many-sessions";
 
-Promise.all([suiteChannelPushManySessions.setup()]).then((suites) =>
-	suites.forEach((suite) => suite.run())
-);
+Promise.all([suiteChannelPushManySessions.setup()]).then((suites) => {
+	for (const suite of suites) {
+		suite.run();
+	}
+});

examples/benchmarks/lib/createClientPool.ts

@@ -25,6 +25,8 @@ export const createClientPool = async ({
 	await Promise.all(listeners);
 
 	return () => {
-		sources.forEach((eventsource) => eventsource.close());
+		for (const eventsource of sources) {
+			eventsource.close();
+		}
 	};
 };

examples/benchmarks/suites/Suite.ts

@@ -1,5 +1,5 @@
 import {Suite as BenchmarkSuite} from "benchmark";
-import express, {Express} from "express";
+import express, {type Express} from "express";
 
 /**
  * Wrap the Benchmark.js Suite with a much nicer and more
@@ -8,7 +8,10 @@ import express, {Express} from "express";
 export class Suite extends BenchmarkSuite {
 	static port = 8000;
 
-	constructor(name: string, private createBenchmarks: () => Promise<void>) {
+	constructor(
+		name: string,
+		private createBenchmarks: () => Promise<void>
+	) {
 		super(name, {async: true});
 
 		this.on("start", () => {

examples/benchmarks/suites/channel-push-many-sessions.ts

@@ -1,10 +1,10 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 
-import {createSession, createChannel} from "better-sse";
-// @ts-ignore
-import SseChannel from "sse-channel";
+import {createChannel, createSession} from "better-sse";
 // @ts-ignore
 import EasySse from "easy-server-sent-events";
+// @ts-ignore
+import SseChannel from "sse-channel";
 import {createClientPool} from "../lib/createClientPool";
 import {Suite} from "./Suite";
 

examples/channels/server.ts

@@ -1,6 +1,6 @@
-import path from "path";
-import express from "express";
+import path from "node:path";
 import {createSession} from "better-sse";
+import express from "express";
 import {ticker} from "./channels/ticker";
 
 const app = express();

examples/getting-started/server.ts

@@ -1,6 +1,6 @@
-import path from "path";
+import path from "node:path";
+import {type Session, createSession} from "better-sse";
 import express from "express";
-import {createSession, Session} from "better-sse";
 
 const app = express();
 

examples/http2/server.ts

@@ -1,12 +1,12 @@
-import {resolve} from "path";
-import {promisify} from "util";
-import {createSecureServer} from "http2";
+import {createSecureServer} from "node:http2";
+import {resolve} from "node:path";
+import {promisify} from "node:util";
+import {createSession} from "better-sse";
 import {
-	CertificateCreationOptions,
-	CertificateCreationResult,
+	type CertificateCreationOptions,
+	type CertificateCreationResult,
 	createCertificate as createCertificateCallback,
 } from "pem";
-import {createSession} from "better-sse";
 
 (async () => {
 	const createCertificate = promisify<

examples/resource-monitor/channels/resource.ts

@@ -1,5 +1,5 @@
-import osu, {NetStatMetrics} from "node-os-utils";
 import {createChannel} from "better-sse";
+import osu, {type NetStatMetrics} from "node-os-utils";
 
 const resource = createChannel();
 
@@ -11,10 +11,13 @@ const broadcastSystemStats = async () => {
 	const {totalMemMb, freeMemMb} = await osu.mem.info();
 	const memoryUsage = (freeMemMb / totalMemMb) * 100;
 
-	resource.broadcast({
-		cpuUsage,
-		memoryUsage,
-	}, "system-stats");
+	resource.broadcast(
+		{
+			cpuUsage,
+			memoryUsage,
+		},
+		"system-stats"
+	);
 
 	setTimeout(broadcastSystemStats, interval);
 };
@@ -27,10 +30,13 @@ const broadcastNetStats = async () => {
 		total: {inputMb, outputMb},
 	} = netStats as NetStatMetrics;
 
-	resource.broadcast({
-		inputMb,
-		outputMb,
-	}, "net-stats");
+	resource.broadcast(
+		{
+			inputMb,
+			outputMb,
+		},
+		"net-stats"
+	);
 
 	setTimeout(broadcastNetStats, interval);
 };

examples/resource-monitor/server.ts

@@ -1,6 +1,6 @@
-import path from "path";
-import express from "express";
+import path from "node:path";
 import {createSession} from "better-sse";
+import express from "express";
 import {resource} from "./channels/resource";
 
 const app = express();

examples/streams/server.ts

@@ -1,7 +1,7 @@
-import path from "path";
-import express from "express";
+import path from "node:path";
+import {Readable} from "node:stream";
 import {createSession} from "better-sse";
-import {Readable} from "stream";
+import express from "express";
 
 const app = express();
 

package.json

@@ -18,9 +18,10 @@
 	"scripts": {
 		"build": "tsup",
 		"test": "vitest",
-		"format": "prettier --write ./src/**/*.ts",
-		"lint": "eslint \"./src/**/*.ts\"",
-		"prepublishOnly": "npm-run-all format test build"
+		"format": "biome check --linter-enabled=false --write",
+		"lint": "biome lint --write",
+		"ci": "biome ci",
+		"prepublishOnly": "npm-run-all ci build"
 	},
 	"main": "./build/index.js",
 	"module": "./build/index.mjs",
@@ -32,27 +33,19 @@
 			"import": "./build/index.mjs"
 		}
 	},
-	"files": [
-		"build",
-		"!build/**/*.map"
-	],
+	"files": ["build", "!build/**/*.map"],
 	"engines": {
 		"node": ">=20",
 		"pnpm": ">=9"
 	},
 	"devDependencies": {
+		"@biomejs/biome": "1.9.4",
 		"@tsconfig/node20": "^20.1.4",
 		"@types/eventsource": "^1.1.15",
 		"@types/express": "^5.0.0",
 		"@types/node": "^22.7.6",
-		"@typescript-eslint/eslint-plugin": "^8.9.0",
-		"@typescript-eslint/parser": "^8.9.0",
-		"eslint": "^8.57.1",
-		"eslint-plugin-tsdoc": "^0.3.0",
 		"eventsource": "^2.0.2",
 		"npm-run-all": "^4.1.5",
-		"prettier": "^3.3.3",
-		"ts-node": "^10.9.2",
 		"tsup": "^8.3.0",
 		"typescript": "^5.6.3",
 		"vitest": "^2.1.3"