- Enhancement: ESM distribution and point to source via `package.json…

…` `module` - Refactoring: ESM in source; change Bezier functions to individual exports - Docs: Fix jsdoc item; Add jsdoc config - npm: Add `rollup` script; add it and `eslint` to test script; add `jsdoc` script and scripts/server for opening docs; update deps
signavio · Apr 28, 2019 · 519dfdc · 519dfdc
1 parent 24fd7a0
commit 519dfdc
Show file tree

Hide file tree

Showing 12 changed files with 2,082 additions and 67 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,7 +10,9 @@ lib-cov
 pids
 logs
 results
+dist
+docs/jsdoc
 
 npm-debug.log
 
-node_modules/
+node_modules
diff --git a/README.md b/README.md
@@ -14,16 +14,16 @@ Installation
 API
 ---
 
-This module exports two functions: 
+This module exports two functions:
 
-The `intersect` function takes two shapes as an input an returns an result 
+The `intersect` function takes two shapes as an input an returns an result
 object providing a result status, and all intersection points of the two shapes.
 
 ```intersect (shape1, shape2)```
 
 
-The `shape` function wraps the necessary input parameters for each of 
-the two shapes. It requires the SVG element name of the shape as a string 
+The `shape` function wraps the necessary input parameters for each of
+the two shapes. It requires the SVG element name of the shape as a string
 and an object of the SVG element's attributes.
 
 ```shape (svgElementName, svgAttributes)```
@@ -37,7 +37,7 @@ Usage example
 ![Example image](./images/UsageExample1.png)
 
 ```javascript
-    
+
     var svgIntersections = require('svg-intersections');
     var intersect = svgIntersections.intersect;
     var shape = svgIntersections.shape;
@@ -53,6 +53,6 @@ Usage example
 Credits
 -------
 
-The implementation is based on the intersection procedures by Kevin Lindsey 
-([http://www.kevlindev.com](www.kevlindev.com)) with contributions by 
-Robert Benko ([http://www.quazistax.com](www.quazistax.com)).
+The implementation is based on the intersection procedures by Kevin Lindsey
+([http://www.kevlindev.com](www.kevlindev.com)) with contributions by
+Robert Benko ([http://www.quazistax.com](www.quazistax.com)).
diff --git a/docs/jsdoc-config.js b/docs/jsdoc-config.js
@@ -0,0 +1,28 @@
+/* eslint-env node */
+'use strict';
+
+module.exports = {
+  plugins: [],
+  recurseDepth: 10,
+  source: {
+    exclude: [
+      'node_modules',
+      'dist',
+      'test'
+    ],
+    excludePattern: 'rollup*'
+  },
+  sourceType: 'module',
+  tags: {
+    allowUnknownTags: false
+  },
+  templates: {
+    cleverLinks: true,
+    monospaceLinks: false
+  },
+  opts: {
+    recurse: true,
+    verbose: true,
+    destination: 'docs/jsdoc'
+  }
+};
diff --git a/index.js b/index.js
@@ -1,4 +1,6 @@
 // expose module classes
+import IntersectionParams from './lib/IntersectionParams';
 
-exports.intersect = require('./lib/intersect');
-exports.shape = require('./lib/IntersectionParams').newShape;
+export const shape = IntersectionParams.newShape;
+
+export {default as intersect} from './lib/intersect';
diff --git a/lib/Intersection.js b/lib/Intersection.js
@@ -34,4 +34,4 @@ Intersection.prototype.appendPoints = function(points) {
     this.points = this.points.concat(points);
 };
 
-module.exports = Intersection;
+export default Intersection;
diff --git a/lib/IntersectionParams.js b/lib/IntersectionParams.js
@@ -1,4 +1,4 @@
-var Point2D = require('kld-affine').Point2D;
+import {Point2D} from 'kld-affine';
 
 
 /**
@@ -77,7 +77,7 @@ function getArcParameters(startPoint, endPoint, rx, ry, angle, arcFlag, sweepFla
  *  IntersectionParams
  *
  *  @param {String} name
- *  @param {Array<Point2D} params
+ *  @param {Array<Point2D>} params
  *  @returns {IntersectionParams}
  */
 function IntersectionParams(name, params) {
@@ -890,4 +890,4 @@ RelativeSmoothCurveto3.prototype.getIntersectionParams = function() {
 };
 
 
-module.exports = IntersectionParams;
+export default IntersectionParams;
diff --git a/lib/functions/bezier.js b/lib/functions/bezier.js
@@ -1,10 +1,6 @@
-var Intersection = require('../Intersection');
-
-var affine = require('kld-affine');
-var Point2D = affine.Point2D;
-var Vector2D = affine.Vector2D;
-
-var Polynomial = require('kld-polynomial').Polynomial;
+import Intersection from '../Intersection';
+import {Point2D, Vector2D} from 'kld-affine';
+import {Polynomial} from 'kld-polynomial';
 
 function removeMultipleRootsIn01(roots) {
     var ZEROepsilon = 1e-15;
@@ -19,8 +15,6 @@ function removeMultipleRootsIn01(roots) {
     }
 }
 
-module.exports = {};
-
 /**
  *  intersectBezier2Bezier2
  *
@@ -32,7 +26,7 @@ module.exports = {};
  *  @param {Point2D} b3
  *  @returns {Intersection}
  */
-module.exports.intersectBezier2Bezier2 = function(a1, a2, a3, b1, b2, b3) {
+export function intersectBezier2Bezier2(a1, a2, a3, b1, b2, b3) {
     var a, b;
     var c12, c11, c10;
     var c22, c21, c20;
@@ -126,7 +120,7 @@ module.exports.intersectBezier2Bezier2 = function(a1, a2, a3, b1, b2, b3) {
     }
 
     return result;
-};
+}
 
 
 /**
@@ -141,7 +135,7 @@ module.exports.intersectBezier2Bezier2 = function(a1, a2, a3, b1, b2, b3) {
  *  @param {Point2D} b4
  *  @returns {Intersection}
  */
-module.exports.intersectBezier2Bezier3 = function(a1, a2, a3, b1, b2, b3, b4) {
+export function intersectBezier2Bezier3(a1, a2, a3, b1, b2, b3, b4) {
     var a, b,c, d;
     var c12, c11, c10;
     var c23, c22, c21, c20;
@@ -255,7 +249,7 @@ module.exports.intersectBezier2Bezier3 = function(a1, a2, a3, b1, b2, b3, b4) {
 
     return result;
 
-};
+}
 
 /**
  *  intersectBezier2Ellipse
@@ -268,7 +262,7 @@ module.exports.intersectBezier2Bezier3 = function(a1, a2, a3, b1, b2, b3, b4) {
  *  @param {Number} ry
  *  @returns {Intersection}
  */
-module.exports.intersectBezier2Ellipse = function(p1, p2, p3, ec, rx, ry) {
+export function intersectBezier2Ellipse(p1, p2, p3, ec, rx, ry) {
     var a, b;       // temporary variables
     var c2, c1, c0; // coefficients of quadratic
     var result = new Intersection();
@@ -302,7 +296,7 @@ module.exports.intersectBezier2Ellipse = function(p1, p2, p3, ec, rx, ry) {
     }
 
     return result;
-};
+}
 
 
 /**
@@ -315,7 +309,7 @@ module.exports.intersectBezier2Ellipse = function(p1, p2, p3, ec, rx, ry) {
  *  @param {Point2D} a2
  *  @returns {Intersection}
  */
-module.exports.intersectBezier2Line = function(p1, p2, p3, a1, a2) {
+export function intersectBezier2Line(p1, p2, p3, a1, a2) {
     var a, b;             // temporary variables
     var c2, c1, c0;       // coefficients of quadratic
     var cl;               // c coefficient for normal form of line
@@ -380,7 +374,7 @@ module.exports.intersectBezier2Line = function(p1, p2, p3, a1, a2) {
     }
 
     return result;
-};
+}
 
 
 /**
@@ -396,7 +390,7 @@ module.exports.intersectBezier2Line = function(p1, p2, p3, a1, a2) {
  *  @param {Point2D} b4
  *  @returns {Intersection}
  */
-module.exports.intersectBezier3Bezier3 = function(a1, a2, a3, a4, b1, b2, b3, b4) {
+export function intersectBezier3Bezier3(a1, a2, a3, a4, b1, b2, b3, b4) {
     var a, b, c, d;         // temporary variables
     var c13, c12, c11, c10; // coefficients of cubic
     var c23, c22, c21, c20; // coefficients of cubic
@@ -695,7 +689,7 @@ module.exports.intersectBezier3Bezier3 = function(a1, a2, a3, a4, b1, b2, b3, b4
     }
 
     return result;
-};
+}
 
 /**
  *  intersectBezier3Ellipse
@@ -709,7 +703,7 @@ module.exports.intersectBezier3Bezier3 = function(a1, a2, a3, a4, b1, b2, b3, b4
  *  @param {Number} ry
  *  @returns {Intersection}
  */
-module.exports.intersectBezier3Ellipse = function(p1, p2, p3, p4, ec, rx, ry) {
+export function intersectBezier3Ellipse(p1, p2, p3, p4, ec, rx, ry) {
     var a, b, c, d;       // temporary variables
     var c3, c2, c1, c0;   // coefficients of cubic
     var result = new Intersection();
@@ -758,7 +752,7 @@ module.exports.intersectBezier3Ellipse = function(p1, p2, p3, p4, ec, rx, ry) {
     }
 
     return result;
-};
+}
 
 
 /**
@@ -776,7 +770,7 @@ module.exports.intersectBezier3Ellipse = function(p1, p2, p3, p4, ec, rx, ry) {
  *  @param {Point2D} a2
  *  @returns {Intersection}
  */
-module.exports.intersectBezier3Line = function(p1, p2, p3, p4, a1, a2) {
+export function intersectBezier3Line(p1, p2, p3, p4, a1, a2) {
     var a, b, c, d;       // temporary variables
     var c3, c2, c1, c0;   // coefficients of cubic
     var cl;               // c coefficient for normal form of line
@@ -867,4 +861,4 @@ module.exports.intersectBezier3Line = function(p1, p2, p3, p4, a1, a2) {
     }
 
     return result;
-};
+}
diff --git a/lib/intersect.js b/lib/intersect.js
@@ -9,13 +9,21 @@
  *      @license MIT
  */
 
-var Point2D = require('kld-affine').Point2D;
-var Vector2D = require('kld-affine').Vector2D;
-var Matrix2D = require('kld-affine').Matrix2D;
-var Polynomial = require('kld-polynomial').Polynomial;
-var IntersectionParams = require('./IntersectionParams');
-var Intersection = require('./Intersection');
-var bezierIntersectionFunctions = require('./functions/bezier')
+import {Point2D, Vector2D, Matrix2D} from 'kld-affine';
+import {Polynomial} from 'kld-polynomial';
+import IntersectionParams from './IntersectionParams';
+import Intersection from './Intersection';
+import {
+  intersectBezier2Bezier2, intersectBezier2Bezier3, intersectBezier2Ellipse,
+  intersectBezier2Line, intersectBezier3Bezier3, intersectBezier3Ellipse,
+  intersectBezier3Line
+} from './functions/bezier';
+
+var bezierIntersectionFunctions = {
+  intersectBezier2Bezier2, intersectBezier2Bezier3, intersectBezier2Ellipse,
+  intersectBezier2Line, intersectBezier3Bezier3, intersectBezier3Ellipse,
+  intersectBezier3Line
+};
 
 var IPTYPE = IntersectionParams.TYPE;
 
@@ -695,4 +703,4 @@ for(var key in bezierIntersectionFunctions) {
     }
 }
 
-module.exports = intersect;
+export default intersect;