fix(store): integrate into shared (#28)

2nthony · Oct 10, 2021 · 7975e28 · 7975e28
1 parent 9029e20
commit 7975e28
Show file tree

Hide file tree

Showing 34 changed files with 64 additions and 219 deletions.
diff --git a/indexes.json b/indexes.json
@@ -10,24 +10,25 @@
       "display": "SvelteUse",
       "description": "Collection of essential Svelte Utilities",
       "dir": "packages/core"
-    },
-    "store": {
-      "name": "store",
-      "display": "Store",
-      "description": "Enhancement for svelte/store",
-      "dir": "packages/store"
     }
   },
   "categories": [
-    "@Store",
     "Animation",
     "Browser",
     "Component",
     "Sensors",
     "State",
+    "Store",
     "Utilities"
   ],
   "functions": [
+    {
+      "name": "readable",
+      "package": "shared",
+      "docs": "/shared/readable/",
+      "category": "Store",
+      "description": "auto unsubscribe on destory for `readable`"
+    },
     {
       "name": "tryOnDestroy",
       "package": "shared",
@@ -82,6 +83,13 @@
       "category": "Utilities",
       "description": "shorthand for watching value to be truthy"
     },
+    {
+      "name": "writable",
+      "package": "shared",
+      "docs": "/shared/writable/",
+      "category": "Store",
+      "description": "auto unsubscribe on destory for `writable`"
+    },
     {
       "name": "onClickOutside",
       "package": "core",
@@ -144,34 +152,6 @@
       "docs": "/core/useTitle/",
       "category": "Browser",
       "description": "reactive document title"
-    },
-    {
-      "name": "derived",
-      "package": "store",
-      "docs": "/store/derived/",
-      "category": "@Store",
-      "description": "origin [derived](https://svelte.dev/docs#derived)"
-    },
-    {
-      "name": "get",
-      "package": "store",
-      "docs": "/store/get/",
-      "category": "@Store",
-      "description": "origin [get](https://svelte.dev/docs#get)"
-    },
-    {
-      "name": "readable",
-      "package": "store",
-      "docs": "/store/readable/",
-      "category": "@Store",
-      "description": "auto unsubscribe on destory for `readable`"
-    },
-    {
-      "name": "writable",
-      "package": "store",
-      "docs": "/store/writable/",
-      "category": "@Store",
-      "description": "auto unsubscribe on destory for `writable`"
     }
   ]
 }
diff --git a/meta/packages.ts b/meta/packages.ts
@@ -10,10 +10,4 @@ export const packages: PackageManifest[] = [
     display: 'SvelteUse',
     description: 'Collection of essential Svelte Utilities',
   },
-  {
-    name: 'store',
-    display: 'Store',
-    description: 'Enhancement for svelte/store',
-  }
 ]
-
diff --git a/packages/.vitepress/config.js b/packages/.vitepress/config.js
@@ -8,6 +8,7 @@ const categoriesOrder = [
   'Sensors',
   'Animation',
   'State',
+  'Store',
   'Component',
   'Watch',
   'Formatters',

diff --git a/packages/core/indexes.json b/packages/core/indexes.json
@@ -10,24 +10,25 @@
       "display": "SvelteUse",
       "description": "Collection of essential Svelte Utilities",
       "dir": "packages/core"
-    },
-    "store": {
-      "name": "store",
-      "display": "Store",
-      "description": "Enhancement for svelte/store",
-      "dir": "packages/store"
     }
   },
   "categories": [
-    "@Store",
     "Animation",
     "Browser",
     "Component",
     "Sensors",
     "State",
+    "Store",
     "Utilities"
   ],
   "functions": [
+    {
+      "name": "readable",
+      "package": "shared",
+      "docs": "/shared/readable/",
+      "category": "Store",
+      "description": "auto unsubscribe on destory for `readable`"
+    },
     {
       "name": "tryOnDestroy",
       "package": "shared",
@@ -82,6 +83,13 @@
       "category": "Utilities",
       "description": "shorthand for watching value to be truthy"
     },
+    {
+      "name": "writable",
+      "package": "shared",
+      "docs": "/shared/writable/",
+      "category": "Store",
+      "description": "auto unsubscribe on destory for `writable`"
+    },
     {
       "name": "onClickOutside",
       "package": "core",
@@ -144,34 +152,6 @@
       "docs": "/core/useTitle/",
       "category": "Browser",
       "description": "reactive document title"
-    },
-    {
-      "name": "derived",
-      "package": "store",
-      "docs": "/store/derived/",
-      "category": "@Store",
-      "description": "origin [derived](https://svelte.dev/docs#derived)"
-    },
-    {
-      "name": "get",
-      "package": "store",
-      "docs": "/store/get/",
-      "category": "@Store",
-      "description": "origin [get](https://svelte.dev/docs#get)"
-    },
-    {
-      "name": "readable",
-      "package": "store",
-      "docs": "/store/readable/",
-      "category": "@Store",
-      "description": "auto unsubscribe on destory for `readable`"
-    },
-    {
-      "name": "writable",
-      "package": "store",
-      "docs": "/store/writable/",
-      "category": "@Store",
-      "description": "auto unsubscribe on destory for `writable`"
     }
   ]
 }
diff --git a/packages/core/onClickOutside/demo.svelte b/packages/core/onClickOutside/demo.svelte
@@ -1,6 +1,6 @@
 <script lang="ts">
-  import { writable } from '@svelte-use/store'
-  import { onClickOutside, onClickOutside } from '.'
+  import { writable } from '@svelte-use/shared'
+  import { onClickOutside } from '.'
 
   const modal = writable(false)
   const modalEl = writable<HTMLDivElement>()

diff --git a/packages/core/onClickOutside/index.md b/packages/core/onClickOutside/index.md
@@ -10,8 +10,7 @@ List for clicks outside of an element. Useful for modal or dropdown.
 
 ```js
 <script>
-  import { writable } from '@svelte-use/store'
-  import { onClickOutside } from '@svelte-use/core'
+  import { writable, onClickOutside } from '@svelte-use/core'
 
   const target = writable()
 

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -29,7 +29,6 @@
     "./*": "./*"
   },
   "dependencies": {
-    "@svelte-use/shared": "workspace:*",
-    "@svelte-use/store": "workspace:*"
+    "@svelte-use/shared": "workspace:*"
   }
 }
diff --git a/packages/core/useEventListener/index.md b/packages/core/useEventListener/index.md
@@ -22,8 +22,7 @@ You can also pass a `writable/readable` as the event target, `useEventListener`
 
 ```js
 <script>
