feat: add linter & switch formatter to biome (gitify-app#976)

Author: afonsojramos

.github/workflows/run-tests.yml

@@ -19,7 +19,7 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'pnpm'
       - run: pnpm install
-      - run: pnpm prettier:check
+      - run: pnpm lint:check
       - run: pnpm tsc --noEmit
       - run: pnpm test -- --coverage --runInBand --verbose
       - name: Coveralls

.gitignore

@@ -73,4 +73,3 @@ temp/
 
 dist/
 build/
-.vscode/settings.json

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["biomejs.biome"]
+}

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports.biome": "explicit",
+    "quickfix.biome": "explicit"
+  },
+  "editor.defaultFormatter": "biomejs.biome"
+}

.vscode/settings.json

@@ -46,18 +46,18 @@ The release process is automated. Follow the steps below.
 
 ### Tests
 
-There are 2 checks - one for prettier and one for the unit tests with `jest`.
+There are 2 checks - one for biome (linter & formatter) and one for the unit tests with `jest`.
 
-```
-    // Run prettier to check
-    pnpm prettier:check
+```shell
+# Run biome to check linting and formatting
+pnpm lint:check
 
-    // Run linter & unit tests with coverage
-    pnpm test
+# Run unit tests with coverage
+pnpm test
 
-    // If you want to pass arguments to jest (or other `pnpm` commands)
-    // like `--watch`, you can prepend `--` to the command
-    pnpm test -- --watch
+# If you want to pass arguments to jest (or other `pnpm` commands)
+# like `--watch`, you can prepend `--` to the command
+pnpm test -- --watch
 ```
 
 ### FAQ

README.md

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.6.4/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "correctness": {
+        "useExhaustiveDependencies": "warn"
+      }
+    }
+  },
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "jsxQuoteStyle": "double"
+    }
+  },
+  "json": {
+    "parser": {
+      "allowComments": true
+    }
+  }
+}

biome.json

@@ -10,8 +10,8 @@
     "make:linux": "electron-builder --linux",
     "make:macos": "electron-builder --mac --universal",
     "make:win": "electron-builder --win",
-    "prettier:check": "prettier --check '*.{html,js,json,md,ts,tsx}'",
-    "prettier:apply": "prettier --write '*.{html,js,json,md,ts,tsx}'",
+    "lint:check": "biome check *",
+    "lint": "biome check --apply *",
     "test": "jest",
     "start": "electron . --enable-logging",
     "prepare": "husky"
@@ -50,6 +50,10 @@
     {
       "name": "Adam Setch",
       "url": "https://github.com/setchy"
+    },
+    {
+      "name": "Afonso Ramos",
+      "url": "https://github.com/afonsojramos"
     }
   ],
   "license": "MIT",
@@ -76,9 +80,7 @@
       "gatekeeperAssess": false,
       "entitlements": "./entitlements/entitlements.mac.plist",
       "entitlementsInherit": "./entitlements/entitlements.mac.plist",
-      "publish": [
-        "github"
-      ],
+      "publish": ["github"],
       "extendInfo": {
         "NSBluetoothAlwaysUsageDescription": null,
         "NSBluetoothPeripheralUsageDescription": null,
@@ -98,12 +100,7 @@
       "oneClick": false
     },
     "linux": {
-      "target": [
-        "AppImage",
-        "deb",
-        "rpm",
-        "snap"
-      ],
+      "target": ["AppImage", "deb", "rpm", "snap"],
       "category": "Development",
       "maintainer": "Emmanouil Konstantinidis"
     },
@@ -127,6 +124,7 @@
     "typescript": "5.4.4"
   },
   "devDependencies": {
+    "@biomejs/biome": "1.6.4",
     "@electron/notarize": "2.3.0",
     "@testing-library/react": "14.2.2",
     "@types/jest": "29.5.12",
@@ -146,7 +144,6 @@
     "nock": "13.5.4",
     "postcss": "8.4.38",
     "postcss-loader": "8.1.1",
-    "prettier": "3.2.5",
     "react-test-renderer": "18.2.0",
     "rimraf": "5.0.5",
     "style-loader": "3.3.4",
@@ -158,6 +155,6 @@
   },
   "packageManager": "[email protected]",
   "lint-staged": {
-    "*.{html,js,json,md,ts,tsx}": "prettier --write"
+    "*.{html,js,json,md,ts,tsx}": "biome format --write"
   }
 }

package.json

@@ -1,5 +1,5 @@
-import { Theme, AuthState, SettingsState } from '../types';
-import { mockedUser, mockedEnterpriseAccounts } from './mockedData';
+import { type AuthState, type SettingsState, Theme } from '../types';
+import { mockedEnterpriseAccounts, mockedUser } from './mockedData';
 
 export const mockAccounts: AuthState = {
   token: 'token-123-456',