feat: implement default migration routine

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: Build and publish crudodb
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
 jobs:
   release:
     runs-on: ubuntu-latest

.prettierignore

@@ -1,6 +1,7 @@
 documentation/
 dist/
 node_modules/
+coverage/
 
 package-lock.json
 yarn.lock

.releaserc.json

@@ -3,9 +3,12 @@
   "plugins": [
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",
-    ["@semantic-release/npm", {
-      "pkgRoot": "dist/src"
-    }],
+    [
+      "@semantic-release/npm",
+      {
+        "pkgRoot": "dist/src"
+      }
+    ],
     "@semantic-release/github"
   ]
 }

README.md

@@ -48,46 +48,6 @@ There are 3 flags to mark an item in indexeddb for processing.
 + U
 + D
 
-
 ## Recommendations
 
-### Angular
-
-```typescript
-@Injectable({providedIn: 'root'})
-export class StoreAccessService {
-
-    public instance$ = fromPromise(CrudoDb.setup)
-        .pipe(shareReplay(1));
-
-}
-
-@Injectable({providedIn: 'root'})
-export class DaoService {
-
-    private key$ = this.storeAccess.instance$.pipe(
-        switchMap((instance) => instance.registerSchema({schema})),
-        shareReplay(1)
-    );
-
-    private handle$ = combineLatest([this.key$, this.storeAccess.instance$]).pipe(shareReplay(1));
-
-    constructor(private storeAccess: StoreAccessService) {}
-
-    public create(item: Dao): Observable<Dao> {
-        return this.handle$.pipe(
-            switchMap(([key, instance]) => instance.create(key, item))
-        );
-    }
-}
-
-```
-
-### React (Hooks API)
-
-```typescript jsx
-
-// TODO: write hook(context) for it
-
-
-```
+see [documentation](docs) for angular and react recommendations.

docs/angular.md

@@ -0,0 +1,43 @@
+# Angular (rxjs)
+
+recommendation for angular is to use shared root service, which setup the instance.
+
+all consuming services need a schemaKey. To work smooth with it, cache it in a property and optional combine it with the instance from root service.
+
+In all following usages, you have to pipe `handle$` to the matching method  
+
+```typescript
+import {Injectable} from '@angular/core';
+import {combineLatest, Observable} from "rxjs";
+import {map, shareReplay, switchMap, tap} from "rxjs/operators";
+import {fromPromise} from "rxjs/internal-compatibility";
+import {CrudoDb} from "crudodb";
+
+@Injectable({providedIn: 'root'})
+export class StoreAccessService {
+
+    public instance$ = fromPromise(CrudoDb.setup)
+        .pipe(shareReplay(1));
+
+}
+
+@Injectable({providedIn: 'root'})
+export class DaoService {
+
+    private key$ = this.storeAccess.instance$.pipe(
+        switchMap((instance) => instance.registerSchema({schema})),
+        shareReplay(1)
+    );
+
+    private handle$ = combineLatest([this.key$, this.storeAccess.instance$]).pipe(shareReplay(1));
+
+    constructor(private storeAccess: StoreAccessService) {}
+
+    public create(item: Dao): Observable<Dao> {
+        return this.handle$.pipe(
+            switchMap(([key, instance]) => instance.create(key, item))
+        );
+    }
+}
+
+```

docs/react.md

@@ -0,0 +1 @@
+React usage (hooks api)

jest.config.js

@@ -3,5 +3,6 @@
 
 module.exports = {
   preset: 'jest-preset-typescript',
-  setupFiles: ['fake-indexeddb/auto']
+  setupFiles: ['fake-indexeddb/auto'],
+  coveragePathIgnorePatterns: ['/node_modules/', '/spec/']
 };

package.json

@@ -10,8 +10,9 @@
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
     "format:prettier": "prettier --config .prettierrc --write",
-    "format:prettier:all": "yarn format:prettier \"**/*.+(js|jsx|json|yml|yaml|css|less|scss|ts|tsx|html)\"",
-    "semantic-release": "semantic-release"
+    "format:prettier:all": "yarn format:prettier \"**/*.+ts\"",
+    "semantic-release": "semantic-release",
+    "lint:es:fix": "yarn eslint --fix"
   },
   "repository": {
     "type": "git",
@@ -32,21 +33,37 @@
   "devDependencies": {
     "@types/jest": "^26.0.14",
     "@types/node": "^14.11.5",
+    "@typescript-eslint/eslint-plugin": "^4.6.0",
     "@typescript-eslint/parser": "^4.4.0",
     "babel-jest": "^26.5.2",
     "eslint": "^7.10.0",
     "eslint-config-prettier": "^6.10.0",
+    "eslint-plugin-ban": "^1.5.1",
     "eslint-plugin-import": "^2.20.1",
     "eslint-plugin-jest": "^24.1.0",
     "eslint-plugin-typescript": "^0.14.0",
+    "eslint-plugin-unused-imports": "^1.0.0",
     "fake-indexeddb": "^3.0.0",
+    "husky": "^4.3.0",
     "jest": "^26.5.2",
     "jest-preset-typescript": "^1.2.0",
+    "lint-staged": "^10.5.0",
     "prettier": "^2.1.2",
+    "semantic-release": "^17.2.1",
     "ts-jest": "^26.4.1",
     "tslint": "^6.0.0",
     "tslint-config-airbnb": "^5.11.2",
-    "typescript": "^4.0.3",
-    "semantic-release": "^17.2.1"
+    "typescript": "^4.0.3"
+  },
+  "lint-staged": {
+    "*.+(js|ts)": [
+      "yarn format:prettier",
+      "git add"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
   }
 }