chore: setup npm workspaces

.eslintrc.js

@@ -1,3 +1,13 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const fs = require('fs')
+const path = require('path')
+const fg = require('fast-glob')
+const { workspaces } = require('./package.json')
+
+const projectDirs = workspaces
+  .flatMap(pattern => fg.sync(pattern, { onlyDirectories: true }))
+  .filter(projectPath => fs.existsSync(path.join(__dirname, projectPath, 'package.json')))
+
 module.exports = {
   extends: [
     'airbnb-base',
@@ -43,6 +53,26 @@ module.exports = {
     commonjs: true,
     node: true,
   },
+  overrides: [
+    // https://github.com/import-js/eslint-plugin-import/issues/1913#issuecomment-1034025709
+    ...projectDirs.map(projectDir => ({
+      files: [`${projectDir}/**/*.{t,j}s`],
+      rules: {
+        'import/no-extraneous-dependencies': ['error', {
+          devDependencies: [
+            '.eslintrc.js',
+            '**/*.test.ts',
+            '**/*.spec.ts',
+            '__tests__/**/*.ts',
+            '*.config.ts',
+            'docs/.vitepress/config.ts',
+            '**/vite.config.ts',
+          ],
+          packageDir: [__dirname, path.join(__dirname, projectDir)],
+        }],
+      },
+    })),
+  ],
   rules: {
     /*
      * Typescript
@@ -100,11 +130,13 @@ module.exports = {
     }],
     'import/no-extraneous-dependencies': ['error', {
       devDependencies: [
+        '.eslintrc.js',
         '**/*.test.ts',
         '**/*.spec.ts',
         '__tests__/**/*.ts',
         '*.config.ts',
         'docs/.vitepress/config.ts',
+        'vite.config.ts',
       ],
     }],
     'arrow-parens': ['error', 'as-needed', {

.github/workflows/checks.yaml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x, 21.x]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -30,21 +30,13 @@ jobs:
         continue-on-error: true
         with:
           path: |
-            node_modules
-            examples/rxdb/node_modules
-            examples/firebase/node_modules
-            examples/appwrite/node_modules
-            examples/supabase/node_modules
+            **/node_modules
           key: ${{ runner.OS }}-modules-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.OS }}-modules-${{ matrix.node-version }}-
       - name: install modules
         run: |
           npm install --no-audit --force --loglevel=error --no-update-notifier
-          (cd examples/rxdb && npm install --no-audit --force --loglevel=error --no-update-notifier)
-          (cd examples/firebase && npm install --no-audit --force --loglevel=error --no-update-notifier)
-          (cd examples/appwrite && npm install --no-audit --force --loglevel=error --no-update-notifier)
-          (cd examples/supabase && npm install --no-audit --force --loglevel=error --no-update-notifier)
 
   linting:
     needs: preflight
@@ -62,14 +54,11 @@ jobs:
         with:
           fail-on-cache-miss: true
           path: |
-            node_modules
-            examples/rxdb/node_modules
-            examples/firebase/node_modules
-            examples/appwrite/node_modules
-            examples/supabase/node_modules
+            **/node_modules
           key: ${{ runner.OS }}-modules-20.x-${{ hashFiles('**/package-lock.json') }}
       - name: linting
         run: |
+          npm run build
           npm run lint
 
   typecheck:
@@ -88,22 +77,19 @@ jobs:
         with:
           fail-on-cache-miss: true
           path: |
-            node_modules
-            examples/rxdb/node_modules
-            examples/firebase/node_modules
-            examples/appwrite/node_modules
-            examples/supabase/node_modules
+            **/node_modules
           key: ${{ runner.OS }}-modules-20.x-${{ hashFiles('**/package-lock.json') }}
       - name: typecheck
         run: |
+          npm run build
           npm run type-check
 
   unit-tests:
     needs: preflight
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x, 21.x]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -117,14 +103,11 @@ jobs:
         with:
           fail-on-cache-miss: true
           path: |
-            node_modules
-            examples/rxdb/node_modules
-            examples/firebase/node_modules
-            examples/appwrite/node_modules
-            examples/supabase/node_modules
+            **/node_modules
           key: ${{ runner.OS }}-modules-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
       - name: unit testing
         run: |
+          npm run build
           npm test -- --coverage run
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v3
@@ -136,7 +119,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x, 21.x]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -150,11 +133,7 @@ jobs:
         with:
           fail-on-cache-miss: true
           path: |
