canvasjs - npm Package Compare versions

Comparing version 1.8.0 to 1.8.1

package.json

 {
   "name": "canvasjs",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "description": "CanvasJS charting library",
-  "main": "",
-  "scripts": {},
+  "main": "src/main/index.js",
+  "scripts": {
+    "build": "browserify ./src/main/index.js -d --s 'CanvasJS' > dist/canvasjs.js && node_modules/uglify-js/bin/uglifyjs --compress --mangle -- dist/canvasjs.js > dist/canvasjs.min.js",
+    "docs": "rm -rf docs/out/$npm_package_version && jsdoc src --configure jsdoc.conf",
+    "plato": "babel -d es5 src && plato -r -d docs/plato -t 'CanvasJS' es5 && rm -rf es5",
+    "lint": "eslint --ext .js src",
+    "bump": "npm run bump:patch",
+    "bump:patch": "npm-bump patch origin master",
+    "bump:minor": "npm-bump minor origin master",
+    "bump:major": "npm-bump major origin master"
+  },
   "repository": "https://github.com/Tsur/canvasjs.git",
   "license": "CC",
   "dependencies": {},
-  "devDependencies": {}
+  "devDependencies": {
+    "babel-preset-es2015": "^6.1.18",
+    "babel-preset-stage-1": "^6.1.18",
+    "babelify": "^7.2.0",
+    "browserify": "^12.0.1",
+    "ghooks": "^1.0.1",
+    "uglify-js": "^2.6.1",
+    "npm-bump": "0.0.15"
+  },
+  "browserify": {
+    "transform": [
+      [
+        "babelify",
+        {
+          "presets": [
+            "es2015",
+            "stage-1"
+          ]
+        }
+      ]
+    ]
+  },
+  "config": {
+    "ghooks": {
+      "pre-commit": "npm run build && git add . --all",
+      "pre-push": "npm run test"
+    }
+  }
 }

README.md

 
 CanvasJS, as depicted in its [official website](http://canvasjs.com), is a charting library:
- 
+
 > CanvasJS is an easy to use JavaScript & HTML5 Charts library built on Canvas element. It runs across devices including iPhone, iPad, Android, Windows Phone, Microsoft Surface, Desktops, etc. This allows you to create rich dashboards that work on all the devices without compromising on maintainability or functionality of your web application. CanvasJS comes with beautiful themes and is over 10x faster than conventional Flash and SVG Charts – resulting in lightweight, beautiful and responsive dashboards.
 
-## Disclaimer
+## Download
 
-This repository just extends the original code by including new features and several fixes. 
+```
+npm install canvasjs
+```
 
-The original code can be found at [http://canvasjs.com](http://canvasjs.com). It was released as [CC](http://creativecommons.org/licenses/by-nc/3.0/deed.en_US) for personal use and it needs to be licensed under commercial use - see terms [here](http://canvasjs.com/license-canvasjs/). 
+## Getting Started
 
-## Download
+First of all, you need to import it. This can be achieved in different ways depending up on what module definition pattern your application is using.
 
+The CanvasJS package works by default with CommonJS so you can use it with browserify/webpack as shown below:
+
+```js
+// CommonJS
+var CanvasJS = require('canvasjs');
+
+// If you are using ES6, then
+import CanvasJS from 'canvasjs';
 ```
-npm install canvasjs
+
+It is also possible to use it with AMD loaders as Require.js. If so, you can import it this way:
+
+```js
+// AMD
+require('canvasjs/dist/canvasjs.js', function(CanvasJS){
+
+       // Add your stuff here
+});
 ```
+
+Finally, you may also import it as a global dependence:
+
+```html
+<script src="canvasjs/dist/canvasjs.js">
+```
+
+Then you can access the global variable `CanvasJS`.
+
+** Note: dist folder also contains a minified version located at dist/canvasjs.min.js and ready for production, and also a wrapper for using it with jQuery.
+
+## Build
+
+```
+npm run build
+```
+
+## Disclaimer
+
+This repository just extends the original code by including new features and several fixes.
+
+The original code can be found at [http://canvasjs.com](http://canvasjs.com). It was released as [CC](http://creativecommons.org/licenses/by-nc/3.0/deed.en_US) for personal use and it needs to be licensed under commercial use - see terms [here](http://canvasjs.com/license-canvasjs/).

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3767725

increased by285.01%

Number of package files

61

increased by369.23%

Lines of code

49046

increased by274.77%

Number of lines in readme file

57

increased by235.29%

Worsened metrics

Dev dependency count

7

increased byInfinity%

Number of low quality alerts

2

increased by100%

Number of low supply chain risk alerts

5

increased by400%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes