update setup

Author: sgratzl

README.md

@@ -2,15 +2,17 @@
 
 [![datavisyn][datavisyn-image]][datavisyn-url] [![License: MIT][mit-image]][mit-url] [![NPM Package][npm-image]][npm-url] [![Github Actions][github-actions-image]][github-actions-url]
 
-Chart.js module for charting box and violin plots. **Works only with Chart.js >= 2.8.0**
+Chart.js module for charting box and violin plots.
+
+**Works only with Chart.js >= 3.0.0**
 
 ![Box Plot](https://user-images.githubusercontent.com/4129778/42724341-9a6ec554-8770-11e8-99b5-626e34dafdb3.png)
 ![Violin Plot](https://user-images.githubusercontent.com/4129778/42724342-9a8dbb58-8770-11e8-9a30-3e69d07d3b79.png)
 
 ## Install
 
 ```bash
-npm install --save chart.js @sgratzl/chartjs-chart-boxplot
+npm install --save chart.js@next @sgratzl/chartjs-chart-boxplot@next
 ```
 
 ## Usage
@@ -299,26 +301,46 @@ arr = {
 };
 ```
 
-## Building
+### ESM and Tree Shaking
+
+The ESM build of the library supports three shaking but having no side effects. As a consequence the chart.js library won't be automatically manipulated nor new controllers automatically registered. One has to manually import and register them.
+
+```js
+import Chart from 'chart.js';
+import { BoxPlot } from '@sgratzl/chartjs-chart-boxplot';
+
+// register controller in chart.js and ensure the defaults are set
+BoxPlot.register();
+...
+```
+
+## Development Environment
+
+```sh
+npm i -g yarn
+yarn set version 2
+yarn
+yarn pnpify --sdk
+```
+
+### Building
 
 ```sh
-npm install
-npm run build
+yarn install
+yarn build
 ```
 
 ---
 
-<div style="display:flex;align-items:center">
-  <a href="https://www.datavisyn.io"><img src="https://user-images.githubusercontent.com/1711080/37700685-bcbb18c6-2cec-11e8-9b6f-f49c9ef6c167.png" align="left" width="50px" hspace="10" vspace="6"></a>
-  Developed by&nbsp;<strong><a href="https://www.datavisyn.io">datavisyn</a></strong>.
-</div>
+<a href="https://www.datavisyn.io"><img src="https://www.datavisyn.io/img/logos/datavisyn-d-logo.png" align="left" width="25px" hspace="10" vspace="6"></a>
+developed by **[datavisyn][datavisyn-url]**.
 
 [datavisyn-image]: https://img.shields.io/badge/datavisyn-io-black.svg
 [datavisyn-url]: https://www.datavisyn.io
 [mit-image]: https://img.shields.io/badge/License-MIT-yellow.svg
 [mit-url]: https://opensource.org/licenses/MIT
-[npm-image]: https://badge.fury.io/js/@sgratzl/chartjs-chart-boxplot.svg
+[npm-image]: https://badge.fury.io/js/%40sgratzl%2Fchartjs-chart-boxplot.svg
 [npm-url]: https://npmjs.org/package/@sgratzl/chartjs-chart-boxplot
-[github-actions-image]: https://github.com/sgratzl/chartjs-chart-box-and-violin-plot/workflows/ci/badge.svg
-[github-actions-url]: https://github.com/sgratzl/chartjs-chart-box-and-violin-plot/actions
+[github-actions-image]: https://github.com/sgratzl/chartjs-chart-boxplot/workflows/ci/badge.svg
+[github-actions-url]: https://github.com/sgratzl/chartjs-chart-boxplot/actions
 [codepen]: https://img.shields.io/badge/CodePen-open-blue?logo=codepen

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sgratzl/chartjs-chart-boxplot",
   "description": "Chart.js module for charting boxplots and violin charts",
-  "version": "2.3.1",
+  "version": "3.0.0-alpha.0",
   "author": {
     "name": "datavisyn",
     "email": "contact@datavisyn.io",
@@ -22,58 +22,65 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/sgratzl/chartjs-chart-box-and-violin-plot.git"
+    "url": "https://github.com/sgratzl/chartjs-chart-boxplot.git"
   },
   "main": "build/Chart.BoxPlot.js",
   "unpkg": "build/Chart.BoxPlot.min.js",
   "module": "build/Chart.BoxPlot.esm.js",
+  "sideEffects": false,
   "files": [
     "build",
     "src/**/*.js"
   ],
+  "peerDependencies": {
+    "chart.js": "^3.0.0-alpha"
+  },
   "dependencies": {
+    "@babel/runtime": "^7.9.6",
     "@sgratzl/science": "^2.0.0"
   },
-  "peerDependencies": {
-    "chart.js": "^2.8.0"
-  },
   "devDependencies": {
-    "@babel/core": "^7.9.0",
-    "@babel/preset-env": "^7.9.5",
-    "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^25.3.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.1",
+    "@babel/core": "^7.9.6",
+    "@babel/plugin-transform-runtime": "^7.9.6",
+    "@babel/preset-env": "^7.9.6",
+    "@rollup/plugin-babel": "^5.0.0",
+    "@rollup/plugin-commonjs": "^11.1.0",
+    "@rollup/plugin-node-resolve": "^7.1.3",
+    "@yarnpkg/pnpify": "^2.0.0-rc.22",
+    "babel-jest": "^26.0.1",
+    "chart.js": "^3.0.0-alpha",
+    "eslint": "^7.0.0",
+    "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-prettier": "^3.1.3",
-    "jest": "^25.3.0",
-    "prettier": "^2.0.4",
-    "release-it": "^13.5.2",
+    "jest": "^26.0.1",
+    "prettier": "^2.0.5",
+    "release-it": "^13.6.0",
     "rimraf": "^3.0.2",
-    "rollup": "^2.6.1",
-    "rollup-plugin-babel": "^4.4.0",
-    "rollup-plugin-commonjs": "^10.1.0",
-    "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-watch": "^4.3.1",
+    "rollup": "^2.10.2",
+    "rollup-plugin-pnp-resolve": "^2.0.0",
     "uglify-es": "^3.3.9"
   },
   "scripts": {
     "clean": "rimraf build *.tgz",
-    "watch": "rollup -c -w -i src/index.js",
+    "watch": "rollup -c -w",
     "lint": "eslint src",
     "test": "jest --passWithNoTests",
     "test:watch": "jest --watch",
     "posttest": "npm run lint",
-    "build:dev": "rollup -c -i src/index.js",
+    "build:dev": "rollup -c",
     "build:prod": "npm run build:dev && uglifyjs build/Chart.BoxPlot.js -c -m -o build/Chart.BoxPlot.min.js",
     "prebuild": "npm run clean && npm test",
     "build": "npm run build:prod",
     "format": "prettier --write samples src package.json *.js README.md",
     "preversion": "npm run test",
     "prepare": "npm run build:dev",
     "prepublishOnly": "npm run build:prod",
-    "release:major": "release-it major",
-    "release:minor": "release-it minor",
-    "release:patch": "release-it patch",
-    "release:pre": "release-it --preRelease=alpha --npm.tag=next"
+    "release": "release-it --disable-metrics --npm.skipChecks",
+    "release:pre": "release-it --disable-metrics --npm.skipChecks --preRelease=alpha --npm.tag=next"
+  },
+  "dependenciesMeta": {
+    "chart.js": {
+      "unplugged": true
+    }
   }
 }

rollup.config.js

@@ -8,7 +8,7 @@ export default [
   {
     input: 'src/bundle.js',
     output: {
-      file: 'build/Chart.Geo.js',
+      file: 'build/Chart.BoxPlot.js',
       name: 'ChartGeo',
       format: 'umd',
       globals: {
@@ -21,7 +21,7 @@ export default [
   {
     input: 'src/index.js',
     output: {
-      file: 'build/Chart.Geo.esm.js',
+      file: 'build/Chart.BoxPlot.esm.js',
       name: 'ChartGeo',
       format: 'esm',
       globals: {

yarn.lock

@@ -1512,6 +1512,46 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@sgratzl/chartjs-chart-boxplot@workspace:.":
+  version: 0.0.0-use.local
+  resolution: "@sgratzl/chartjs-chart-boxplot@workspace:."
+  dependencies:
+    "@babel/core": ^7.9.6
+    "@babel/plugin-transform-runtime": ^7.9.6
+    "@babel/preset-env": ^7.9.6
+    "@babel/runtime": ^7.9.6
+    "@rollup/plugin-babel": ^5.0.0
+    "@rollup/plugin-commonjs": ^11.1.0
+    "@rollup/plugin-node-resolve": ^7.1.3
+    "@sgratzl/science": ^2.0.0
+    "@yarnpkg/pnpify": ^2.0.0-rc.22
+    babel-jest: ^26.0.1
+    chart.js: ^3.0.0-alpha
+    eslint: ^7.0.0
+    eslint-config-prettier: ^6.11.0
+    eslint-plugin-prettier: ^3.1.3
+    jest: ^26.0.1
+    prettier: ^2.0.5
+    release-it: ^13.6.0
+    rimraf: ^3.0.2
+    rollup: ^2.10.2
+    rollup-plugin-pnp-resolve: ^2.0.0
+    uglify-es: ^3.3.9
+  peerDependencies:
+    chart.js: ^3.0.0-alpha
+  dependenciesMeta:
+    chart.js:
+      unplugged: true
+  languageName: unknown
+  linkType: soft
+
+"@sgratzl/science@npm:^2.0.0":
+  version: 2.0.0
+  resolution: "@sgratzl/science@npm:2.0.0"
+  checksum: 3/0ed65107c7e3131256a11ef5677beb9184126377235f2a5899adb1e367ff0061e8e9d7830d9e6ebd413e3de1f5f34fd59b6328f7bc9906a64963e22f2d977fed
+  languageName: node
+  linkType: hard
+
 "@sindresorhus/is@npm:^0.14.0":
   version: 0.14.0
   resolution: "@sindresorhus/is@npm:0.14.0"
@@ -2556,41 +2596,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"chartjs-chart-geo@workspace:.":
-  version: 0.0.0-use.local
-  resolution: "chartjs-chart-geo@workspace:."
-  dependencies:
-    "@babel/core": ^7.9.6
-    "@babel/plugin-transform-runtime": ^7.9.6
-    "@babel/preset-env": ^7.9.6
-    "@babel/runtime": ^7.9.6
-    "@rollup/plugin-babel": ^5.0.0
-    "@rollup/plugin-commonjs": ^11.1.0
-    "@rollup/plugin-node-resolve": ^7.1.3
-    "@yarnpkg/pnpify": ^2.0.0-rc.22
-    babel-jest: ^26.0.1
-    chart.js: ^3.0.0-alpha
-    d3-geo: ^1.12.0
-    d3-scale-chromatic: ^1.5.0
-    eslint: ^7.0.0
-    eslint-config-prettier: ^6.11.0
-    eslint-plugin-prettier: ^3.1.3
-    jest: ^26.0.1
-    prettier: ^2.0.5
-    release-it: ^13.6.0
-    rimraf: ^3.0.2
-    rollup: ^2.10.2
-    rollup-plugin-pnp-resolve: ^2.0.0
-    topojson-client: ^3.1.0
-    uglify-es: ^3.3.9
-  peerDependencies:
-    chart.js: ^3.0.0-alpha
-  dependenciesMeta:
-    chart.js:
-      unplugged: true
-  languageName: unknown
-  linkType: soft
-
 "chownr@npm:^1.1.1":
   version: 1.1.4
   resolution: "chownr@npm:1.1.4"
@@ -2755,13 +2760,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"commander@npm:2":
-  version: 2.20.3
-  resolution: "commander@npm:2.20.3"
-  checksum: 3/b73428e97de7624323f81ba13f8ed9271de487017432d18b4da3f07cfc528ad754bbd199004bd5d14e0ccd67d1fdfe0ec8dbbd4c438b401df3c4cc387bfd1daa
-  languageName: node
-  linkType: hard
-
 "commander@npm:~2.14.1":
   version: 2.14.1
   resolution: "commander@npm:2.14.1"
@@ -2923,48 +2921,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"d3-array@npm:1":
-  version: 1.2.4
-  resolution: "d3-array@npm:1.2.4"
-  checksum: 3/ab114c72ccdcb3f53807574c003816ad6ac65c2c2db2b17b18e2678f1141881dfa0ddab60af63d73e428c826e4580b6cb9e93cb776c777c79fec9f75057d8fbd
-  languageName: node
-  linkType: hard
-
-"d3-color@npm:1":
-  version: 1.4.1
-  resolution: "d3-color@npm:1.4.1"
-  checksum: 3/a579fdc2f4ec50980e32d0ac5212c3023ee9c6a7555ae698278f05c9f7d06322f83dde01253f672f9f9fd05d8860f0256d25aee999a0d32cf4111d731413f5da
-  languageName: node
-  linkType: hard
-
-"d3-geo@npm:^1.12.0":
-  version: 1.12.0
-  resolution: "d3-geo@npm:1.12.0"
-  dependencies:
-    d3-array: 1
-  checksum: 3/a1d55989325a373ce68ba7ed8b706fa51ec33a44f3d1155d206f7f2117aca53227b4dc4acbbcac9bee0d76b67c30a09577565b1e6a006c62a8a5b9ac8b2392e7
-  languageName: node
-  linkType: hard
-
-"d3-interpolate@npm:1":
-  version: 1.4.0
-  resolution: "d3-interpolate@npm:1.4.0"
-  dependencies:
-    d3-color: 1
-  checksum: 3/beea08fb3a712ccb992082c058a96a108f31692bbcecbf8029539ff378747b666fd0f33798b313835a2cb019e399a30fd1f5b643822f1cc0be3c86b4fe4730c7
-  languageName: node
-  linkType: hard
-
-"d3-scale-chromatic@npm:^1.5.0":
-  version: 1.5.0
-  resolution: "d3-scale-chromatic@npm:1.5.0"
-  dependencies:
-    d3-color: 1
-    d3-interpolate: 1
-  checksum: 3/12f786b1b1d4c5eaa3f56f38b63832989f40f48d5ed0476325a0443af75d46824cab71b5b975e37cdd2f47a048d7db356f09364a7a5eea641cc81e3825ef996e
-  languageName: node
-  linkType: hard
-
 "dashdash@npm:^1.12.0":
   version: 1.14.1
   resolution: "dashdash@npm:1.14.1"
@@ -7813,19 +7769,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"topojson-client@npm:^3.1.0":
-  version: 3.1.0
-  resolution: "topojson-client@npm:3.1.0"
-  dependencies:
-    commander: 2
-  bin:
-    topo2geo: bin/topo2geo
-    topomerge: bin/topomerge
-    topoquantize: bin/topoquantize
-  checksum: 3/189471a7436a511aae95ad21a078e2b46dbe50f9efd80321935455983bb9859155011b865d61ca4f0f57d34e97db7811a3be943c96c39ab58cd82c76a849f618
-  languageName: node
-  linkType: hard
-
 "tough-cookie@npm:^2.3.3, tough-cookie@npm:~2.5.0":
   version: 2.5.0
   resolution: "tough-cookie@npm:2.5.0"