-            node_modules
-            examples/rxdb/node_modules
-            examples/firebase/node_modules
-            examples/appwrite/node_modules
-            examples/supabase/node_modules
+            **/node_modules
           key: ${{ runner.OS }}-modules-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
       - name: build package
         run: |
@@ -176,11 +155,7 @@ jobs:
         with:
           fail-on-cache-miss: true
           path: |
-            node_modules
-            examples/rxdb/node_modules
-            examples/firebase/node_modules
-            examples/appwrite/node_modules
-            examples/supabase/node_modules
+            **/node_modules
           key: ${{ runner.OS }}-modules-20.x-${{ hashFiles('**/package-lock.json') }}
       - name: build docs
         run: |

.github/workflows/deploy-docs.yaml

@@ -35,21 +35,13 @@ jobs:
         continue-on-error: true
         with:
           path: |
-            node_modules
-            examples/rxdb/node_modules
-            examples/firebase/node_modules
-            examples/appwrite/node_modules
-            examples/supabase/node_modules
+            **/node_modules
           key: ${{ runner.OS }}-modules-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.OS }}-modules-
       - name: install modules
         run: |
           npm install --no-audit --force --loglevel=error --no-update-notifier
-          (cd examples/rxdb && npm install --no-audit --force --loglevel=error --no-update-notifier)
-          (cd examples/firebase && npm install --no-audit --force --loglevel=error --no-update-notifier)
-          (cd examples/appwrite && npm install --no-audit --force --loglevel=error --no-update-notifier)
-          (cd examples/supabase && npm install --no-audit --force --loglevel=error --no-update-notifier)
       - name: Build vitepress
         run: npm run docs:build
       - name: Upload artifact

__tests__/Collection.spec.ts

@@ -1,5 +1,5 @@
 import { vi, beforeEach, describe, it, expect } from 'vitest'
