Use-biome (#302)

* Use biome formatter

* Start migration to biome linter

* Fix intentional empty interfaces

* Apply automatic changes

* Fix remaining biome items

* Use biome check instead of lint

* Respect .gitignore

* Remove prettier and eslint

* Fix remaining issues

* Fix biome not ignoring files

* Fix preamble

* Do not use * in biome paths

.gitignore

@@ -1,7 +1,12 @@
 node_modules
 dist
 **/tsconfig.tsbuildinfo
-**/tsconfig.prod.tsbuildinfo
 .vercel
-packages/website/.vitepress
-packages/website/generators/test-examples/output/examples.test.ts
+.vscode
+
+# Instead of packages/website we use ** because biome has some weird bug
+# where it incorrectly uses the .gitignore file
+**/docs/.vitepress/cache
+**/docs/.vitepress/dist
+**/docs/api/api-reference.md
+**/generators/test-examples/output/examples.test.ts

CONTRIBUTING.md

@@ -27,8 +27,8 @@ pnpm test
 
 ### Introducing changes
 
-We use prettier, and static analysis extensively but don't you worry! We have a
-magic script to run all checks locally and automatically fix all the
+We use a formatter and static analysis extensively but don't you worry! We have
+a magic script to run all checks locally and automatically fix all the
 auto-fixable problems:
 
 ```

biome.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.7.0/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "defaultBranch": "main",
+    "useIgnoreFile": true
+  },
+  "formatter": {
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "asNeeded"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  }
+}

examples/example-mocha/package.json

@@ -4,10 +4,10 @@
   "version": "1.0.0",
   "scripts": {
     "start": "ts-node -T ./src/index.ts",
-    "format": "prettier --check .",
-    "format:fix": "prettier --write .",
-    "lint": "eslint --ext .ts --max-warnings 0 src",
-    "lint:fix": "pnpm lint --fix",
+    "format": "biome format .",
+    "format:fix": "biome format --write .",
+    "lint": "biome check ./src",
+    "lint:fix": "biome check --apply ./src",
     "typecheck": "tsc --noEmit",
     "test": "mocha",
     "test:fix": "pnpm lint:fix && pnpm format:fix && pnpm test && pnpm typecheck"

examples/example-plugin/package.json

@@ -8,10 +8,10 @@
   "types": "./types.d.ts",
   "scripts": {
     "start": "ts-node -T ./src/index.ts",
-    "format": "prettier --check .",
-    "format:fix": "prettier --write .",
-    "lint": "eslint --ext .ts --max-warnings 0 src",
-    "lint:fix": "pnpm lint --fix",
+    "format": "biome format .",
+    "format:fix": "biome format --write .",
+    "lint": "biome check ./src",
+    "lint:fix": "biome check --apply ./src",
     "typecheck": "tsc --noEmit",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
     "build": "pnpm clean && tsc --build",

examples/example-plugin/src/toBeEven.ts

@@ -1,7 +1,6 @@
-import { Control, formatCompact, registerValidator } from 'earl'
+import { type Control, formatCompact, registerValidator } from 'earl'
 
 declare module 'earl' {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   interface Validators<T> {
     toBeEven(this: Validators<number>): void
   }

examples/example-uvu/package.json

@@ -4,10 +4,10 @@
   "version": "1.0.0",
   "scripts": {
     "start": "ts-node -T ./src/index.ts",
-    "format": "prettier --check .",
-    "format:fix": "prettier --write .",
-    "lint": "eslint --ext .ts --max-warnings 0 src",
-    "lint:fix": "pnpm lint --fix",
+    "format": "biome format .",
+    "format:fix": "biome format --write .",
+    "lint": "biome check ./src",
+    "lint:fix": "biome check --apply ./src",
     "typecheck": "tsc --noEmit",
     "test": "uvu -r ts-node/register src",
     "test:fix": "pnpm lint:fix && pnpm format:fix && pnpm test && pnpm typecheck"

package.json

@@ -28,25 +28,19 @@
   },
   "devDependencies": {
     "@changesets/cli": "^2.26.1",
-    "@krzkaczor/prettier-plugin-jsdoc": "0.4.3",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/mocha": "^10.0.1",
     "@types/node": "^18.15.11",
-    "@typescript-eslint/eslint-plugin": "5.57.0",
-    "@typescript-eslint/parser": "5.57.0",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "conditional-type-checks": "^1.0.6",
-    "eslint": "^8.37.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-simple-import-sort": "^10.0.0",
-    "eslint-plugin-unused-imports": "^2.0.0",
     "mocha": "10.2.0",
-    "prettier": "^2.8.7",
     "rimraf": "^4.4.1",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.3"
+  },
+  "dependencies": {
+    "@biomejs/biome": "^1.7.0"
   }
 }

packages/e2e/package.json

@@ -3,10 +3,10 @@
   "version": "1.0.0",
   "private": true,
   "scripts": {
-    "format": "prettier --check .",
-    "format:fix": "prettier --write .",
-    "lint": "eslint --ext .ts,.js --max-warnings 0 test-esbuild test-node test-ts-node",
-    "lint:fix": "pnpm lint --fix",
+    "format": "biome format .",
+    "format:fix": "biome format --write .",
+    "lint": "biome check .",
+    "lint:fix": "biome check --apply .",
     "typecheck": "tsc --noEmit",
     "test": "pnpm test:babel && pnpm test:esbuild && pnpm test:mjs && pnpm test:node && pnpm test:ts-node",
     "test:babel": "mocha --config test-babel/.mocharc.js",

packages/e2e/test-esbuild/stack-traces.test.ts

@@ -28,7 +28,7 @@ async function captureErrorAsync(fn: () => Promise<void>) {
 
 function getStack(error: Error) {
   const stack = utils.stackTraceFilter()(error.stack ?? '')
-  return Parser.parse({ stack } as any).map((x) => ({
+  return Parser.parse({ stack } as Error).map((x) => ({
     at: x.functionName,
     file: x.fileName,
   }))

packages/e2e/test-node/stack-traces.test.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
 const { expect } = require('earl')
 const { utils } = require('mocha')
 const Parser = require('error-stack-parser')

packages/e2e/test-ts-node/stack-traces.test.ts

@@ -28,7 +28,7 @@ async function captureErrorAsync(fn: () => Promise<void>) {
 
 function getStack(error: Error) {
   const stack = utils.stackTraceFilter()(error.stack ?? '')
-  return Parser.parse({ stack } as any).map((x) => ({
+  return Parser.parse({ stack } as Error).map((x) => ({
     at: x.functionName,
     file: x.fileName,
   }))

packages/earl/package.json

@@ -43,10 +43,10 @@
     "!src/test"
   ],
   "scripts": {
-    "format": "prettier --check .",
-    "format:fix": "prettier --write .",
-    "lint": "eslint --ext .ts --max-warnings 0 src",
-    "lint:fix": "pnpm lint --fix",
+    "format": "biome format .",
+    "format:fix": "biome format --write .",
+    "lint": "biome check ./src",
+    "lint:fix": "biome check --apply ./src",
     "typecheck": "tsc --noEmit",
     "clean": "rimraf dist",
     "build": "pnpm run clean && pnpm run build:esm && pnpm run build:cjs",

packages/earl/src/Control.ts

@@ -43,8 +43,8 @@ export class Control {
             ? result.negatedReason
             : result.negatedReason()
           : typeof result.reason === 'string'
-          ? result.reason
-          : result.reason(),
+            ? result.reason
+            : result.reason(),
         stack: this._location.stack(),
         ...formatActualAndExpected(result),
       })