@zodash/doreamon - npm Package Compare versions

Comparing version 0.4.66 to 1.0.0

package.json

 {
   "name": "@zodash/doreamon",
-  "version": "0.4.66",
-  "description": "utils like a doreamon",
+  "version": "1.0.0",
+  "description": "Zero's Standard Lib，like doreamon box",
+  "main": "lib/index.js",
+  "repository": "https://github.com/zcorky/doreamon",
+  "homepage": "https://github.com/zcorky/doreamon",
+  "bugs": {
+    "url": "https://github.com/zcorky/doreamon/issues"
+  },
   "keywords": [
+    "zcorky",
     "zodash",
-    "compress",
-    "image"
+    "utils",
+    "doreamon"
   ],
-  "author": "zero <[e-mail]>",
-  "homepage": "https://github.com/zcorky/zodash#readme",
+  "author": "Zero <[e-mail]> (https://moeover.com)",
   "license": "MIT",
-  "main": "lib/index.js",
-  "directories": {
-    "lib": "lib"
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "test": "jest -w 1",
+    "fmt": "eslint src/**/*.{ts,tsx} --fix && prettier --write src/**/{*.ts,*.tsx}",
+    "commit": "cz",
+    "clean": "rimraf -rf lib",
+    "coverage": "codecov",
+    "prepare": "husky install"
   },
+  "devDependencies": {
+    "@commitlint/cli": "^12.1.4",
+    "@commitlint/config-conventional": "^12.1.4",
+    "@types/jest": "^26.0.24",
+    "@types/node": "^16.3.3",
+    "@typescript-eslint/eslint-plugin": "^4.28.3",
+    "@typescript-eslint/parser": "^4.28.3",
+    "@zcorky/tsconfig": "^0.0.3",
+    "codecov": "^3.8.2",
+    "commitizen": "^4.2.4",
+    "cross-env": "^5.2.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "dayjs": "^1.7.8",
+    "eslint": "^7.31.0",
+    "eslint-config-airbnb": "^18.2.1",
+    "husky": "^7.0.1",
+    "jest": "^27.0.6",
+    "lint-staged": "^11.0.1",
+    "prettier": "^2.3.2",
+    "rimraf": "^2.6.2",
+    "ts-jest": "^27.0.3",
+    "ts-node": "^10.1.0",
+    "typescript": "^4.3.5"
+  },
   "files": [
-    "lib"
+    "lib/"
   ],
   "jest": {
     "roots": [
-      "__tests__"
+      "test"
     ],
@@ -27,3 +62,3 @@ "transform": {
     },
-    "testRegex": ".*\\.(spec|test)\\.(ts|tsx)$",
+    "testRegex": "test/.*\\.spec\\.(ts|tsx)$",
     "moduleDirectories": [
@@ -46,5 +81,5 @@ "node_modules",
       "global": {
-        "branches": 50,
-        "functions": 50,
-        "lines": 50,
+        "branches": 80,
+        "functions": 90,
+        "lines": 90,
         "statements": -10
@@ -54,19 +89,20 @@ }
   },
+  "lint-staged": {
+    "**/*.ts": [
+      "echo 'lint stage run'",
+      "eslint --fix",
+      "prettier --write --ignore-unknown"
+    ],
+    "*.{json.css,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/zcorky/zodash.git"
-  },
-  "scripts": {
-    "build": "yarn clean && tsc",
-    "watch": "yarn clean && tsc -w",
-    "clean": "rm -rf lib",
-    "test": "jest -w 1",
-    "coverage": "codecov"
-  },
-  "bugs": {
-    "url": "https://github.com/zcorky/zodash/issues"
-  },
   "dependencies": {
@@ -107,4 +143,3 @@ "@zcorky/deep-copy": "^0.0.2",
     "@zodash/uuid": "^0.1.7"
-  },
-  "gitHead": "6c6ee778088d74734067500ec14ad046ce906eda"
+  }
 }

README.md

@@ -1,9 +0,49 @@
-# `@zodash/doreamon`
+# Doreamon - Zero's Standard Lib
 
-> TODO: description
+[![Coverage Status](https://codecov.io/gh/zcorky/doreamon/branch/master/graph/badge.svg)](https://codecov.io/gh/zcorky/doreamon)
+[![Build Status](https://github.com/zcorky/doreamon/workflows/Publish%20NPM%20Package/badge.svg)](https://github.com/zcorky/doreamon)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@zodash/doreamon/badge.svg?style=flat-square)](https://snyk.io/test/npm/@zodash/doreamon)
+[![NPM download](https://img.shields.io/npm/dm/@zodash/doreamon.svg?style=flat-square)](https://www.npmjs.com/package/@zodash/doreamon)
+![license](https://img.shields.io/github/license/zcorky/doreamon.svg)
+[![issues](https://img.shields.io/github/issues/zcorky/doreamon.svg)](https://github.com/zcorky/doreamon/issues)
+![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
 
+![](https://socialify.git.ci/zcorky/doreamon/image?description=1&issues=1&language=1&owner=1&pattern=Floating%20Cogs&stargazers=1&theme=Dark)
+
+> [Doreamon](https://github.com/zcorky/doreamon) is a utility library that focus on getting daily works done. Inspired by lodash, underscore, google closure lib, but not only utils, it is a doreamon for developer.
+
+## Features
+
+Installing one library brings you tons of useful utilities:
+
+- Standard your is
+- Standard your log with Logger
+- Standard your cookie with Cookie
+- Standard your date with Moment
+- Standard your string,array,object,func with it
+- Standard your EventBus / EventEmitter
+- Standard your Device
+- Standard your Storage
+- ...
+
+## Install
+
+```
+$ yarn add @zodash/doreamon
+```
+
 ## Usage
 
+```js
+import { uuid } from '@zodash/doreamon';
+
+console.log(uuid()); // -> 0e3b84af-f911-4a55-b78a-cedf6f0bd815
 ```
-import doreamon from '@zodash/doreamon';
-```
+
+## Contribution
+
+Read [Contributing Guide](.github/CONTRIBUTING.md) for development setup instructions.
+
+## License
+
+MIT@[whatwewant](https://github.com/whatwewant)

New alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

50

increased by400%

Worsened metrics

Total package byte prevSize

25676

decreased by-31.42%

Dev dependency count

22

increased byInfinity%

Number of package files

93

decreased by-1.06%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes