vis-uuid - npm Package Compare versions

Comparing version 1.0.2 to 1.1.1

package.json

 {
-  "name": "vis-uuid",
-  "version": "1.0.2",
-  "description": "",
-  "main": "lib/uuid.js",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/visjs/vis-uuid.git"
-  },
-  "author": "Alex de Mulder <[e-mail]>",
-  "contributors": [
-    "jos <[e-mail]>",
-    "macleodbroad-wf <[e-mail]>",
-    "mojoaxel <[e-mail]>"
-  ],
-  "scripts": {
-    "test": "mocha"
-  },
-  "engines": {
-    "node": ">=8"
-  },
-  "keywords": [
-    "uuid",
-    "vis",
-    "vis.js"
-  ],
-  "license": "(Apache-2.0 OR MIT)",
-  "bugs": {
-    "url": "https://github.com/visjs/vis-uuid/issues"
-  },
-  "homepage": "https://github.com/visjs/vis-uuid#README.md",
-  "dependencies": {},
-  "devDependencies": {
-    "assert": "^2.0.0",
-    "mocha": "^6.1.4"
-  }
+    "name": "vis-uuid",
+    "version": "1.1.1",
+    "description": "UUIDv1 and UUIDv4 generator.",
+    "main": "dist/umd.js",
+    "module": "dist/esm.js",
+    "types": "dist/types/index.d.ts",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/visjs/vis-uuid.git"
+    },
+    "author": "Alex de Mulder <[e-mail]>",
+    "contributors": [
+        "jos <[e-mail]>",
+        "macleodbroad-wf <[e-mail]>",
+        "mojoaxel <[e-mail]>",
+        "Thomaash <[e-mail]>"
+    ],
+    "scripts": {
+        "build": "npm run build:types && npm run build:code && npm run build:docs",
+        "build:code": "rollup -c rollup.prod.config.js",
+        "build:docs": "typedoc ./src",
+        "build:types": "tsc -p tsconfig.types.json",
+        "clean": "rimraf '{docs,dist}/*'",
+        "fix": "npm run lint -- --fix",
+        "lint": "eslint '{src,test}/**/*.{m,}{j,t}s{x,}'",
+        "test": "BABEL_ENV=test mocha -r ./babel.mocha.js 'test/**/*.test.{j,t}s'",
+        "type-check": "tsc --noemit"
+    },
+    "engines": {
+        "node": ">=8"
+    },
+    "keywords": [
+        "uuid",
+        "vis",
+        "vis.js"
+    ],
+    "license": "(Apache-2.0 OR MIT)",
+    "bugs": {
+        "url": "https://github.com/visjs/vis-uuid/issues"
+    },
+    "homepage": "https://github.com/visjs/vis-uuid#README.md",
+    "files": [
+        "dist",
+        "LICENSE*"
+    ],
+    "dependencies": {},
+    "devDependencies": {
+        "@babel/core": "^7.5.0",
+        "@babel/preset-env": "^7.5.0",
+        "@babel/preset-typescript": "^7.3.3",
+        "@babel/register": "^7.4.4",
+        "@types/chai": "^4.1.7",
+        "@types/mocha": "^5.2.7",
+        "@types/node": "^12.0.12",
+        "assert": "^2.0.0",
+        "chai": "^4.2.0",
+        "mocha": "^6.1.4",
+        "rimraf": "^2.6.3",
+        "rollup": "^1.16.6",
+        "rollup-plugin-babel": "^4.3.3",
+        "rollup-plugin-node-resolve": "^5.2.0",
+        "typedoc": "^0.14.2",
+        "typescript": "^3.5.2"
+    }
 }

README.md

@@ -1,8 +0,59 @@
-# vis-uuid
+# Vis UUID
 
-This module is part of the [visjs project](https://github.com/visjs)
+UUID (version 1 and 4) generation library.
+Also offers conversion methods between string representation and binary (array of numbers or Uint8Array) representation.
+Comes in UMD version for good compatibility and ESM version ready for treeshaking.
 
-## Sources
+This module is a part of the [visjs project](https://github.com/visjs).
 
+## Documentation
+
+<https://visjs.github.io/vis-uuid/>
+
+## Building the project
+
+Clone the project:
+```
+git clone https://github.com/visjs/vis-uuid.git
+```
+
+Install dependencies:
+```
+npm i
+```
+
+Build the project (builds types, code and docs):
+```
+npm run build
+```
+
+### Building individual parts
+
+- Code: ```npm run build:code```
+- Docs: ```npm run build:docs```
+- Types: ```npm run build:types```
+
+### Other scripts
+
+- Clean built files: ```npm run clean```
+- Lint: ```npm run lint```
+- Reformat: ```npm run fix```
+- Test: ```npm run build```
+- Type check: ```npm run type-check```
+
+## License
+
+This project is dual licensed under
+
+The Apache 2.0 License http://www.apache.org/licenses/LICENSE-2.0
+
+and
+
+The MIT License http://opensource.org/licenses/MIT
+
+Vis UUID may be distributed under either license.
+
+## Original sources
+
 - https://github.com/almende/vis/blob/master/lib/module/uuid.js
-- https://github.com/almende/vis/blob/master/test/util.test.js
+- https://github.com/almende/vis/blob/master/test/util.test.js

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

37505

increased by384.62%

Number of package files

18

increased by350%

Lines of code

517

increased by175%

Number of lines in readme file

60

increased by650%

Worsened metrics

Dev dependency count

16

increased by700%

Number of low license alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes