move demo to docs

DevAnsar · Jan 4, 2024 · dea1458 · dea1458
1 parent acc0b06
commit dea1458
Show file tree

Hide file tree

Showing 21 changed files with 11 additions and 6 deletions.
diff --git a/demo/.eslintrc.cjs → docs/.eslintrc.cjs b/demo/.eslintrc.cjs → docs/.eslintrc.cjs
diff --git a/demo/.gitignore → docs/.gitignore b/demo/.gitignore → docs/.gitignore
diff --git a/demo/README.md → docs/README.md b/demo/README.md → docs/README.md
diff --git a/demo/index.html → docs/index.html b/demo/index.html → docs/index.html
diff --git a/demo/package.json → docs/package.json b/demo/package.json → docs/package.json
@@ -3,6 +3,7 @@
   "private": true,
   "version": "0.0.0",
   "type": "module",
+  "homepage": "https://devansar.github.io/react-search-hook",
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",

diff --git a/demo/postcss.config.js → docs/postcss.config.js b/demo/postcss.config.js → docs/postcss.config.js
diff --git a/demo/public/vite.svg → docs/public/vite.svg b/demo/public/vite.svg → docs/public/vite.svg
diff --git a/demo/src/App.tsx → docs/src/App.tsx b/demo/src/App.tsx → docs/src/App.tsx
diff --git a/demo/src/assets/react.svg → docs/src/assets/react.svg b/demo/src/assets/react.svg → docs/src/assets/react.svg
diff --git a/demo/src/components/Heade.tsx → docs/src/components/Heade.tsx b/demo/src/components/Heade.tsx → docs/src/components/Heade.tsx
diff --git a/demo/src/index.css → docs/src/index.css b/demo/src/index.css → docs/src/index.css
diff --git a/demo/src/main.tsx → docs/src/main.tsx b/demo/src/main.tsx → docs/src/main.tsx
diff --git a/demo/src/vite-env.d.ts → docs/src/vite-env.d.ts b/demo/src/vite-env.d.ts → docs/src/vite-env.d.ts
diff --git a/demo/tailwind.config.js → docs/tailwind.config.js b/demo/tailwind.config.js → docs/tailwind.config.js
diff --git a/demo/tsconfig.json → docs/tsconfig.json b/demo/tsconfig.json → docs/tsconfig.json
diff --git a/demo/tsconfig.node.json → docs/tsconfig.node.json b/demo/tsconfig.node.json → docs/tsconfig.node.json
diff --git a/demo/vite.config.ts → docs/vite.config.ts b/demo/vite.config.ts → docs/vite.config.ts
diff --git a/demo/yarn.lock → docs/yarn.lock b/demo/yarn.lock → docs/yarn.lock
diff --git a/src/__tests__/hook/useSearch.test.tsx b/src/__tests__/hook/useSearch.test.tsx
@@ -5,6 +5,7 @@ import SearchProvider from '../../SearchProvider'
 import SearchContext from '../../SearchContext'
 import { act } from 'react-dom/test-utils'
 import { SearchContextType, UseSearchOptions } from '../../types'
+import { invalidStoreNameError } from '../../utils/errors'
 
 describe('useSearch', () => {
   it('should thrown an error if the SearchContext is not available', () => {
@@ -20,7 +21,7 @@ describe('useSearch', () => {
       <SearchContext.Provider value={fakeSearchState}>{children}</SearchContext.Provider>
     )
 
-    expect(() => renderHook(() => useSearch('product'), { wrapper })).toThrow(Error(`Invalid store name: product`))
+    expect(() => renderHook(() => useSearch('product'), { wrapper })).toThrow(invalidStoreNameError('product'))
   })
 
   it('should get search value from context with useSearch successfully', () => {

diff --git a/src/hooks/useSearch.ts b/src/hooks/useSearch.ts
@@ -22,6 +22,7 @@ import * as React from 'react'
 import SearchContext from '../SearchContext'
 import { getfilterItems } from '../utils/filter'
 import { UseSearchOptions, UseSearchResponse } from '../types'
+import { invalidStoreNameError } from '../utils/errors'
 
 /**
  * @function
@@ -43,11 +44,7 @@ const useSearch = <TItem extends any>(
 
   // Check if the provided store is allowed
   if (context.stores && context.stores[storeName] === undefined) {
-    throw new Error(`
-    Invalid store name: ${storeName}
-    Make sure you have defined the ${storeName} store for the SearchProvider
-    For more information, please refer to: https://github.com/DevAnsar/react-search-hook?tab=readme-ov-file#2-add-provider-to-top-of-your-component-tree
-  `)
+    throw invalidStoreNameError(storeName)
   }
 
   /**

diff --git a/src/utils/errors.ts b/src/utils/errors.ts
@@ -0,0 +1,6 @@
+export const invalidStoreNameError = (storeName: string) =>
+  Error(`
+    Invalid store name: ${storeName}
+    Make sure you have defined the ${storeName} store for the SearchProvider
+    For more information, please refer to: https://github.com/DevAnsar/react-search-hook?tab=readme-ov-file#2-add-provider-to-top-of-your-component-tree
+  `)