[FEAT] Update to ES6 Modules

.github/workflows/main.yml

@@ -0,0 +1,60 @@
+name: geometry-processing - Continuous Integration
+
+on:
+  push
+
+jobs:
+  test:
+    name: Run Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+        with:
+          lfs: true
+
+      - name: Install Testing Frameworks
+        run: |
+          echo '{ "type": "module", "scripts": { "test": "mocha tests/**/*.js --reporter mocha-github-actions-reporter" } }' >package.json
+          npm install --save-dev mocha chai mocha-github-actions-reporter
+
+      - name: Run Unit Tests
+        timeout-minutes: 5
+        run: npm test
+
+  docs:
+    name: Build Docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+        with:
+          lfs: true
+
+      - name: Install Doc Generation Frameworks
+        run: |
+          echo '{ "type": "module", "scripts": { "docs": "jsdoc -c doc-config/jsdoc.conf.json -t node_modules/ink-docstrap/template/ -R README.md -r -d docs ./" } }' >package.json
+          npm install --save-dev jsdoc ink-docstrap
+
+      - name: Pre-Process Docs
+        run: | 
+          cp doc-config/site.cosmo-rohan.css node_modules/ink-docstrap/template/static/styles/site.cosmo-rohan.css
+
+      - name: Generate Docs
+        run: npm run docs
+
+      - name: Post-Process Docs
+        run: sed -e 's/imgs\//..\/imgs\//g' docs/index.html > docs/index.html.tmp && mv docs/index.html.tmp docs/index.html
+
+      - name: Commit Updated Docs
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Actions"
+          git add docs
+          git diff-index --quiet HEAD || git commit -m "Rebuild Docs"
+
+      - name: Push Changes to branch
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}

core/corner.js

