mscgenjs - npm Package Compare versions

Comparing version 3.0.0-beta-1 to 3.0.0-beta-2

package.json

 {
   "name": "mscgenjs",
-  "version": "3.0.0-beta-1",
+  "version": "3.0.0-beta-2",
   "description": "Sequence chart rendering library",
-  "main": "dist/index.js",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es2015/index.js",
+  "sideEffects": false,
   "files": [
@@ -21,10 +23,10 @@ "dist/",
   "devDependencies": {
-    "@types/node": "10.9.4",
-    "chai": "4.1.2",
+    "@types/node": "10.11.7",
+    "chai": "4.2.0",
     "chai-xml": "0.3.2",
-    "dependency-cruiser": "4.5.0",
-    "jest": "23.5.0",
+    "dependency-cruiser": "4.6.1",
+    "jest": "23.6.0",
     "jest-json-schema": "2.0.1",
-    "js-makedepend": "3.0.3",
-    "jsdom": "12.0.0",
+    "js-makedepend": "3.0.4",
+    "jsdom": "12.2.0",
     "npm-run-all": "4.1.3",
@@ -35,18 +37,24 @@ "pegjs": "0.10.0",
     "ts-jest": "23.1.4",
-    "ts-loader": "5.0.0",
+    "ts-loader": "5.2.1",
     "tslint": "5.11.0",
-    "typescript": "3.0.3",
-    "upem": "1.0.0",
-    "webpack": "4.17.2",
-    "webpack-cli": "3.1.0"
+    "typescript": "3.1.3",
+    "upem": "1.0.1",
+    "webpack": "4.20.2",
+    "webpack-cli": "3.1.2"
   },
+  "upem": {
+    "donotup": [
+      "ts-jest"
+    ]
+  },
   "scripts": {
-    "build": "npm-run-all build:clean build:compile:pegjs build:csstemplates build:copy build:compile:typescript build:bundle",
+    "build": "npm-run-all build:clean build:prereq --parallel build:es2015 build:cjs build:bundle",
+    "build:prereq": "npm-run-all --parallel build:csstemplates build:compile:pegjs build:extractversion",
+    "build:es2015": "npm-run-all build:es2015:clean build:es2015:copy build:es2015:compile:typescript",
+    "build:cjs": "npm-run-all build:cjs:clean build:cjs:copy build:cjs:compile:typescript",
     "build:bundle": "webpack",
-    "build:clean": "npm-run-all --parallel build:clean:dist build:clean:parse build:clean:csstemplates",
+    "build:clean": "npm-run-all --parallel build:cjs:clean build:es2015:clean build:clean:parse build:clean:csstemplates",
     "build:clean:csstemplates": "shx rm -f src/render/graphics/csstemplates.json",
-    "build:clean:dist": "shx rm -rf dist/*",
     "build:clean:parse": "shx rm -rf src/parse/*parser.js",
     "build:csstemplates": "node utl/to-csstemplates-js.utility.js > src/render/graphics/csstemplates.json",
-    "build:compile:typescript": "tsc --project src",
     "build:compile:pegjs": "npm-run-all --parallel build:compile:pegjs:mscgen build:compile:pegjs:msgenny build:compile:pegjs:xu",
@@ -56,6 +64,17 @@ "build:compile:pegjs:mscgen": "pegjs --extra-options-file config/.pegjs-config.json -o src/parse/mscgenparser.js src/parse/peg/mscgenparser.pegjs",
     "build:compile:pegjs:xu": "pegjs --extra-options-file config/.pegjs-config.json -o src/parse/xuparser.js src/parse/peg/xuparser.pegjs",
-    "build:copy": "npm-run-all build:copy:mkdir build:copy:copy build:copy:csstemplates",
-    "build:copy:mkdir": "shx mkdir -p dist/parse dist/render/graphics",
-    "build:copy:copy": "shx cp src/parse/*.js* dist/parse",
-    "build:copy:csstemplates": "shx cp src/render/graphics/csstemplates.json dist/render/graphics/csstemplates.json",
+    "build:extractversion": "node utl/create-stripped-packagejson.utility.js > src/version.json",
+    "build:cjs:clean": "shx rm -rf dist/cjs/*",
+    "build:cjs:compile:typescript": "tsc --project src/tsconfig.cjs.json",
+    "build:cjs:copy": "npm-run-all build:cjs:copy:mkdir --parallel build:cjs:copy:parser build:cjs:copy:csstemplates build:cjs:copy:version",
+    "build:cjs:copy:mkdir": "shx mkdir -p dist/cjs/parse dist/cjs/render/graphics",
+    "build:cjs:copy:parser": "shx cp src/parse/*.js* dist/cjs/parse",
+    "build:cjs:copy:csstemplates": "shx cp src/render/graphics/csstemplates.json dist/cjs/render/graphics/csstemplates.json",
+    "build:cjs:copy:version": "shx cp src/version.json dist/cjs/.",
+    "build:es2015:clean": "shx rm -rf dist/es2015/*",
+    "build:es2015:compile:typescript": "tsc --project src/tsconfig.es2015.json",
+    "build:es2015:copy": "npm-run-all build:es2015:copy:mkdir --parallel build:es2015:copy:parser build:es2015:copy:csstemplates build:es2015:copy:version",
+    "build:es2015:copy:mkdir": "shx mkdir -p dist/es2015/parse dist/es2015/render/graphics",
+    "build:es2015:copy:parser": "shx cp src/parse/*.js* dist/es2015/parse",
+    "build:es2015:copy:csstemplates": "shx cp src/render/graphics/csstemplates.json dist/es2015/render/graphics/csstemplates.json",
+    "build:es2015:copy:version": "shx cp src/version.json dist/es2015/.",
     "check": "npm-run-all depcruise lint test:all",
@@ -75,3 +94,3 @@ "check:ci": "npm-run-all depcruise lint test:all:ci",
     "upem:install": "npm install",
-    "watch": "tsc --project src --watch"
+    "watch": "tsc --project src/tsconfig.esnext.json --watch"
   },
@@ -78,0 +97,0 @@ "repository": {

README.md

@@ -40,4 +40,4 @@ # mscgen_js - core package
 ### Import it
-You'll have to import the mscgenjs module somehow. There's a commonjs and a
-requirejs variant, both of which are in the `mscgenjs`
+You'll have to import the mscgenjs module somehow. There's a commonjs, an es2015
+and a requirejs variant, all distributed in the `mscgenjs`
 [npm module](https://www.npmjs.com/package/mscgenjs)
@@ -54,3 +54,3 @@ (repo: [mscgenjs/mscgenjs-core](https://github.com/mscgenjs/mscgenjs-core)).
 // e.g. an electron shell without a minifier.
-const mscgenjs = require('mscgenjs/dist/index-lazy');
+const mscgenjs = require('mscgenjs/dist/cjs/index-lazy');
 ```
@@ -61,3 +61,3 @@
 //             node_modules.
-define(['./node_modules/mscgenjs/dist/index.min'], function(mscgenjs){
+define(['./node_modules/mscgenjs/dist/bundle/index.min'], function(mscgenjs){
     // your code here
@@ -68,6 +68,15 @@ });
 define(function(require){
-    var mscgenjs = require("./node_modules/mscgenjs/dist/index.min");
+    var mscgenjs = require("./node_modules/mscgenjs/dist/bundle/index.min");
     // your code here
 });
 ```
+
+```javascript
+// es2015 modules
+// if you're using webpack or rollup, it'll default to the es2015
+// modules distributed in dist/es2015
+import {renderMsc} from 'mscgenjs';
+```
+
+
 > Previously, as a workaround for webpack
@@ -77,3 +86,3 @@ > issue [webpack/webpack#5316](https://github.com/webpack/webpack/issues/5316)
 > `dist` folder. That's not necessary anymore; using `require('mscgenjs')`
-> works fine.
+> or `import {renderMsc} from 'mcgenjs'` works fine.
 
@@ -80,0 +89,0 @@ ### Use it

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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1288155

increased by68.49%

Number of package files

108

increased by92.86%

Lines of code

31374

increased by96.86%

Number of lines in readme file

283

increased by3.28%

Worsened metrics

Number of low license alerts

4

increased by33.33%

Number of low supply chain risk alerts

4

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes