Merge pull request #4 from Tracktor/feat/switch-to-biome

graffkevin · web-flow · commit 597fbf903733 · 2025-10-22T10:16:33.000+02:00
feat: add biome configuration and update linting process
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/.gitignore b/.gitignore
@@ -11,6 +11,7 @@ node_modules
 dist
 dist-ssr
 *.local
+tsconfig.tsbuildinfo
 
 # Editor directories and files
 .vscode/*
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
 # [Versions](https://github.com/Tracktor/react-utils/releases)
 
-## v1.24.0
-- **[feat]** : add util function `getObjectValue` with dot notation support
+## v1.24.1
+- **[fix]** : Change Eslint to Biome for linting
diff --git a/biome.json b/biome.json
@@ -0,0 +1,3 @@
+{
+  "extends": ["@tracktor/biome-config-react"]
+}
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tracktor/react-utils",
   "description": "React data table and react data grid",
-  "version": "1.24.0",
+  "version": "1.24.1",
   "private": false,
   "license": "ISC",
   "type": "module",
@@ -30,7 +30,8 @@
     "coverage": "vitest run --coverage",
     "dev": "vite",
     "build": "tsc && vite build",
-    "lint": "eslint . --max-warnings=0 && tsc --noEmit",
+    "lint": "biome check --diagnostic-level=error . && tsc --noEmit --incremental",
+    "lint:fix": "biome check . --write",
     "preview": "vite preview",
     "test": "vitest",
     "prepare": "yarn run build && husky install"
@@ -39,10 +40,10 @@
     "@testing-library/jest-dom": "^5.17.0",
     "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.5.1",
+    "@tracktor/biome-config-react": "^1.1.1",
     "@types/react": "^18.2.28",
     "@types/react-dom": "^18.2.13",
     "@vitejs/plugin-react": "^4.1.0",
-    "eslint-config-react-tracktor": "^1.7.0",
     "husky": "^8.0.3",
     "jsdom": "^22.1.0",
     "react": "^18.2.0",
diff --git a/src/hooks/useDebounce/useDebounce.ts b/src/hooks/useDebounce/useDebounce.ts
@@ -12,7 +12,7 @@ type Delay = number;
  * @param value
  * @param delayOrOptions
  */
