Replace ESLint and Prettier with Biome

wojtekmaj · Jun 5, 2024 · 143740d · 143740d
1 parent 52fd082
commit 143740d
Show file tree

Hide file tree

Showing 22 changed files with 178 additions and 1,493 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,32 +18,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Cache Yarn cache
-        uses: actions/cache@v4
-        env:
-          cache-name: yarn-cache
-        with:
-          path: ~/.yarn/berry/cache
-          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ env.cache-name }}
-
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-
-      - name: Enable Corepack
-        run: corepack enable
-
-      - name: Install dependencies
-        run: yarn --immutable
-
-      - name: Build package
-        run: yarn build
+      - name: Setup Biome
+        uses: biomejs/setup-biome@v2
 
       - name: Run tests
-        run: yarn lint
+        run: biome lint
 
   typescript:
     name: Type checking (React ${{ matrix.react }})
@@ -99,29 +78,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Cache Yarn cache
-        uses: actions/cache@v4
-        env:
-          cache-name: yarn-cache
-        with:
-          path: ~/.yarn/berry/cache
-          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ env.cache-name }}
-
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-
-      - name: Enable Corepack
-        run: corepack enable
-
-      - name: Install dependencies
-        run: yarn --immutable
+      - name: Setup Biome
+        uses: biomejs/setup-biome@v2
 
       - name: Run formatting
-        run: yarn format
+        run: biome format
 
   unit:
     name: Unit tests (React ${{ matrix.react }})

diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1 +1 @@
-yarn lint-staged
+yarn format --staged --no-errors-on-unmatched --write
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
diff --git a/.prettierignore b/.prettierignore
diff --git a/.prettierrc.json b/.prettierrc.json
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,4 +1,4 @@
 {
-  "recommendations": ["dbaeumer.vscode-eslint", "eamodio.gitlens", "esbenp.prettier-vscode"],
+  "recommendations": ["biomejs.biome", "eamodio.gitlens"],
   "unwantedRecommendations": ["dbaeumer.jshint"]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,5 @@
 {
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.defaultFormatter": "biomejs.biome",
   "editor.formatOnSave": true,
   "search.exclude": {
     "**/.yarn": true

diff --git a/biome.json b/biome.json
@@ -0,0 +1,43 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.0/schema.json",
+  "files": {
+    "ignore": [".tsimp", "coverage", "dist", ".pnp.cjs", ".pnp.loader.mjs"]
+  },
+  "formatter": {
+    "lineWidth": 100,
+    "indentStyle": "space"
+  },
+  "linter": {
+    "rules": {
+      "complexity": {
+        "noUselessSwitchCase": "off"
+      },
+      "suspicious": {
+        "noConsoleLog": "warn"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single"
+    }
+  },
+  "overrides": [
+    {
+      "include": ["**/package.json"],
+      "formatter": {
+        "lineWidth": 1
+      }
+    },
+    {
+      "include": ["**/vite.config.ts"],
+      "linter": {
+        "rules": {
+          "suspicious": {
+            "noConsoleLog": "off"
+          }
+        }
+      }
+    }
+  ]
+}
diff --git a/package.json b/package.json
@@ -18,12 +18,9 @@
     "unit": "yarn workspaces foreach --all run unit"
   },
   "devDependencies": {
-    "husky": "^9.0.0",
-    "lint-staged": "^15.0.0",
-    "prettier": "^3.2.0"
+    "husky": "^9.0.0"
   },
   "resolutions": {
-    "eslint-plugin-import": "npm:eslint-plugin-i@^2.28.0",
     "pdfjs-dist": "patch:pdfjs-dist@npm:4.3.136#.yarn/patches/pdfjs-dist-npm-4.3.136-35a0e70ced.patch"
   },
   "packageManager": "[email protected]"

diff --git a/packages/react-pdf/.eslintignore b/packages/react-pdf/.eslintignore
diff --git a/packages/react-pdf/.eslintrc.json b/packages/react-pdf/.eslintrc.json
diff --git a/packages/react-pdf/.prettierignore b/packages/react-pdf/.prettierignore
diff --git a/packages/react-pdf/package.json b/packages/react-pdf/package.json
@@ -36,8 +36,8 @@
     "build-js-cjs-package": "echo '{\n  \"type\": \"commonjs\"\n}' > dist/cjs/package.json",
     "clean": "rimraf dist",
     "copy-styles": "cpy 'src/**/*.css' dist/esm && cpy 'src/**/*.css' dist/cjs",
-    "format": "prettier --check . --cache",
-    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "format": "biome format",
+    "lint": "biome lint",
     "prepack": "yarn clean && yarn build",
     "test": "yarn lint && yarn tsc && yarn format && yarn unit",
     "tsc": "tsc",
@@ -65,6 +65,7 @@
     "warning": "^4.0.0"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.8.0",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0",
@@ -74,11 +75,8 @@
     "canvas": "^2.11.2",
     "core-js": "^3.37.0",
     "cpy-cli": "^5.0.0",
-    "eslint": "^8.56.0",
-    "eslint-config-wojtekmaj": "^1.0.0",
     "jsdom": "^24.0.0",
     "nodemon": "^3.0.0",
-    "prettier": "^3.2.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "rimraf": "^3.0.0",

diff --git a/packages/react-pdf/src/Page/AnnotationLayer.tsx b/packages/react-pdf/src/Page/AnnotationLayer.tsx
@@ -47,7 +47,7 @@ export default function AnnotationLayer() {
   const layerElement = useRef<HTMLDivElement>(null);
 
   warning(
-    parseInt(
+    Number.parseInt(
       window.getComputedStyle(document.body).getPropertyValue('--react-pdf-annotation-layer'),
       10,
     ) === 1,

diff --git a/packages/react-pdf/src/Page/TextLayer.tsx b/packages/react-pdf/src/Page/TextLayer.tsx
@@ -43,7 +43,7 @@ export default function TextLayer() {
   const endElement = useRef<HTMLElement | undefined>(undefined);
 
   warning(
-    parseInt(
+    Number.parseInt(
       window.getComputedStyle(document.body).getPropertyValue('--react-pdf-text-layer'),
       10,
     ) === 1,

diff --git a/sample/create-react-app-5/package.json b/sample/create-react-app-5/package.json
@@ -33,7 +33,6 @@
     "typescript": "^5.0.0"
   },
   "resolutions": {
-    "eslint-plugin-import@^2.25.3": "npm:eslint-plugin-i@^2.28.0",
     "mini-css-extract-plugin": "~2.4.0"
   },
   "browserslist": {

diff --git a/test/.eslintignore b/test/.eslintignore
diff --git a/test/.eslintrc.json b/test/.eslintrc.json
diff --git a/test/.prettierignore b/test/.prettierignore
diff --git a/test/Test.tsx b/test/Test.tsx
@@ -68,8 +68,6 @@ export function readAsDataURL(file: Blob): Promise<string> {
   });
 }
 
-/* eslint-disable no-console */
-
 export default function Test() {
   const [canvasBackground, setCanvasBackground] = useState<string>();
   const [devicePixelRatio, setDevicePixelRatio] = useState<number>();

diff --git a/test/package.json b/test/package.json
@@ -7,8 +7,8 @@
   "scripts": {
     "build": "vite build",
     "dev": "vite",
-    "format": "prettier --check . --cache",
-    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "format": "biome format",
+    "lint": "biome lint",
     "preview": "vite preview",
     "test": "yarn lint && yarn tsc && yarn format",
     "tsc": "tsc"
@@ -25,11 +25,9 @@
     "tiny-invariant": "^1.0.0"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.8.0",
     "@types/react": "*",
     "@vitejs/plugin-react": "^4.2.0",
-    "eslint": "^8.56.0",
-    "eslint-config-wojtekmaj": "^1.0.0",
-    "prettier": "^3.2.0",
     "typescript": "^5.4.2",
     "vite": "^5.0.0",
     "vite-plugin-static-copy": "^1.0.0"