feat: replace prettier + eslint w/ biome (#91)

* feat; * fix: lint fix
gairal · Aug 4, 2024 · 56debbf · 56debbf
1 parent 657c412
commit 56debbf
Show file tree

Hide file tree

Showing 26 changed files with 73 additions and 138 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,6 +17,6 @@ jobs:
         with:
           bun-version: latest
       - run: bun i --frozen-lockfile
-      - run: bun lint
+      - run: bun biome ci --diagnostic-level=error
       - run: bun run build
       - run: bun test-cov
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # [frank.gairal.rocks](https://frank.gairal.rocks) RESTful API ![CI status](https://github.com/gairal/frank-bo-node/actions/workflows/ci.yml/badge.svg)
 
 > A REST API built with [TypeScript](https://www.typescriptlang.org/), [Koa](https://koajs.com/),
-> [Jest](https://jestjs.io/), [Prettier](https://prettier.io/), [eslint](https://eslint.org/) and ❤️
+> [Jest](https://jestjs.io/), [bun](https://bun.sh/), [biome](https://biomejs.dev/) and ❤️
 
 ## TOC
 

diff --git a/biome.json b/biome.json
@@ -0,0 +1,36 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "files": {
+    "ignore": ["dist", "node_modules"]
+  },
+  "formatter": {
+    "indentStyle": "space"
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "all": true,
+      "correctness": { "noNodejsModules": "off" },
+      "nursery": {
+        "all": true,
+        "useImportExtensions": "off",
+        "useImportRestrictions": "off"
+      },
+      "performance": { "noBarrelFile": "off", "noReExportAll": "off" }
+    }
+  },
+  "javascript": {
+    "globals": ["afterAll", "beforeAll", "describe", "expect", "it"]
+  },
+  "overrides": [
+    {
+      "include": ["lint-staged.config.js"],
+      "linter": {
+        "rules": { "style": { "useFilenamingConvention": "off" } }
+      }
+    }
+  ]
+}
diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -10,32 +10,26 @@
     "deploy": "gcloud app deploy --project com-gairal-frank-22",
     "dev": "bun run --hot --inspect ./src/index.ts",
     "gcp-build": "npm run build",
-    "lint": "eslint . --ext .js,.ts --quiet",
+    "lint": "biome check",
     "prepare": "husky",
     "start": "node dist",
     "test": "LOG_LEVEL=error jest",
     "test-cov": "bun run test --collectCoverage"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.8.3",
+    "@tsconfig/node20": "^20.1.4",
     "@types/jest": "^29.5.12",
     "@types/koa": "^2.15.0",
     "@types/koa-logger": "^3.1.5",
     "@types/koa__cors": "^5.0.0",
     "@types/koa__router": "^12.0.4",
     "@types/node": "^22.1.0",
     "@types/supertest": "^6.0.2",
-    "eslint": "^8.57.0",
-    "eslint-config-airbnb-typescript-prettier": "^5.0.0",
-    "eslint-plugin-jest": "^28.6.0",
-    "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-sort-keys-fix": "^1.1.2",
-    "eslint-plugin-testing-library": "^6.2.2",
-    "eslint-plugin-typescript-sort-keys": "^3.2.0",
     "firestore-jest-mock": "^0.25.0",
     "husky": "^9.1.4",
     "jest": "^29.7.0",
     "lint-staged": "^15.2.8",
-    "prettier": "^2.8.8",
     "supertest": "^7.0.0",
     "ts-jest": "^29.2.3",
     "typescript": "^5.5.4"
@@ -51,11 +45,6 @@
     "winston": "^3.13.1"
   },
   "lint-staged": {
-    "*.{js,cjs,ts,svelte}": [
-      "eslint --cache --fix"
-    ],
-    "*.{json,scss,css,md}": [
-      "prettier --write"
-    ]
+    "*.{js,cjs,ts,json,md,lint}": ["bun lint --fix"]
   }
 }
diff --git a/src/app.ts b/src/app.ts
@@ -1,15 +1,15 @@
+import cors from "@koa/cors";
 import Koa from "koa";
 import helmet from "koa-helmet";
 import logger from "koa-logger";
-import cors from "@koa/cors";
 
