Merge pull request #46 from Ashish-simpleCoder/feature/develop-hooks

release minor version

.changeset/beige-ladybugs-camp.md

@@ -0,0 +1,10 @@
+---
+'classic-react-hooks': minor
+---
+
+Docs and some refactor for logic
+
+- [c1db97d] docs: remove doc template files
+- [d3cdff6] feat: create new copy-to-clipboard function in use-copy-to-clipboard
+- [44179bd] test: add test case to handle defaultValue in catch block in use-local-storage
+- [d8d5b41] fix: parse logic in use-local-storage

.github/workflows/main.yml

@@ -20,9 +20,9 @@ jobs:
            with:
               node-version: ${{ matrix.node }}
 
-         - uses: pnpm/action-setup@v2
-           with:
-              version: 8
+         - uses: pnpm/action-setup@v4
+         #   with:
+         #      version: 8
          - uses: actions/setup-node@v3
            with:
               node-version: 16.x

.github/workflows/publish.yml

@@ -17,9 +17,9 @@ jobs:
       permissions: write-all
       steps:
          - uses: actions/checkout@v3
-         - uses: pnpm/action-setup@v2
-           with:
-              version: 8
+         - uses: pnpm/action-setup@v4
+         #   with:
+         #      version: 8
          - uses: actions/setup-node@v3
            with:
               node-version: ${{ matrix.node }}

.github/workflows/size.yml

@@ -7,9 +7,9 @@ jobs:
          CI_JOB_NUMBER: 1
       steps:
          - uses: actions/checkout@v3
-         - uses: pnpm/action-setup@v2
-           with:
-              version: 8
+         - uses: pnpm/action-setup@v4
+         #   with:
+         #      version: 8
          - uses: andresz1/size-limit-action@v1
            with:
               github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -7,8 +7,8 @@ jobs:
          CI_JOB_NUMBER: 1
       steps:
          - uses: actions/checkout@v3
-         - uses: pnpm/action-setup@v2
-           with:
-              version: 8
+         - uses: pnpm/action-setup@v4
+         #   with:
+         #      version: 8
          - run: pnpm install --no-frozen-lockfile
          - run: pnpm build && pnpm test

apps/doc/hooks/use-counter.md

@@ -8,9 +8,10 @@ outline: deep
 
 ### Parameters
 
-| Parameter |  Type  | Required | Default Value | Description                                                                 |
-| --------- | :----: | :------: | :-----------: | --------------------------------------------------------------------------- |
-| key       | string |    ❌    |      ""       | Based on the key, it generates `type-safe` object with `prefixed` proprety. |
+| Parameter    |  Type  | Required | Default Value | Description                                                                 |
+| ------------ | :----: | :------: | :-----------: | --------------------------------------------------------------------------- |
+| key          | string |    ❌    |      ""       | Based on the key, it generates `type-safe` object with `prefixed` proprety. |
+| initialValue | number |    ❌    |       0       | Initial value of the counter.                                               |
 
 ### Returns
 

src/index.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react'
 
 export { useEventListener as useEventListener } from './lib/use-event-listener'
-export { default as useCopyToClipboard } from './lib/use-copy-to-clipboard'
+export { default as useCopyToClipboard, copyToClipboardFn } from './lib/use-copy-to-clipboard'
 export { default as useLocalStorage } from './lib/use-local-storage'
 export { default as useOutsideClick } from './lib/use-outside-click'
 export { default as useDebouncedFn, debouncedFnWrapper } from './lib/use-debounced-fn'

src/lib/use-copy-to-clipboard/index.tsx

@@ -17,22 +17,26 @@ export default function useCopyToClipboard(props?: { onSuccess?: OnSuccess; onEr
    const propsRef = useSyncedRef(props)
 
    const copyToClipboard = useRef(async (data: string, onSuccess?: OnSuccess, onError?: OnError) => {
-      try {
-         if (navigator.clipboard) {
-            navigator.clipboard
-               .writeText(data)
-               .then(() => (onSuccess || propsRef.current?.onSuccess)?.())
-               .catch((error) => (onError || propsRef.current?.onError)?.(error))
-         } else {
-            const error: Partial<Error> = {
-               message: 'Cliboard not available',
-            }
-            ;(onError || propsRef.current?.onError)?.(error as Error)
-         }
-      } catch (error) {
-         ;(onError || propsRef.current?.onError)?.(error as Error)
-      }
+      copyToClipboardFn(data, onSuccess || propsRef.current?.onSuccess, onError || propsRef.current?.onError)
    })
 
    return copyToClipboard.current
 }
+
+export async function copyToClipboardFn(data: string, onSuccess?: OnSuccess, onError?: OnError) {
+   try {
+      if (navigator.clipboard) {
+         navigator.clipboard
+            .writeText(data)
+            .then(() => onSuccess?.())
+            .catch((error) => onError?.(error))
+      } else {
+         const error: Partial<Error> = {
+            message: 'Cliboard not available',
+         }
+         onError?.(error as Error)
+      }
+   } catch (error) {
+      onError?.(error as Error)
+   }
+}

src/lib/use-local-storage/index.test.tsx

@@ -13,6 +13,18 @@ describe('use-local-storage', () => {
       expect(typeof result.current[1]).toBe('function')
    })
 
+   it('should be able handle error when item is undefined in local-storage', () => {
+      localStorage.setItem('key', '') // when getting localStorage.getItem(key) => '', it results into undefined
+      const { result } = renderHook(() => useLocalStorage('key'))
+      expect(result.current[0]).toBeUndefined()
+   })
+
+   it('should be able handle error when with default value param', () => {
+      localStorage.setItem('key', '')
+      const { result } = renderHook(() => useLocalStorage('key', {}))
+      expect(result.current[0]).toStrictEqual({})
+   })
+
    it('should set the default value', () => {
       const { result } = renderHook(() => useLocalStorage('user', { name: 'Saitama' }))
 

src/lib/use-local-storage/index.tsx

@@ -20,7 +20,7 @@ export default function useLocalStorage<State>(key: string, defaultValue?: State
          if (defaultValue && item == null) {
             return defaultValue
          }
-         const parsed_value = item == null ? '' : JSON.parse(item ?? '')
+         const parsed_value = item == null ? '' : JSON.parse(item)
          return parsed_value
       } catch (err) {
          if (defaultValue) {