@@ -1,5 +1,3 @@
-"use strict";
-
 class Corner {
 	/**
 	 * This class represents a corner in a {@link module:Core.Mesh Mesh}. It is a convenience
@@ -58,3 +56,5 @@ class Corner {
 		return this.index;
 	}
 }
+
+export default Corner;

core/discrete-exterior-calculus.js

@@ -1,7 +1,9 @@
-"use strict";
+import LinearAlgebra from '../linear-algebra/linear-algebra.js';
+let SparseMatrix = LinearAlgebra.SparseMatrix;
+let Triplet = LinearAlgebra.Triplet;
 
 /**
- * This class contains methods to build common {@link https://cs.cmu.edu/~kmcrane/Projects/DDG/paper.pdf discrete exterior calculus} operators.
+ * This class contains methods to build common {@link https://www.cs.cmu.edu/~kmcrane/Projects/DDG/paper.pdf discrete exterior calculus} operators.
  * @memberof module:Core
  */
 class DEC {
@@ -124,3 +126,5 @@ class DEC {
 		return SparseMatrix.fromTriplet(T);
 	}
 }
+
+export default DEC;

core/edge.js

@@ -1,5 +1,3 @@
-"use strict";
-
 class Edge {
 	/**
 	 * This class represents an edge in a {@link module:Core.Mesh Mesh}.
@@ -30,3 +28,5 @@ class Edge {
 		return this.index;
 	}
 }
+
+export default Edge;

core/face.js

@@ -1,5 +1,3 @@
-"use strict";
-
 class Face {
 	/**
 	 * This class represents a face in a {@link module:Core.Mesh Mesh}.
@@ -306,4 +304,6 @@ class FaceCornerIterator {
 			}
 		}
 	}
-}
+}
+
+export default Face;

core/geometry.js

@@ -1,4 +1,10 @@
-"use strict";
+import LinearAlgebra from '../linear-algebra/linear-algebra.js';
+let Vector = LinearAlgebra.Vector;
+let Complex = LinearAlgebra.Complex;
+let SparseMatrix = LinearAlgebra.SparseMatrix;
+let Triplet = LinearAlgebra.Triplet;
+let ComplexSparseMatrix = LinearAlgebra.ComplexSparseMatrix;
+let ComplexTriplet = LinearAlgebra.ComplexTriplet;
 
 class Geometry {
 	/**
@@ -245,7 +251,7 @@ class Geometry {
 
 	/**
 	 * Computes the circumcentric dual area of a vertex.
-	 * @see {@link http://cs.cmu.edu/~kmcrane/Projects/Other/TriangleAreasCheatSheet.pdf}
+	 * @see {@link http://www.cs.cmu.edu/~kmcrane/Projects/Other/TriangleAreasCheatSheet.pdf}
 	 * @method module:Core.Geometry#circumcentricDualArea
 	 * @param {module:Core.Vertex} v The vertex whose circumcentric dual area needs to be computed.
 	 * @returns {number}
@@ -572,3 +578,5 @@ function normalize(positions, vertices, rescale = true) {
 		}
 	}
 }
+
+export { Geometry, normalize };

core/halfedge.js

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * This module implements a halfedge mesh data structure and its associated geometry.
  * A halfedge mesh stores mesh elements such as vertices, edges and faces as well as
@@ -58,3 +56,5 @@ class Halfedge {
 		return this.index;
 	}
 }
+
+export default Halfedge;

core/mesh-subset.js

@@ -1,5 +1,3 @@
-"use strict";
-
 class MeshSubset {
         /**
          * This class represents a subset of a {@link module:Core.Mesh Mesh}
@@ -212,3 +210,5 @@ class MeshSubset {
                 return true;
         }
 }
+
+export default MeshSubset;

core/mesh.js

@@ -1,4 +1,8 @@
-"use strict";
+import Vertex from './vertex.js';
+import Edge from './edge.js';
+import Face  from './face.js';
+import Halfedge from './halfedge.js';
+import Corner from './corner.js';
 
 class Mesh {
 	/**
@@ -207,7 +211,7 @@ class Mesh {
 		}
 
 		// index elements
-                this.indexElements();
+		this.indexElements();
 
 		return true;
 	}
@@ -401,3 +405,5 @@ function indexElements(elementList) {
 
 	return index;
 }
+
+export { Mesh, indexElements }

core/vertex.js

@@ -1,5 +1,3 @@
-"use strict";
-
 class Vertex {
 	/**
 	 * This class represents a vertex in a {@link module:Core.Mesh Mesh}.
@@ -335,4 +333,6 @@ class VertexCornerIterator {
 			}
 		}
 	}
-}
+}
+
+export default Vertex;

doc-config/jsdoc.conf.json

@@ -26,6 +26,6 @@
     "hardwrap": true
   },
   "source": {
-      "excludePattern": "geometry-processing-js/node"
+      "excludePattern": "node_modules"
   }
 }

docs/classes.list.html

@@ -47,7 +47,7 @@
 			<li class="dropdown">
 				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
 				<ul class="dropdown-menu ">
-					<li><a href="global.html#normalize">normalize</a></li><li><a href="global.html#indexElements">indexElements</a></li><li><a href="global.html#Detector">Detector</a></li><li><a href="global.html#clamp">clamp</a></li><li><a href="global.html#colormap">colormap</a></li><li><a href="global.html#hsv">hsv</a></li>
+					<li><a href="global.html#normalize">normalize</a></li><li><a href="global.html#indexElements">indexElements</a></li><li><a href="global.html#clamp">clamp</a></li><li><a href="global.html#colormap">colormap</a></li><li><a href="global.html#hsv">hsv</a></li>
 				</ul>
 			</li>
 
@@ -318,9 +318,9 @@ <h4 class="modal-title">Search results</h4>
 
 
 <span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
+	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a>
 
-		on Mon Jan 13th 2020
+		on Sun Feb 14th 2021
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

docs/global.html

@@ -47,7 +47,7 @@
 			<li class="dropdown">
 				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
 				<ul class="dropdown-menu ">
-					<li><a href="global.html#normalize">normalize</a></li><li><a href="global.html#indexElements">indexElements</a></li><li><a href="global.html#Detector">Detector</a></li><li><a href="global.html#clamp">clamp</a></li><li><a href="global.html#colormap">colormap</a></li><li><a href="global.html#hsv">hsv</a></li>
+					<li><a href="global.html#normalize">normalize</a></li><li><a href="global.html#indexElements">indexElements</a></li><li><a href="global.html#clamp">clamp</a></li><li><a href="global.html#colormap">colormap</a></li><li><a href="global.html#hsv">hsv</a></li>
 				</ul>
 			</li>
 
@@ -152,75 +152,6 @@ <h2>
 
 
 
-        <h3 class="subsection-title">Members</h3>
-
-        <dl>
-
-<hr>
-<dt class="name" id="Detector">
-    <h4 id="Detector"><span class="type-signature"></span>Detector<span class="type-signature"></span></h4>
-
-
-</dt>
-<dd>
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-	<dt class="tag-author method-doc-label method-doc-details-label">Author:</dt>
-	<dd class="tag-author">
-		<ul>
-			<li>alteredq / http://alteredqualia.com/</li>
-
-			<li>mr.doob / http://mrdoob.com/</li>
-			</ul>
-	</dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-</dl>
-
-
-
-</dd>
-
-        </dl>
-
 
 
         <h3 class="subsection-title">Methods</h3>
@@ -1226,9 +1157,9 @@ <h4 class="modal-title">Search results</h4>
 
 
 <span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
+	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a>
 
-		on Mon Jan 13th 2020
+		on Sun Feb 14th 2021
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

docs/index.html

@@ -47,7 +47,7 @@
 			<li class="dropdown">
 				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
 				<ul class="dropdown-menu ">
-					<li><a href="global.html#normalize">normalize</a></li><li><a href="global.html#indexElements">indexElements</a></li><li><a href="global.html#Detector">Detector</a></li><li><a href="global.html#clamp">clamp</a></li><li><a href="global.html#colormap">colormap</a></li><li><a href="global.html#hsv">hsv</a></li>
+					<li><a href="global.html#normalize">normalize</a></li><li><a href="global.html#indexElements">indexElements</a></li><li><a href="global.html#clamp">clamp</a></li><li><a href="global.html#colormap">colormap</a></li><li><a href="global.html#hsv">hsv</a></li>
 				</ul>
 			</li>
 
@@ -147,9 +147,7 @@ <h2>Dependencies (all included)</h2>
 <h2>About Javascript</h2>
 <p>The implementation of geometry-processing-js attempts to minimize the use of obscure Javascript language features. It should not be too difficult for anyone with experience in a dynamic language like Python or familiar with the principles of Object Oriented Programming to get a handle on Javascript syntax by reading through some of the code in this framework. The documentation contains examples specific to this framework which will also be of help. For a more formal introduction to Javascript, checkout this really nice <a href="https://javascript.info">tutorial</a>.</p>
 <h2>Building the Documentation</h2>
-<p>This documentation was generated using <a href="http://usejsdoc.org/">jsdoc</a> and <a href="https://www.npmjs.com/package/ink-docstrap">ink-docstrap</a>. We used a modified version of the <a href="http://docstrap.github.io/docstrap/themes/cosmo/">cosmo</a> theme. After installing jsdoc and ink-docstrap, you can build the documentation by running</p>
-<pre class="prettyprint source"><code>jsdoc -c node_modules/ink-docstrap/template/jsdoc.conf.json -t node_modules/ink-docstrap/template/ -R geometry-processing-js/README.md -r -d geometry-processing-js/docs
-</code></pre>
+<p>See <a href="doc-config/build-instructions.md">guide here</a>.</p>
 <h2>Authors</h2>
 <p><a href="http://rohansawhney.io">Rohan Sawhney</a></p>
 <p>Email: rohansawhney@cs.cmu.edu</p>
@@ -206,9 +204,9 @@ <h4 class="modal-title">Search results</h4>
 
 
 <span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
+	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a>
 
-		on Mon Jan 13th 2020
+		on Sun Feb 14th 2021
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
@@ -299,4 +297,4 @@ <h4 class="modal-title">Search results</h4>
 
 
 </body>
-</html>
+</html>