+import { LOG_LEVEL } from "./env";
+import { errorHandler } from "./lib/errorHandler";
 import { educationRouter } from "./routes/education";
 import { interestRouter } from "./routes/interest";
 import { skillRouter } from "./routes/skill";
 import { travelRouter } from "./routes/travel";
 import { workRouter } from "./routes/work";
-import { LOG_LEVEL } from "./env";
-import { errorHandler } from "./lib/errorHandler";
 
 export const app = new Koa();
 
@@ -28,7 +28,7 @@ app.use(
       ctx.header.origin?.includes("gairal.")
         ? ctx.header.origin
         : "http://localhost:3000",
-  })
+  }),
 );
 
 /** ROUTES */

diff --git a/src/lib/errorHandler.ts b/src/lib/errorHandler.ts
@@ -1,4 +1,4 @@
-import { Middleware } from "koa";
+import type { Middleware } from "koa";
 
 import { logger } from "./logger";
 

diff --git a/src/model/education.ts b/src/model/education.ts
@@ -1,7 +1,7 @@
-import { QueryDocumentSnapshot } from "@google-cloud/firestore";
+import type { QueryDocumentSnapshot } from "@google-cloud/firestore";
 
-import { Education, FirestoreEducation } from "../types/education";
 import { firestore } from "../lib/db";
