@akb2/react-use-local-storage 1.0.0

package/tests/local-storage-listening.test.ts

@@ -0,0 +1,28 @@
+import { clearLocalStorage, useLocalStorageState } from "@source";
+import { cleanup, renderHook, waitFor } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+beforeEach(() => localStorage.clear());
+
+afterEach(() => {
+  cleanup();
+  clearLocalStorage();
+  vi.useRealTimers();
+});
+
+describe("LocalStorage direct changing", () => {
+  it("No support changes with direct localStorage modification", () => {
+    const { result } = renderHook(() => useLocalStorageState("initial"));
+
+    expect(result.current[0]).toBeUndefined();
+
+    localStorage.setItem(
+      "initial",
+      JSON.stringify({ value: "new value with direct modification" }),
+    );
+
+    return waitFor(() => expect(result.current[0]).toBe(undefined), {
+      timeout: 2000,
+    });
+  });
+});

package/tests/simple-change.test.ts

@@ -0,0 +1,40 @@
+import { clearLocalStorage, useLocalStorageState } from "@source";
+import { act, cleanup, renderHook } from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+beforeEach(() => localStorage.clear());
+
+afterEach(() => {
+  cleanup();
+  clearLocalStorage();
+  vi.useRealTimers();
+});
+
+describe("A simple value changing", () => {
+  it("No changing a value", () => {
+    const { result } = renderHook(() => useLocalStorageState("initial"));
+
+    expect(result.current[0]).toBeUndefined();
+  });
+
+  it("Changing a value", () => {
+    const { result } = renderHook(() => useLocalStorageState("initial"));
+
+    expect(result.current[0]).toBeUndefined();
+    act(() => result.current[1]("new value"));
+    expect(result.current[0]).toBe("new value");
+  });
+
+  it("Change a value with timeout", () => {
+    vi.useFakeTimers();
+
+    const { result } = renderHook(() => useLocalStorageState("initial"));
+
+    expect(result.current[0]).toBeUndefined();
+    setTimeout(() => result.current[1]("new value with timeout"), 100);
+    act(() => vi.advanceTimersByTime(99));
+    expect(result.current[0]).toBeUndefined();
+    act(() => vi.advanceTimersByTime(1));
+    expect(result.current[0]).toBe("new value with timeout");
+  });
+});

package/tests/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../tsconfig.test.json"
+}

package/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "declaration": true,
+    "strict": true,
+    "moduleResolution": "Bundler",
+    "skipLibCheck": true,
+    "outDir": ".dist",
+    "rootDir": ".",
+    "esModuleInterop": true,
+    "jsx": "react-jsx",
+    "jsxImportSource": "preact",
+    "types": [
+      "react",
+      "react-dom"
+    ],
+    "paths": {
+      "@hooks/*": [
+        "./src/hooks/*"
+      ],
+      "@utils/*": [
+        "./src/utils/*"
+      ],
+      "@types/*": [
+        "./src/types/*"
+      ]
+    }
+  },
+  "include": [
+    "src"
+  ]
+}

package/tsconfig.test.json

@@ -0,0 +1,31 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "declaration": false,
+    "rootDir": ".",
+    "lib": [
+      "ES2020",
+      "DOM",
+      "DOM.Iterable"
+    ],
+    "types": [
+      "node",
+      "vitest/globals"
+    ],
+    "paths": {
+      "@source": [
+        "./src/index.ts"
+      ]
+    }
+  },
+  "include": [
+    "tests/**/*.ts",
+    "tests/**/*.tsx",
+    "vitest.config.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    ".dist"
+  ]
+}

package/vitest.config.ts

@@ -0,0 +1,19 @@
+import { fileURLToPath } from "node:url";
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    environment: "jsdom",
+    environmentOptions: {
+      jsdom: {
+        url: "http://localhost/",
+      },
+    },
+    alias: {
+      "@source": fileURLToPath(new URL("./src/index.ts", import.meta.url)),
+      "@utils": fileURLToPath(new URL("./src/utils", import.meta.url)),
+      "@types": fileURLToPath(new URL("./src/types", import.meta.url)),
+      "@hooks": fileURLToPath(new URL("./src/hooks", import.meta.url)),
+    },
+  },
+});