-const useDebounce = <T extends any>(value: T, delayOrOptions?: Delay | Options): T => {
+const useDebounce = <T>(value: T, delayOrOptions?: Delay | Options): T => {
   const isNumberOption = typeof delayOrOptions === "number";
   const onDebounceRef = useRef(isNumberOption ? undefined : delayOrOptions?.onDebounce);
   const [debouncedValue, setDebouncedValue] = useState<T>(value);
diff --git a/src/hooks/useInView/useInView.ts b/src/hooks/useInView/useInView.ts
@@ -1,4 +1,4 @@
-import { useState, RefObject } from "react";
+import { RefObject, useState } from "react";
 import useIsomorphicLayoutEffect from "@/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect";
 
 /**
diff --git a/src/hooks/useLocalStorage/useLocalStorage.ts b/src/hooks/useLocalStorage/useLocalStorage.ts
@@ -48,7 +48,7 @@ const useLocalStorage = <T>(key: string, initialValue?: T, options?: UseLocalSto
 
     try {
       const raw = window.localStorage.getItem(key);
-      return raw ? deserializer(raw) : initialValue ?? (null as T);
+      return raw ? deserializer(raw) : (initialValue ?? (null as T));
     } catch {
       return initialValue ?? (null as T);
     }
diff --git a/src/hooks/useScript/useScript.ts b/src/hooks/useScript/useScript.ts
@@ -19,7 +19,7 @@ const useScript = (src: string, options?: UseScriptOptions): UseScriptStatus =>
 
   useEffect(
     () => {
-      if (!src || !enable) {
+      if (!(src && enable)) {
         setStatus("idle");
         return undefined;
       }
@@ -28,7 +28,10 @@ const useScript = (src: string, options?: UseScriptOptions): UseScriptStatus =>
       // It may have been added by another instance of this hook
       let script: UseScriptScriptElement = document.querySelector(`script[src="${src}"]`);
 
-      if (!script) {
+      if (script) {
+        // Grab existing script status from attribute and set to state.
+        setStatus(script.getAttribute("data-status") as UseScriptStatus);
+      } else {
         // Create script
         script = document.createElement("script");
         script.src = src;
@@ -57,9 +60,6 @@ const useScript = (src: string, options?: UseScriptOptions): UseScriptStatus =>
 
         script.addEventListener("load", setAttributeFromEvent);
         script.addEventListener("error", setAttributeFromEvent);
-      } else {
-        // Grab existing script status from attribute and set to state.
-        setStatus(script.getAttribute("data-status") as UseScriptStatus);
       }
 
       // Script event handler to update status in state
diff --git a/src/main.ts b/src/main.ts
@@ -1,63 +1,63 @@
 // Hook
-export { default as useDebounce } from "@/hooks/useDebounce/useDebounce";
+
 export * from "@/hooks/useDebounce/useDebounce";
-export { default as useToggle } from "@/hooks/useToggle/useToggle";
-export * from "@/hooks/useToggle/useToggle";
-export { default as useScript } from "@/hooks/useScript/useScript";
-export * from "@/hooks/useScript/useScript";
-export { default as useInputState } from "@/hooks/useInputState/useInputState";
-export * from "@/hooks/useInputState/useInputState";
-export { default as useIsomorphicLayoutEffect } from "@/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect";
-export * from "@/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect";
-export { default as useDocumentTitle } from "@/hooks/useDocumentTitle/useDocumentTitle";
+export { default as useDebounce } from "@/hooks/useDebounce/useDebounce";
 export * from "@/hooks/useDocumentTitle/useDocumentTitle";
-export { default as useWindowSize } from "@/hooks/useWindowSize/useWindowSize";
-export * from "@/hooks/useWindowSize/useWindowSize";
-export { default as useEventListener } from "@/hooks/useEventListener/useEventListener";
+export { default as useDocumentTitle } from "@/hooks/useDocumentTitle/useDocumentTitle";
 export * from "@/hooks/useEventListener/useEventListener";
-export { default as useIsMounted } from "@/hooks/useIsMounted/useIsMounted";
-export * from "@/hooks/useIsMounted/useIsMounted";
-export { default as useLocalStorage } from "@/hooks/useLocalStorage/useLocalStorage";
-export * from "@/hooks/useLocalStorage/useLocalStorage";
-export { default as useIntersectionObserver } from "@/hooks/useIntersectionObserver/useIntersectionObserver";
+export { default as useEventListener } from "@/hooks/useEventListener/useEventListener";
+export * from "@/hooks/useInputState/useInputState";
+export { default as useInputState } from "@/hooks/useInputState/useInputState";
 export * from "@/hooks/useIntersectionObserver/useIntersectionObserver";
-export { default as useInView } from "@/hooks/useInView/useInView";
+export { default as useIntersectionObserver } from "@/hooks/useIntersectionObserver/useIntersectionObserver";
 export * from "@/hooks/useInView/useInView";
-
-// Utils
-export { default as removeObjectProperty } from "@/utils/object/removeObjectProperty";
-export * from "@/utils/object/removeObjectProperty";
-export { default as isArray } from "@/utils/is/isArray";
+export { default as useInView } from "@/hooks/useInView/useInView";
+export * from "@/hooks/useIsMounted/useIsMounted";
+export { default as useIsMounted } from "@/hooks/useIsMounted/useIsMounted";
+export * from "@/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect";
+export { default as useIsomorphicLayoutEffect } from "@/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect";
+export * from "@/hooks/useLocalStorage/useLocalStorage";
+export { default as useLocalStorage } from "@/hooks/useLocalStorage/useLocalStorage";
+export * from "@/hooks/useScript/useScript";
+export { default as useScript } from "@/hooks/useScript/useScript";
+export * from "@/hooks/useToggle/useToggle";
+export { default as useToggle } from "@/hooks/useToggle/useToggle";
+export * from "@/hooks/useWindowSize/useWindowSize";
+export { default as useWindowSize } from "@/hooks/useWindowSize/useWindowSize";
+export * from "@/utils/adapter/addressToString";
+export { default as addressToString } from "@/utils/adapter/addressToString";
+export * from "@/utils/adapter/formatCreditCardNumber";
+export { default as formatCreditCardNumber } from "@/utils/adapter/formatCreditCardNumber";
+export * from "@/utils/adapter/getInitials";
+export { default as getInitials } from "@/utils/adapter/getInitials";
+export * from "@/utils/adapter/phoneNumberAdapter";
+export { default as phoneNumberAdapter } from "@/utils/adapter/phoneNumberAdapter";
+export * from "@/utils/adapter/priceAdapter";
+export { default as priceAdapter } from "@/utils/adapter/priceAdapter";
 export * from "@/utils/is/isArray";
-export { default as isRef } from "@/utils/is/isRef";
-export * from "@/utils/is/isRef";
-export { default as isFunction } from "@/utils/is/isFunction";
-export * from "@/utils/is/isFunction";
-export { default as isBoolean } from "@/utils/is/isBoolean";
+export { default as isArray } from "@/utils/is/isArray";
 export * from "@/utils/is/isBoolean";
-export { default as isObject } from "@/utils/is/isObject";
-export * from "@/utils/is/isObject";
-export { default as isNumber } from "@/utils/is/isNumber";
+export { default as isBoolean } from "@/utils/is/isBoolean";
+export * from "@/utils/is/isFunction";
+export { default as isFunction } from "@/utils/is/isFunction";
 export * from "@/utils/is/isNumber";
-export { default as isString } from "@/utils/is/isString";
+export { default as isNumber } from "@/utils/is/isNumber";
+export * from "@/utils/is/isObject";
+export { default as isObject } from "@/utils/is/isObject";
+export * from "@/utils/is/isRef";
+export { default as isRef } from "@/utils/is/isRef";
 export * from "@/utils/is/isString";
-export { default as formatCreditCardNumber } from "@/utils/adapter/formatCreditCardNumber";
-export * from "@/utils/adapter/formatCreditCardNumber";
-export { default as getInitials } from "@/utils/adapter/getInitials";
-export * from "@/utils/adapter/getInitials";
-export { default as addressToString } from "@/utils/adapter/addressToString";
-export * from "@/utils/adapter/addressToString";
-export { default as priceAdapter } from "@/utils/adapter/priceAdapter";
-export * from "@/utils/adapter/priceAdapter";
-export { default as phoneNumberAdapter } from "@/utils/adapter/phoneNumberAdapter";
-export * from "@/utils/adapter/phoneNumberAdapter";
-export { default as capitalize } from "@/utils/string/capitalize";
-export * from "@/utils/string/capitalize";
-export { default as capitalizeWords } from "@/utils/string/capitalizeWords";
-export * from "@/utils/string/capitalizeWords";
-export { default as isDeepEqualObject } from "@/utils/object/isDeepEqualObject";
-export * from "@/utils/object/isDeepEqualObject";
-export { default as toNumberOrZero } from "@/utils/number/toNumber/toNumberOrZero";
+export { default as isString } from "@/utils/is/isString";
 export * from "@/utils/number/toNumber/toNumberOrZero";
-export { default as getObjectValue } from "@/utils/object/getObjectValue/getObjectValue";
+export { default as toNumberOrZero } from "@/utils/number/toNumber/toNumberOrZero";
 export * from "@/utils/object/getObjectValue/getObjectValue";
+export { default as getObjectValue } from "@/utils/object/getObjectValue/getObjectValue";
+export * from "@/utils/object/isDeepEqualObject";
+export { default as isDeepEqualObject } from "@/utils/object/isDeepEqualObject";
+export * from "@/utils/object/removeObjectProperty";
+// Utils
+export { default as removeObjectProperty } from "@/utils/object/removeObjectProperty";
+export * from "@/utils/string/capitalize";
+export { default as capitalize } from "@/utils/string/capitalize";
+export * from "@/utils/string/capitalizeWords";
+export { default as capitalizeWords } from "@/utils/string/capitalizeWords";
diff --git a/src/utils/adapter/phoneNumberAdapter/test/phoneNumberAdapter.test.ts b/src/utils/adapter/phoneNumberAdapter/test/phoneNumberAdapter.test.ts
@@ -1,4 +1,4 @@
-import { describe, it, expect } from "vitest";
+import { describe, expect, it } from "vitest";
 import phoneNumberAdapter from "../phoneNumberAdapter";
 
 describe("phoneNumberAdapter", () => {
diff --git a/src/utils/is/isRef/isRef.ts b/src/utils/is/isRef/isRef.ts
@@ -2,7 +2,6 @@
  * Checks if the given object is a React ref.
  * @param obj
  */
-export const isRef = (obj: unknown): boolean =>
-  obj !== null && typeof obj === "object" && Object.prototype.hasOwnProperty.call(obj, "current");
+export const isRef = (obj: unknown): boolean => obj !== null && typeof obj === "object" && Object.hasOwn(obj, "current");
 
 export default isRef;
diff --git a/src/utils/number/toNumber/toNumberOrZero.test.ts b/src/utils/number/toNumber/toNumberOrZero.test.ts
@@ -1,4 +1,4 @@
-import { describe, it, expect } from "vitest";
+import { describe, expect, it } from "vitest";
 import toNumberOrZero from "./toNumberOrZero";
 
 describe("toNumberOrZero", () => {
diff --git a/src/utils/object/getObjectValue/getObjectValue.test.ts b/src/utils/object/getObjectValue/getObjectValue.test.ts
@@ -1,4 +1,4 @@
-import { describe, it, expect } from "vitest";
+import { describe, expect, it } from "vitest";
 import getObjectValue from "@/utils/object/getObjectValue/getObjectValue";
 
 describe("getObjectValue", () => {
diff --git a/src/utils/object/getObjectValue/getObjectValue.ts b/src/utils/object/getObjectValue/getObjectValue.ts
@@ -23,12 +23,7 @@ export function getObjectValue<T = unknown>(obj: unknown, key: string, defaultVa
 
   const result = key.split(".").reduce((current: unknown, prop: string): unknown => {
     // Early return if a path already invalid or current is not a valid object
-    if (
-      current === PATH_NOT_FOUND ||
-      typeof current !== "object" ||
-      current === null ||
-      !Object.prototype.hasOwnProperty.call(current, prop)
-    ) {
+    if (current === PATH_NOT_FOUND || typeof current !== "object" || current === null || !Object.hasOwn(current, prop)) {
       return PATH_NOT_FOUND;
     }
 
diff --git a/src/utils/string/capitalizeWords/test/capitalizeWords.test.ts b/src/utils/string/capitalizeWords/test/capitalizeWords.test.ts
@@ -1,4 +1,4 @@
-import { describe, it, expect } from "vitest";
+import { describe, expect, it } from "vitest";
 import capitalizeWords from "../capitalizeWords";
 
 describe("capitalizeWords", () => {
@@ -27,7 +27,6 @@ describe("capitalizeWords", () => {
   });
 
   it("should return an empty string if input is not a string", () => {
-    // @ts-ignore
     expect(capitalizeWords(123)).toBe("");
     expect(capitalizeWords(undefined)).toBe("");
     expect(capitalizeWords(null)).toBe("");
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "extends": ["@tracktor/biome-config-react"]`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { useState, RefObject } from "react";`
	`1`	`+import { RefObject, useState } from "react";`
`2`	`2`	`import useIsomorphicLayoutEffect from "@/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect";`
`3`	`3`
`4`	`4`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ const useLocalStorage = <T>(key: string, initialValue?: T, options?: UseLocalSto`
`48`	`48`
`49`	`49`	`try {`
`50`	`50`	`const raw = window.localStorage.getItem(key);`
`51`		`- return raw ? deserializer(raw) : initialValue ?? (null as T);`
	`51`	`+ return raw ? deserializer(raw) : (initialValue ?? (null as T));`
`52`	`52`	`} catch {`
`53`	`53`	`return initialValue ?? (null as T);`
`54`	`54`	`}`