-  import { writable } from '@svelte-use/store'
-  import { useEventListener } from '@svelte-use/core'
+  import { writable, useEventListener } from '@svelte-use/core'
 
   const el = writable()
   useEventListener(el, 'click', (evt) => {

diff --git a/packages/core/useMutationObserver/demo.svelte b/packages/core/useMutationObserver/demo.svelte
@@ -1,5 +1,5 @@
 <script lang="ts">
-  import { writable } from '@svelte-use/store'
+  import { writable } from '@svelte-use/shared'
   import { useMutationObserver } from '.'
 
   const el = writable<HTMLDivElement>()

diff --git a/packages/core/useMutationObserver/index.md b/packages/core/useMutationObserver/index.md
@@ -10,8 +10,7 @@ Watch for changes being made to the DOM tree. [MutationObserver MDN](https://dev
 
 ```js
 <script>
-  import { writable } from '@svelte-use/store'
-  import { useMutationObserver } from '@svelte-use/core'
+  import { writable, useMutationObserver } from '@svelte-use/core'
 
   const el = writable()
   let messages = []

diff --git a/packages/core/useTitle/index.ts b/packages/core/useTitle/index.ts
@@ -1,5 +1,5 @@
 import { isString, MaybeWritable, toWritable } from '@svelte-use/shared'
-import { get } from '@svelte-use/store'
+import { get } from 'svelte/store'
 import { useMutationObserver } from '../useMutationObserver'
 import { ConfigurableDocument, defaultDocument } from '../_configurable'
 

diff --git a/packages/functions.md b/packages/functions.md
@@ -31,6 +31,10 @@
   - [`useSessionStorage`](/core/useSessionStorage/) — reactive [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)
   - [`useStorage`](/core/useStorage/) — reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)/[SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)
 
+### Store
+  - [`readable`](/shared/readable/) — auto unsubscribe on destory for `readable`
+  - [`writable`](/shared/writable/) — auto unsubscribe on destory for `writable`
+
 ### Utilities
   - [`whenever`](/shared/whenever/) — shorthand for watching value to be truthy
 

diff --git a/packages/guide/index.md b/packages/guide/index.md
@@ -8,7 +8,7 @@ Svelte Use is a collection of utility functions.
 
 ```bash
 npm i @svelte-use/core
-# yarn add @svelte-use
+# yarn add @svelte-use/core
 # pnpm i @svelte-use/core
 ```
 

diff --git a/packages/shared/index.ts b/packages/shared/index.ts
@@ -1,3 +1,4 @@
+export * from './readable'
 export * from './tryOnDestroy'
 export * from './tryOnMount'
 export * from './useInterval'
@@ -6,3 +7,4 @@ export * from './useTimeout'
 export * from './useTimeoutFn'
 export * from './utils'
 export * from './whenever'
+export * from './writable'
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -27,8 +27,5 @@
       "require": "./index.cjs"
     },
     "./*": "./*"
-  },
-  "dependencies": {
-    "@svelte-use/store": "workspace:*"
   }
 }
diff --git a/packages/store/readable/index.md → packages/shared/readable/index.md b/packages/store/readable/index.md → packages/shared/readable/index.md
@@ -1,5 +1,5 @@
 ---
-category: '@Store'
+category: Store
 ---
 
 # readable
@@ -10,7 +10,7 @@ Auto unsubscribe on destory for `readable` .
 
 ```html
 <script>
-  import { readable } from '@svelte-use/store'
+  import { readable } from '@svelte-use/core'
 
   const count = readable(0)
 </script>

diff --git a/packages/store/readable/index.ts → packages/shared/readable/index.ts b/packages/store/readable/index.ts → packages/shared/readable/index.ts
@@ -1,8 +1,5 @@
-import { noop } from '@svelte-use/shared'
-import {
-  Readable,
-  StartStopNotifier,
-} from 'svelte/store'
+import { noop } from '../utils'
+import { Readable, StartStopNotifier } from 'svelte/store'
 import { writable } from '../writable'
 
 export function readable<T>(

diff --git a/packages/shared/useInterval/index.ts b/packages/shared/useInterval/index.ts
@@ -1,4 +1,4 @@
-import { writable } from '@svelte-use/store'
+import { writable } from '../writable'
 import { Writable } from 'svelte/store'
 import { useIntervalFn } from '../useIntervalFn'
 import { Pausable } from '../utils'

diff --git a/packages/shared/useIntervalFn/demo.svelte b/packages/shared/useIntervalFn/demo.svelte
@@ -1,5 +1,5 @@
 <script lang="ts">
-  import { writable } from '@svelte-use/store'
+  import { writable } from '../writable'
   import { useIntervalFn } from '.'
 
   const greetings = [

diff --git a/packages/shared/useIntervalFn/index.ts b/packages/shared/useIntervalFn/index.ts
@@ -1,5 +1,5 @@
-import { tryOnDestroy } from '@svelte-use/core'
-import { writable } from '@svelte-use/store'
+import { tryOnDestroy } from '../tryOnDestroy'
+import { writable } from '../writable'
 import { Fn, isClient, Pausable } from '../utils'
 
 export interface IntervalFnOptions {

diff --git a/packages/shared/useTimeout/index.ts b/packages/shared/useTimeout/index.ts
@@ -1,7 +1,7 @@
 import { Writable } from 'svelte/store'
 import { noop, Stopable } from '../utils'
 import { TimeoutFnOptions, useTimeoutFn } from '../useTimeoutFn'
-import { readable } from '@svelte-use/store'
+import { readable } from '../readable'
 
 export interface TimeoutOptions<Controls extends boolean>
   extends TimeoutFnOptions {

diff --git a/packages/shared/useTimeoutFn/index.ts b/packages/shared/useTimeoutFn/index.ts
@@ -1,5 +1,5 @@
 import { isClient, Stopable } from '../utils'
-import { writable } from '@svelte-use/store'
+import { writable } from '../writable'
 import { tryOnDestroy } from '../tryOnDestroy'
 
 export interface TimeoutFnOptions {

diff --git a/packages/shared/utils/index.ts b/packages/shared/utils/index.ts
@@ -1,5 +1,6 @@
 import { get_current_component } from 'svelte/internal'
-import { get, readable } from '@svelte-use/store'
+import { readable } from '../readable'
+import { get } from 'svelte/store'
 import { MaybeReadable, MaybeWritable } from './types'
 import { isReadable, isWritable } from './is'
 import { Readable, writable, Writable } from 'svelte/store'

diff --git a/packages/store/writable/index.md → packages/shared/writable/index.md b/packages/store/writable/index.md → packages/shared/writable/index.md
@@ -1,5 +1,5 @@
 ---
-category: '@Store'
+category: Store
 ---
 
 # writable
@@ -10,7 +10,7 @@ Auto unsubscribe on destory for `writable` .
 
 ```html
 <script>
-  import { writable } from '@svelte-use/store'
+  import { writable } from '@svelte-use/core'
 
   const count = writable(0)
 </script>

diff --git a/packages/store/writable/index.ts → packages/shared/writable/index.ts b/packages/store/writable/index.ts → packages/shared/writable/index.ts
@@ -1,4 +1,5 @@
-import { Fn, noop, runAll, tryOnDestroy } from '@svelte-use/shared'
+import { Fn, noop, runAll } from '../utils'
+import { tryOnDestroy } from '../tryOnDestroy'
 import {
   writable as _writable,
   get,