-import { Collection, createMemoryAdapter, createIndex } from '../src/index'
+import { Collection, createMemoryAdapter, createIndex } from 'signaldb'
 
 describe('Collection', () => {
   let collection: Collection<{ id: string, name: string }>

__tests__/Cursor.spec.ts

@@ -1,6 +1,6 @@
 import { vi, describe, it, expect } from 'vitest'
-import type { ObserveCallbacks, Transform } from '../src/index'
-import { Collection } from '../src/index'
+import type { ObserveCallbacks, Transform } from 'signaldb'
+import { Collection } from 'signaldb'
 
 // Helper function to wait for async operations
 const wait = () => new Promise((resolve) => { setImmediate(resolve) })

__tests__/PersistentCollection.client.spec.ts

@@ -1,7 +1,7 @@
 // @vitest-environment happy-dom
 import { describe, it, expect } from 'vitest'
-import { PersistentCollection } from '../src/index'
-import waitForEvent from '../src/utils/waitForEvent'
+import { PersistentCollection } from 'signaldb'
+import waitForEvent from './helpers/waitForEvent'
 
 describe('PersistentCollection', () => {
   it('should create a persistent collection on the clientside', async () => {

__tests__/PersistentCollection.spec.ts

@@ -1,7 +1,7 @@
 import fs from 'fs'
 import { describe, it, expect } from 'vitest'
-import { PersistentCollection } from '../src/index'
-import waitForEvent from '../src/utils/waitForEvent'
+import { PersistentCollection } from 'signaldb'
+import waitForEvent from './helpers/waitForEvent'
 
 describe('PersistentCollection', () => {
   it('should create a persistent collection on the serverside', async () => {

__tests__/Queries.spec.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest'
-import { Collection } from '../src/index'
+import { Collection } from 'signaldb'
 
 describe('Queries', () => {
   // thanks to https://github.com/meteor/meteor/blob/devel/packages/minimongo/minimongo_tests_client.js
@@ -17,7 +17,7 @@ describe('Queries', () => {
     expect(c.find({ type: 'cryptographer' }).count()).toBe(3)
     expect(c.find({ type: 'kitten' }).fetch().length).toBe(2)
     expect(c.find({ type: 'cryptographer' }).fetch().length).toBe(3)
-    expect(fluffyKittenId).toBe(c.findOne({ type: 'kitten', name: 'fluffy' }).id)
+    expect(fluffyKittenId).toBe(c.findOne({ type: 'kitten', name: 'fluffy' })?.id)
 
     c.removeMany({ name: 'cara' })
     expect(c.find().count()).toBe(4)
@@ -67,9 +67,9 @@ describe('Queries', () => {
     expect(c.find({ tags: 'fruit' }).fetch().length).toBe(2)
     expect(c.find({ tags: 'red' }).fetch().length).toBe(3)
 
-    expect(c.findOne({ id: 1 }).name).toBe('strawberry')
-    expect(c.findOne({ id: 2 }).name).toBe('apple')
-    expect(c.findOne({ id: 3 }).name).toBe('rose')
+    expect(c.findOne({ id: 1 })?.name).toBe('strawberry')
+    expect(c.findOne({ id: 2 })?.name).toBe('apple')
+    expect(c.findOne({ id: 3 })?.name).toBe('rose')
     expect(c.findOne({ id: 4 })).toBeUndefined()
     expect(c.findOne({ id: 'abc' })).toBeUndefined()
     expect(c.findOne({ id: undefined })).toBeUndefined()

__tests__/persistence.client.spec.ts

@@ -1,7 +1,7 @@
 // @vitest-environment happy-dom
 import { describe, it, expect } from 'vitest'
-import { Collection, createLocalStorageAdapter } from '../src/index'
-import waitForEvent from '../src/utils/waitForEvent'
+import { Collection, createLocalStorageAdapter } from 'signaldb'
+import waitForEvent from './helpers/waitForEvent'
 
 const persistence = createLocalStorageAdapter('test')
 

__tests__/persistence.spec.ts

@@ -1,8 +1,8 @@
 import fs from 'fs/promises'
 import { describe, it, expect, vi } from 'vitest'
-import type { PersistenceAdapter } from '../src/index'
-import { Collection, createFilesystemAdapter } from '../src/index'
-import waitForEvent from '../src/utils/waitForEvent'
+import type { PersistenceAdapter } from 'signaldb'
+import { Collection, createFilesystemAdapter } from 'signaldb'
+import waitForEvent from './helpers/waitForEvent'
 
 // eslint-disable-next-line max-len
 function memoryPersistenceAdapter<T extends { id: I } & Record<string, any>, I = any>(

__tests__/reactivity/maverick-js.spec.ts

@@ -7,7 +7,7 @@ import {
   getScope,
   onDispose,
 } from '@maverick-js/signals'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('@maverick-js/signals', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/mobx.spec.ts

@@ -5,7 +5,7 @@ import {
   runInAction,
   onBecomeUnobserved,
 } from 'mobx'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('MobX', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/oby.spec.ts

@@ -6,7 +6,7 @@ import $oby, {
   owner,
   tick,
 } from 'oby'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('oby', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/preact.spec.ts

@@ -1,6 +1,6 @@
 import { vi, describe, it, expect } from 'vitest'
 import { signal, effect } from '@preact/signals-core'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('preact', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/reactively.spec.ts

@@ -1,6 +1,6 @@
 import { vi, describe, it, expect } from 'vitest'
 import { reactive, onCleanup } from '@reactively/core'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('@reactively/core', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/s-js.spec.ts

@@ -1,6 +1,6 @@
 import { vi, describe, it, expect } from 'vitest'
 import S from 's-js'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('S.js', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/sinuous.spec.ts

@@ -3,7 +3,7 @@ import {
   observable,
   api,
 } from 'sinuous'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('sinuous', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/solid-js.spec.ts

@@ -5,8 +5,10 @@ import {
   createEffect,
   onCleanup,
   createRoot,
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
 } from 'solid-js/dist/solid'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('solid', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/tracker.spec.ts

@@ -1,6 +1,6 @@
 import { vi, describe, it, expect } from 'vitest'
 import { Tracker } from 'meteor-ts-tracker'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('Tracker', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/usignal.spec.ts

@@ -3,7 +3,7 @@ import {
   signal,
   effect,
 } from 'usignal'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('usignal', () => {
   const reactivity = createReactivityAdapter({

__tests__/reactivity/vue.spec.ts

@@ -8,7 +8,7 @@ import {
   nextTick as vueNextTick,
   effectScope as vueEffectScope,
 } from 'vue'
-import { Collection, createReactivityAdapter } from '../../src/index'
+import { Collection, createReactivityAdapter } from 'signaldb'
 
 describe('Vue.js', () => {
   const reactivity = createReactivityAdapter({