Merge pull request #397 from prezly/feature/dev-21712-use-biome-in-sdk

[DEV-21712] Chore - Biome

Author: yuriyyakym

.eslintrc.cjs

@@ -4,7 +4,7 @@ on: [push]
 
 jobs:
   build:
-    name: Build, Test & Prettier
+    name: Lint, Build & Test
 
     runs-on: ubuntu-latest
 
@@ -46,6 +46,3 @@ jobs:
 
     - name: test
       run: npm test
-
-    - name: prettier
-      run: npm run prettier:check

.github/workflows/check.yml

@@ -0,0 +1,14 @@
+{
+    "$schema": "https://biomejs.dev/schemas/2.2.4/schema.json",
+    "extends": ["@prezly/biome-config"],
+    "files": {
+        "includes": ["src/**"]
+    },
+    "linter": {
+        "rules": {
+            "suspicious": {
+                "noShadowRestrictedNames": "off"
+            }
+        }
+    }
+}

.prettierrc

@@ -36,17 +36,13 @@
         "@babel/plugin-proposal-export-namespace-from": "^7.18.9",
         "@babel/preset-env": "^7.7.1",
         "@babel/preset-typescript": "^7.18.6",
+        "@biomejs/biome": "^2.2.4",
+        "@prezly/biome-config": "^1.0.1",
         "@types/node": "^20.10.4",
-        "@typescript-eslint/eslint-plugin": "^6.13.2",
-        "@typescript-eslint/parser": "^6.13.2",
         "babel-plugin-add-import-extension": "^1.6.0",
         "babel-plugin-transform-inline-environment-variables": "^0.4.4",
         "cross-env": "^7.0.3",
-        "eslint": "^8.56.0",
-        "eslint-config-prettier": "^8.10.0",
-        "eslint-plugin-import": "^2.29.1",
         "np": "^9.2.0",
-        "prettier": "^2.8.8",
         "rimraf": "^3.0.0",
         "typescript": "^5.3.3",
         "vitest": "^1.2.2",
@@ -61,13 +57,13 @@
         "build:cjs": "babel ./src --ignore='**/*.test.ts' --config-file=./babel.config.cjs.json --extensions=.ts,.cts --source-root=./src --out-dir=./dist --out-file-extension .cjs",
         "watch": "tsc --watch --preserveWatchOutput --project .",
         "start": "npm run build --incremental --watch",
-        "lint": "eslint ./src --ext=.ts",
-        "lint:fix": "npm run lint -- --fix",
+        "lint": "biome ci",
+        "lint:fix": "biome lint --write",
         "test": "npm run test:build && npm run test:unit",
         "test:unit": "vitest run",
         "test:build": "node dist/index.js && tsc --noEmit dist/index.d.ts",
-        "prettier:check": "prettier --check './src/**/*.{ts,js}'",
-        "prettier:fix": "prettier --write './src/**/*.{ts,js}'",
+        "format:check": "biome format",
+        "format": "biome format --write",
         "prerelease": "npm run build",
         "release": "np"
     },

biome.json

@@ -1,4 +1,4 @@
-import { readFileSync } from 'fs';
+import { readFileSync } from 'node:fs';
 import { vi, beforeEach, describe, expect, it, afterEach } from 'vitest';
 import type { MockResponseInitFunction } from 'vitest-fetch-mock';
 import createFetchMock from 'vitest-fetch-mock';

package.json

@@ -48,7 +48,8 @@ function handleDeferredJob<V = any, P = any>(
                     update(state.progress, state.value);
 
                     await sleep(JOB_STATUS_POLLING_INTERVAL);
-                } while (true); // eslint-disable-line no-constant-condition
+                    // biome-ignore lint/correctness/noConstantCondition: <This infinite loop is expected and safe. There are two return statements breaking it when needed>
+                } while (true);
             }
 
             resolve(response.payload);

src/Client.test.ts

@@ -85,10 +85,10 @@ export async function createRequest<P = any>(
         if (!response.ok) {
             // Try to parse the response as JSON, if it contains any error messages
             // from backend. If not, fake the error message.
-            let responsePayload;
+            let responsePayload: any;
             try {
                 responsePayload = await response.json();
-            } catch (error) {
+            } catch {
                 responsePayload = createFakeErrorPayload(response);
             }
 

src/api/DeferredJobsApiClient.ts

@@ -114,7 +114,7 @@ type WithNonEmptyTranslation<T extends Category, LocaleCode extends Culture['cod
 function isNonEmpty(
     translation: Category.Translation | undefined,
 ): translation is NonEmptyTranslation {
-    return Boolean(translation && translation.name && translation.slug);
+    return Boolean(translation?.name && translation.slug);
 }
 
 function localeCode(locale: LocaleIdentifier): Culture['code'] {

src/http/createRequest.ts

@@ -120,7 +120,7 @@ function toString(arg: SortOrder | SortOrder.Column | SortOrder.Direction): stri
     return `${toString(arg.direction)}${arg.name}`;
 }
 
-function validateColumnName(name: string): void | never {
+function validateColumnName(name: string): undefined | never {
     if (name.length === 0) {
         throw new Error(`Invalid sort column name: '${name}'.`);
     }