refactor: address PR review comments

See #72

.eslintrc.js

@@ -1,3 +1,4 @@
+// this file was autogenerated by tsdx using the `yarn lint --write-file` command
 module.exports = {
   "extends": [
     "standard",

lib/core/pattern.js

@@ -26,7 +26,7 @@ export default class RoutePattern {
     this.stops = []
 
     // the inter-stop geometry, an array of point sequences (themselves arrays)
-    // that represent the geometry beween stops i and i+1. This array should be
+    // that represent the geometry between stops i and i+1. This array should be
     // exactly one item shorter than the stops array.
     this.interStopGeometry = []
 

lib/display/display.js

@@ -1,6 +1,3 @@
-// The Display class is an abstract class and as such has some empty functions
-/* eslint-disable @typescript-eslint/no-empty-function */
-
 import LinearScale from '../util/linear-scale.js'
 
 export default class Display {
@@ -102,6 +99,8 @@ export default class Display {
 
   updateActiveZoomFactors(scale) {
     let updated = false
+    console.log('scale: ', this.scale)
+    console.log('Last scale: ', this.lastScale)
     for (let i = 0; i < this.zoomFactors.length; i++) {
       const min = this.zoomFactors[i].minScale
       const max =
@@ -125,9 +124,12 @@ export default class Display {
   computeScale() {
     this.lastScale = this.scale
     this.scaleSet = true
-    const newXRes = (this.xDomain[1] - this.xDomain[0]) / this.width
+    const xDomainRange = this.xDomain[1] - this.xDomain[0]
+    const newXRes = xDomainRange / this.width
     this.scale = this.initialXRes / newXRes
     if (this.lastScale !== this.scale) this.scaleChanged()
+    console.log('Computed scale: ', this.xDomain)
+    console.log('Computed scale: ', this.scale)
   }
 
   scaleChanged() {
@@ -227,15 +229,27 @@ export default class Display {
 
   /** Methods to be defined by subclasses **/
 
-  clear() {}
+  clear() {
+    throw new Error('method not implemented by subclass!')
+  }
 
-  drawCircle(coord, attrs) {}
+  drawCircle(coord, attrs) {
+    throw new Error('method not implemented by subclass!')
+  }
 
-  drawEllipse(coord, attrs) {}
+  drawEllipse(coord, attrs) {
+    throw new Error('method not implemented by subclass!')
+  }
 
-  drawRect(upperLeft, attrs) {}
+  drawRect(upperLeft, attrs) {
+    throw new Error('method not implemented by subclass!')
+  }
 
-  drawText(text, anchor, attrs) {}
+  drawText(text, anchor, attrs) {
+    throw new Error('method not implemented by subclass!')
+  }
 
-  drawPath(renderData, attrs) {}
+  drawPath(renderData, attrs) {
+    throw new Error('method not implemented by subclass!')
+  }
 }

lib/labeler/label.js

@@ -1,6 +1,3 @@
-// The Label class is an abstract class and as such has some empty functions
-/* eslint-disable @typescript-eslint/no-empty-function */
-
 /**
  * Label object
  */
@@ -24,8 +21,14 @@ export default class Label {
       : null
   }
 
-  render(display) {}
+  render(display) {
+    throw new Error('method not defined by subclass!')
+  }
 
+  /**
+   * Does not need to be implemented by subclass
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   refresh(display) {}
 
   setVisibility(visibility) {

lib/point/place.js

@@ -131,14 +131,4 @@ export default class Place extends Point {
       y: this.renderXY.y - radius
     }
   }
-
-  /**
-   * Refresh the place
-   *
-   * @param {Display} display
-   */
-
-  refresh(display) {
-    // FIXME is it ok this thing does nothing? FIXME added to avoid lint error.
-  }
 }

lib/point/point.js

@@ -1,6 +1,3 @@
-// The Point class is an abstract class and as such has some empty functions
-/* eslint-disable @typescript-eslint/no-empty-function */
-
 import { forEach } from 'lodash'
 
 import PointLabel from '../labeler/pointlabel'
@@ -32,7 +29,9 @@ export default class Point {
    * Get unique ID for point -- must be defined by subclass
    */
 
-  getId() {}
+  getId() {
+    throw new Error('method not defined by subclass!')
+  }
 
   getElementId() {
     return this.getType().toLowerCase() + '-' + this.getId()
@@ -42,7 +41,9 @@ export default class Point {
    * Get Point type -- must be defined by subclass
    */
 
-  getType() {}
+  getType() {
+    throw new Error('method not defined by subclass!')
+  }
 
   /**
    * Get Point name
@@ -94,10 +95,20 @@ export default class Point {
    * @param {Display} display
    */
 
-  render(display) {}
+  render(display) {
+    throw new Error('method not defined by subclass!')
+  }
 
+  /**
+   * Does not need to be implemented by subclass
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   addRenderData() {}
 
+  /**
+   * Does not need to be implemented by subclass
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   clearRenderData() {}
 
   containsFromPoint() {
@@ -248,8 +259,16 @@ export default class Point {
     return this.focused === true
   }
 
+  /**
+   * Does not need to be implemented by subclass
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   runFocusTransition(display, callback) {}
 
+  /**
+   * Does not need to be implemented by subclass
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   setAllPatternsFocused() {}
 
   getZIndex() {
@@ -277,6 +296,10 @@ export default class Point {
     return dataArray && dataArray.length > 0
   }
 
+  /**
+   * Does not need to be implemented by subclass
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   makeDraggable(transitive) {}
 
   toString() {

lib/renderer/default-renderer.js

@@ -154,7 +154,7 @@ export default class DefaultRenderer extends Renderer {
         })
       })
     } else {
-      // if we're returing to 'all-focused' mode
+      // if we're returning to 'all-focused' mode
       // re-focus all internal points
       forEach(graph.edges, (edge) => {
         forEach(edge.pointArray, (point, i) => {
@@ -204,7 +204,7 @@ export default class DefaultRenderer extends Renderer {
         .on('end', () => { if (!--n) this.transitive.refresh() })
     }
 
-    // run the transtions on the affected elements
+    // run the transitions on the affected elements
     forEach(focusChangeSegments, segment => {
       segment.runFocusTransition(this.transitive.display, refreshOnEnd)
     })

lib/renderer/renderededge.js

@@ -194,7 +194,7 @@ export default class RenderedEdge {
 
   /**
    *  Computes the point of intersection between two adjacent, offset RenderedEdges (the
-   *  edge the function is called on and a second egde passed as a parameter)
+   *  edge the function is called on and a second edge passed as a parameter)
    *  by "extending" the adjacent edges and finding the point of intersection. If
    *  such a point exists, the existing renderData arrays for the edges are
    *  adjusted accordingly, as are any associated stops.

lib/renderer/renderer.js

@@ -1,6 +1,3 @@
-// The Renderer class is an abstract class and as such has some empty functions
-/* eslint-disable @typescript-eslint/no-empty-function */
-
 import { forEach } from 'lodash'
 
 /**
@@ -35,15 +32,15 @@ export default class Renderer {
   }
 
   /**
-   * sortElements
+   * Does not need to be implemented by subclass
    */
-
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   sortElements() {}
 
   /**
-   * focusPath
+   * Does not need to be implemented by subclass
    */
-
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   focusPath(path) {}
 
   isDraggable(point) {

lib/styler/styles.js

@@ -34,7 +34,7 @@ const utils = {
 
     return 'url(#' + markerId + ')'
   },
-  fontSize: function (display, data) {
+  fontSize: function (display) {
     return Math.floor(fontScale(display.scale))
   },
   pixels: function (zoom, min, normal, max) {

lib/transitive.ts

@@ -307,7 +307,7 @@ type TransitiveData = {
   stops: Stop[]
   /**
    * A list of street edges in the transportation network that are referenced by
-   * invididual journeys.
+   * individual journeys.
    */
   streetEdges: StreetEdge[]
 }
@@ -338,7 +338,47 @@ type TransitiveStyleComputeFn = (
    * See code: https://github.com/conveyal/transitive.js/blob/6a8932930de003788b9034609697421731e7f812/lib/styler/styles.js#L17-L44
    * FIXME add better typing once other files are typed
    */
-  styleUtils?: unknown
+  styleUtils?: {
+    /**
+     * Creates a svg definition for a marker and returns the string url for the
+     * defined marker
+     */
+    defineSegmentCircleMarker: (
+      /**
+       * The display being used to render transitive
+       */
+      display: unknown,
+      /**
+       * The segment to create a marker for
+       */
+      segment: unknown,
+      /**
+       * The size of the radius that the marker should have
+       */
+      radius: number,
+      /**
+       * The fill color of the marker
+       */
+      fillColor: string
+    ) => string
+    /**
+     * Calculates the font size based on the display's scale
+     */
+    fontSize: (display: unknown) => number
+    /**
+     * Calculates something as it relates to the zoom in relation to zoom
+     */
+    pixels: (
+      zoom: unknown,
+      min: unknown,
+      normal: unknown,
+      max: unknown
+    ) => unknown
+    /**
+     * Calculates a stroke width depending on the display scale
+     */
+    strokeWidth: (display: unknown) => unknown
+  }
 ) => number | string
 
 /**

lib/util/index.js

@@ -183,7 +183,7 @@ function otpModeToGtfsType(otpMode) {
   }
 }
 
-// Rendering utilties
+// Rendering utilities
 
 function renderDataToSvgPath(renderData) {
   return renderData