+import type { Education, FirestoreEducation } from "../types/education";
 
 const collection = firestore.collection("education").withConverter<Education>({
   fromFirestore: (snapshot: QueryDocumentSnapshot<FirestoreEducation>) => {

diff --git a/src/model/interest.ts b/src/model/interest.ts
@@ -1,7 +1,7 @@
-import { QueryDocumentSnapshot } from "@google-cloud/firestore";
+import type { QueryDocumentSnapshot } from "@google-cloud/firestore";
 
 import { firestore } from "../lib/db";
-import { FirestoreInterest, Interest } from "../types/interest";
+import type { FirestoreInterest, Interest } from "../types/interest";
 
 const collection = firestore.collection("interest").withConverter<Interest>({
   fromFirestore: (snapshot: QueryDocumentSnapshot<FirestoreInterest>) => {

diff --git a/src/model/skill.ts b/src/model/skill.ts
@@ -1,13 +1,13 @@
-import { QueryDocumentSnapshot } from "@google-cloud/firestore";
+import type { QueryDocumentSnapshot } from "@google-cloud/firestore";
 
 import { firestore } from "../lib/db";
-import { FirestoreSkillByCategory, SkillByCategory } from "../types/skill";
+import type { FirestoreSkillByCategory, SkillByCategory } from "../types/skill";
 
 const collection = firestore
   .collection("skill")
   .withConverter<SkillByCategory>({
     fromFirestore: (
-      snapshot: QueryDocumentSnapshot<FirestoreSkillByCategory>
+      snapshot: QueryDocumentSnapshot<FirestoreSkillByCategory>,
     ) => {
       const { order, ...rest } = snapshot.data();
       return rest;
@@ -23,9 +23,9 @@ export const getAll = () =>
       docs.map((doc) => {
         const data = doc.data();
         data.skills.sort(
-          ({ level: levelA = 0 }, { level: levelB = 0 }) => levelB - levelA
+          ({ level: levelA = 0 }, { level: levelB = 0 }) => levelB - levelA,
         );
 
         return data;
-      })
+      }),
     );
diff --git a/src/model/travel.ts b/src/model/travel.ts
@@ -1,7 +1,7 @@
-import { QueryDocumentSnapshot } from "@google-cloud/firestore";
+import type { QueryDocumentSnapshot } from "@google-cloud/firestore";
 
 import { firestore } from "../lib/db";
-import { FirestoreTravel, Travel } from "../types/travel";
+import type { FirestoreTravel, Travel } from "../types/travel";
 
 const collection = firestore.collection("travel").withConverter<Travel>({
   fromFirestore: (snapshot: QueryDocumentSnapshot<FirestoreTravel>) => {

diff --git a/src/model/work.ts b/src/model/work.ts
@@ -1,7 +1,7 @@
-import { QueryDocumentSnapshot } from "@google-cloud/firestore";
+import type { QueryDocumentSnapshot } from "@google-cloud/firestore";
 
 import { firestore } from "../lib/db";
-import { FirestoreWork, Work } from "../types/work";
+import type { FirestoreWork, Work } from "../types/work";
 
 const collection = firestore.collection("work").withConverter<Work>({
   fromFirestore: (snapshot: QueryDocumentSnapshot<FirestoreWork>) => {

diff --git a/src/types/category.ts b/src/types/category.ts
@@ -1,4 +1,4 @@
-import { DocumentData } from "@google-cloud/firestore";
+import type { DocumentData } from "@google-cloud/firestore";
 
 export interface FirestoreCategory extends DocumentData {
   label: string;

diff --git a/src/types/education.ts b/src/types/education.ts
@@ -1,4 +1,4 @@
-import { DocumentData, Timestamp } from "@google-cloud/firestore";
+import type { DocumentData, Timestamp } from "@google-cloud/firestore";
 
 export interface FirestoreEducation extends DocumentData {
   dateIn: Timestamp;

diff --git a/src/types/interest.ts b/src/types/interest.ts
@@ -1,4 +1,4 @@
-import { DocumentData } from "@google-cloud/firestore";
+import type { DocumentData } from "@google-cloud/firestore";
 
 export interface FirestoreInterest extends DocumentData {
   description?: string;

diff --git a/src/types/skill.ts b/src/types/skill.ts
@@ -1,4 +1,4 @@
-import { FirestoreCategory } from "./category";
+import type { FirestoreCategory } from "./category";
 
 export interface FirestoreSkillByCategory extends FirestoreCategory {
   skills: { description?: string; label: string; level?: number }[];

diff --git a/src/types/travel.ts b/src/types/travel.ts
@@ -1,4 +1,4 @@
-import { DocumentData, GeoPoint } from "@google-cloud/firestore";
+import type { DocumentData, GeoPoint } from "@google-cloud/firestore";
 
 export interface FirestoreTravel extends DocumentData {
   coordinates: GeoPoint;

diff --git a/src/types/work.ts b/src/types/work.ts
@@ -1,4 +1,4 @@
-import { DocumentData, Timestamp } from "@google-cloud/firestore";
+import type { DocumentData, Timestamp } from "@google-cloud/firestore";
 
 export interface FirestoreWork extends DocumentData {
   achievements: { description: string; highlights?: string[] }[];

diff --git a/test/fixtures/education.ts b/test/fixtures/education.ts
@@ -1,6 +1,6 @@
 import { Timestamp } from "@google-cloud/firestore";
 
-import { FirestoreEducation } from "../../src/types/education";
+import type { FirestoreEducation } from "../../src/types/education";
 
 export const educationFixture = (): FirestoreEducation[] => [
   {

diff --git a/test/fixtures/interest.ts b/test/fixtures/interest.ts
@@ -1,4 +1,4 @@
-import { FirestoreInterest } from "../../src/types/interest";
+import type { FirestoreInterest } from "../../src/types/interest";
 
 export const interestFixture = (): FirestoreInterest[] => [
   {

diff --git a/test/fixtures/skill.ts b/test/fixtures/skill.ts
@@ -1,4 +1,4 @@
-import { FirestoreSkillByCategory } from "../../src/types/skill";
+import type { FirestoreSkillByCategory } from "../../src/types/skill";
 
 export const skillFixture = (): FirestoreSkillByCategory[] => [
   {

diff --git a/test/fixtures/travel.ts b/test/fixtures/travel.ts
@@ -1,6 +1,6 @@
 import { GeoPoint } from "@google-cloud/firestore";
 
-import { FirestoreTravel } from "../../src/types/travel";
+import type { FirestoreTravel } from "../../src/types/travel";
 
 export const travelFixture = (): FirestoreTravel[] => [
   {

diff --git a/test/fixtures/work.ts b/test/fixtures/work.ts
@@ -1,6 +1,6 @@
 import { Timestamp } from "@google-cloud/firestore";
 
-import { FirestoreWork } from "../../src/types/work";
+import type { FirestoreWork } from "../../src/types/work";
 
 export const workFixture = (): FirestoreWork[] => [
   {

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,13 +1,8 @@
 {
+  "extends": "@tsconfig/node20/tsconfig.json",
   "compilerOptions": {
-    "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
-    "lib": ["ES2023"],
-    "module": "commonjs",
-    "outDir": "./dist",
-    "skipLibCheck": true,
-    "strict": true,
-    "target": "ES2022"
+    "outDir": "./dist"
   },
   "exclude": [
     "./__mocks__",