nedb-async - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

package.json

 {
   "name": "nedb-async",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Promise wrapper for Nedb that makes it possible to use all Nedb all cursor modifiers.",
@@ -9,5 +9,17 @@ "repository": {
   },
-  "main": "./dist/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
   "scripts": {
-    "build": "tsc -p ./tsconfig.json"
+    "build": "tsc -p tsconfig.json",
+    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "lint": "tslint -p tsconfig.json",
+    "prepare": "yarn build",
+    "prepublishOnly": "yarn test && yarn lint",
+    "preversion": "yarn lint",
+    "test": "jest --config jestconfig.json",
+    "version": "yarn format && git add -A src",
+    "postversion": "git push && git push --tags"
   },
@@ -25,10 +37,21 @@ "keywords": [
   ],
-  "author": "Akuma Isaac Akuma",
+  "author": {
+    "name": "Akuma Isaac Akuma",
+    "email": "[e-mail]"
+  },
   "license": "MIT",
   "dependencies": {
-    "nestdb": "2.0.0"
+    "nedb": "^1.8.0"
   },
   "devDependencies": {
-    "@types/nedb": "^1.8.8"
+    "@types/jest": "^24.0.23",
+    "@types/nedb": "^1.8.8",
+    "jest": "^24.9.0",
+    "lodash": "^4.17.15",
+    "prettier": "^1.19.1",
+    "ts-jest": "^24.1.0",
+    "tslint": "^5.20.1",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^3.7.2"
   }
 }

README.md

 # Nedb-Async
 
-**nedb-async is a simply promise base wrapper methods for <a href="https://github.com/louischatriot/nedb">Nedb</a>**
+**nedb-async is a simply promise base wrapper methods for 
+[Nedb](https://github.com/louischatriot/nedb)**
 
@@ -19,3 +20,3 @@ ## Installation
 `find, findOne and count`
-methods has to be pass as the last argument in an array.
+methods have to be passed as the last argument in an array.
 
@@ -56,5 +57,5 @@ ---
 ```js
-const DB = require('nedb-async')
+const { AsyncNedb } = require('nedb-async')
 
-const data = new Nedb({
+const data = new AsyncNedb({
   filename: 'data.db',
@@ -67,6 +68,6 @@ autoload: true,
 
-For typescript users conceder using this approach for better types support
+For typescript users consider using this approach for better types support
 
 ```ts
-import Nedb from 'nedb-async'
+import AsyncNedb from 'nedb-async'
 
@@ -85,4 +86,32 @@ interface IUser {
 
+## Development
+After you've cloned this repo, there are some built-in commands to aid in development:
+
+**Build the package** -  outputs built files to `./dist/`. These are the ones that will ultimately end up in the pacakage.
+```bash
+npm run-script build
+```
+or
+```bash
+yarn build
+```
+**Linter** - runs standard lint checks to keep code clean.
+```bash
+npm run-script lint
+```
+or
+```bash
+yarn lint
+```
+**Formatter** - formats the code **in place** for consistency.
+```bash
+npm run-script format
+```
+or
+```bash
+yarn format
+```
+
 ## Licence
 
 MIT

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

114

increased by34.12%

Worsened metrics

Total package byte prevSize

9683

decreased by-47.81%

Dev dependency count

9

increased by800%

Number of package files

7

decreased by-12.5%

Lines of code

146

decreased by-58.99%

Dependency changes

• + Addednedb@^1.8.0

• + Addedasync@0.2.10(transitive)

• + Addedbinary-search-tree@0.2.5(transitive)

• + Addednedb@1.8.0(transitive)

• - Removednestdb@2.0.0

• - Removedasync@1.5.2(transitive)

• - Removedbinary-search-tree@0.2.6(transitive)

• - Removednestdb@2.0.0(transitive)