refactor: improve syntax and comments to address PR review

See #72

Author: evansiroky

Diff for: lib/core/network.js

@@ -148,8 +148,9 @@ export default class Network {
     const turnLookup = {}
     const addTurn = function (turn1, turn2) {
       if (!(turn1.getId() in turnLookup)) turnLookup[turn1.getId()] = []
-      if (turnLookup[turn1.getId()].indexOf(turn2) === -1)
+      if (turnLookup[turn1.getId()].indexOf(turn2) === -1) {
         turnLookup[turn1.getId()].push(turn2)
+      }
     }
     forEach(Object.values(this.streetEdges), (streetEdge) => {
       if (streetEdge.fromTurnPoint && streetEdge.toTurnPoint) {
@@ -341,8 +342,9 @@ export default class Network {
 
   addStopAdjacency(stopIdA, stopIdB) {
     if (!this.adjacentStops[stopIdA]) this.adjacentStops[stopIdA] = []
-    if (this.adjacentStops[stopIdA].indexOf(stopIdB) === -1)
+    if (this.adjacentStops[stopIdA].indexOf(stopIdB) === -1) {
       this.adjacentStops[stopIdA].push(stopIdB)
+    }
   }
 
   /**
@@ -452,10 +454,12 @@ export default class Network {
                   toVertex,
                   segment.getType()
                 )
-                if (geomCoords && geomCoords.length > 0)
+                if (geomCoords && geomCoords.length > 0) {
                   edge.geomCoords = geomCoords
-                if (pointGeom && pointGeom.length > 0)
+                }
+                if (pointGeom && pointGeom.length > 0) {
                   edge.pointGeom = pointGeom
+                }
               }
 
               // associate the graph edge and path segment with each other
@@ -525,10 +529,11 @@ export default class Network {
             pathSegment.points[0].isBoardPoint = true
 
             // if there are additional transit segments, mark the 'to' endpoint as a transfer point
-            if (transitSegments.length > 1)
+            if (transitSegments.length > 1) {
               pathSegment.points[
                 pathSegment.points.length - 1
               ].isTransferPoint = true
+            }
 
             // if last transit segment in path, mark 'to' endpoint as alight point
           } else if (
@@ -540,8 +545,9 @@ export default class Network {
             ].isAlightPoint = true
 
             // if there are additional transit segments, mark the 'from' endpoint as a transfer point
-            if (transitSegments.length > 1)
+            if (transitSegments.length > 1) {
               pathSegment.points[0].isTransferPoint = true
+            }
 
             // if this is an 'internal' transit segment, mark both endpoints as transfer points
           } else if (transitSegments.length > 2) {

Diff for: lib/core/pathsegment.js

@@ -120,8 +120,9 @@ export default class PathSegment {
   }
 
   endVertex() {
-    if (this.points[this.points.length - 1].multipoint)
+    if (this.points[this.points.length - 1].multipoint) {
       return this.points[this.points.length - 1].multipoint.graphVertex
+    }
     if (!this.edges || this.edges.length === 0) return null
 
     const lastGraphEdge = this.edges[this.edges.length - 1].graphEdge

Diff for: lib/display/canvas-display.js

@@ -132,8 +132,9 @@ export default class CanvasDisplay extends Display {
 
     if (attrs.stroke) {
       this.ctx.strokeStyle = attrs.stroke
-      if (attrs['stroke-opacity'])
+      if (attrs['stroke-opacity']) {
         this.ctx.globalAlpha = attrs['stroke-opacity']
+      }
       this.ctx.lineWidth = attrs['stroke-width'] || 1
       this.ctx.strokeText(text, anchor.x, anchor.y)
     }

Diff for: lib/graph/edge.js

@@ -817,10 +817,12 @@ export default class Edge {
     if (
       this.fromVertex === edge.fromVertex ||
       this.fromVertex === edge.toVertex
-    )
+    ) {
       return this.fromVertex
-    if (this.toVertex === edge.fromVertex || this.toVertex === edge.toVertex)
+    }
+    if (this.toVertex === edge.fromVertex || this.toVertex === edge.toVertex) {
       return this.toVertex
+    }
     return null
   }
 
@@ -829,8 +831,9 @@ export default class Edge {
    */
 
   setPointLabelPosition(pos, skip) {
-    if (this.fromVertex.point !== skip)
+    if (this.fromVertex.point !== skip) {
       this.fromVertex.point.labelPosition = pos
+    }
     if (this.toVertex.point !== skip) this.toVertex.point.labelPosition = pos
 
     forEach(this.pointArray, (point) => {

Diff for: lib/graph/graph.js

@@ -28,8 +28,9 @@ export default class NetworkGraph {
     this.edgeGroups = {}
 
     // Add all base vertices
-    for (const i in vertices)
+    for (const i in vertices) {
       this.addVertex(vertices[i], vertices[i].worldX, vertices[i].worldY)
+    }
   }
 
   /**
@@ -162,8 +163,9 @@ export default class NetworkGraph {
       (vertexGroups.STOP.length > 0 && vertexGroups.PLACE.length > 0) ||
       vertexGroups.PLACE.length > 1 ||
       vertexGroups.MULTI.length > 0
-    )
+    ) {
       return
+    }
 
     let mergePoint
 
@@ -369,8 +371,9 @@ export default class NetworkGraph {
 
       forEach(vertex.edges, (edge) => {
         const pathSegmentIds = edge.getPathSegmentIds()
-        if (!(pathSegmentIds in pathSegmentBundles))
+        if (!(pathSegmentIds in pathSegmentBundles)) {
           pathSegmentBundles[pathSegmentIds] = []
+        }
         pathSegmentBundles[pathSegmentIds].push(edge)
         const opp = edge.oppositeVertex(vertex)
         if (opposites.indexOf(opp) === -1) opposites.push(opp)

Diff for: lib/labeler/label.js

@@ -32,8 +32,9 @@ export default class Label {
   refresh(display) {}
 
   setVisibility(visibility) {
-    if (this.svgGroup)
+    if (this.svgGroup) {
       this.svgGroup.attr('display', visibility ? 'initial' : 'none')
+    }
   }
 
   getBBox() {

Diff for: lib/labeler/labeler.js

@@ -152,8 +152,9 @@ export default class Labeler {
       bbox.x - bbox.width / 2 > this.width ||
       bbox.y + bbox.height / 2 < 0 ||
       bbox.y - bbox.height / 2 > this.height
-    )
+    ) {
       return
+    }
 
     this.quadtree.add([bbox.x + bbox.width / 2, bbox.y + bbox.height / 2, bbox])
 
@@ -264,8 +265,9 @@ export default class Labeler {
     const busRSegments = []
     forEach(this.transitive.network.paths, (path) => {
       forEach(path.getRenderedSegments(), (rSegment) => {
-        if (rSegment.type === 'TRANSIT' && rSegment.mode === 3)
+        if (rSegment.type === 'TRANSIT' && rSegment.mode === 3) {
           busRSegments.push(rSegment)
+        }
       })
     })
 

Diff for: lib/point/multipoint.js

@@ -45,8 +45,9 @@ export default class MultiPoint extends Point {
     let shortest = null
     forEach(this.points, (point) => {
       if (point.getType() === 'TURN') return
-      if (!shortest || point.getName().length < shortest.length)
+      if (!shortest || point.getName().length < shortest.length) {
         shortest = point.getName()
+      }
     })
 
     return shortest
@@ -135,8 +136,9 @@ export default class MultiPoint extends Point {
    */
 
   addRenderData(pointInfo) {
-    if (pointInfo.offsetX !== 0 || pointInfo.offsetY !== 0)
+    if (pointInfo.offsetX !== 0 || pointInfo.offsetY !== 0) {
       this.hasOffsetPoints = true
+    }
     this.renderData.push(pointInfo)
   }
 

Diff for: lib/renderer/renderededge.js

@@ -205,8 +205,9 @@ export default class RenderedEdge {
     if (
       this.graphEdge.renderedEdges.length !==
       rEdge.graphEdge.renderedEdges.length
-    )
+    ) {
       return
+    }
 
     const commonVertex = this.graphEdge.commonVertex(rEdge.graphEdge)
     if (!commonVertex || commonVertex.point.isSegmentEndPoint) return

Diff for: lib/transitive.ts

@@ -117,7 +117,6 @@ type Journey = {
    */
   journey_name: string
   /**
-   * What is this?
    * The segments of a journey
    */
   segments: Segment[]
@@ -382,7 +381,7 @@ type TransitiveStyleComputeFn = (
 ) => number | string
 
 /**
- * A map describing a styling override applied to a particular styleing value
+ * A map describing a styling override applied to a particular styling value
  * noted with the key value. The value for this style can be either a number,
  * string or result of a custom function.
  *
@@ -604,7 +603,7 @@ export default class Transitive {
   display!: CanvasDisplay | SvgDisplay
   el?: HTMLElement
   // FIXME: somehow typing the emit method (which is injected at the end of this
-  // file by component-emitter causes the emit method to not work.
+  // file by component-emitter) causes the emit method to not work.
   // emit!: (message: string, transitiveInstance: this, el?: HTMLElement) => void
   labeler!: Labeler
   options?: TransitiveOptions
@@ -645,7 +644,6 @@ export default class Transitive {
   /**
    * Clear the Network data and redraw the (empty) map
    */
-
   clearData() {
     this.network = this.data = null
     this.labeler.clear()
@@ -656,7 +654,6 @@ export default class Transitive {
   /**
    * Update the Network data and redraw the map
    */
-
   updateData(data: TransitiveData, resetDisplay?: boolean) {
     this.network = null
     this.data = data
@@ -672,7 +669,6 @@ export default class Transitive {
    *
    * @param {String} an OTP mode string
    */
-
   getModeStyles(mode: string) {
     return this.styler.getModeStyles(mode, this.display || new Display(this))
   }
@@ -682,7 +678,6 @@ export default class Transitive {
   /**
    * Set the DOM element that serves as the main map canvas
    */
-
   setElement(el?: HTMLElement) {
     if (this.el) d3.select(this.el).selectAll('*').remove()
 
@@ -696,7 +691,6 @@ export default class Transitive {
   /**
    * Set the DOM element that serves as the main map canvas
    */
-
   setRenderer(type: RendererType) {
     switch (type) {
       case 'wireframe':
@@ -711,7 +705,6 @@ export default class Transitive {
   /**
    * Render
    */
-
   render() {
     if (!this.network) {
       this.network = new Network(this, this.data)
@@ -732,7 +725,6 @@ export default class Transitive {
    *
    * @param {Element} el
    */
-
   renderTo(el: HTMLElement) {
     this.setElement(el)
     this.render()
@@ -745,7 +737,6 @@ export default class Transitive {
   /**
    * focusJourney
    */
-
   focusJourney(journeyId: string) {
     if (!this.network) {
       console.warn('Transitive network is not defined! Cannot focus journey!')
@@ -760,7 +751,6 @@ export default class Transitive {
    * Sets the Display bounds
    * @param {Array} lon/lat bounds expressed as [[west, south], [east, north]]
    */
-
   setDisplayBounds(llBounds: Bounds) {
     if (!this.display) return
     const smWestSouth = sm.forward(llBounds[0])
@@ -780,7 +770,6 @@ export default class Transitive {
    * Gets the Network bounds
    * @returns {Array} lon/lat bounds expressed as [[west, south], [east, north]]
    */
-
   getNetworkBounds() {
     if (!this.network || !this.network.graph) return null
     const graphBounds = this.network.graph.bounds()
@@ -795,7 +784,6 @@ export default class Transitive {
   /**
    * resize
    */
-
   resize(width: number, height: number) {
     if (!this.display) return
     // @ts-expect-error I have no idea what magic this display object uses to
@@ -811,7 +799,6 @@ export default class Transitive {
   /**
    * trigger a display resize action (for externally-managed SVG containers)
    */
-
   resized(width: number, height: number) {
     // @ts-expect-error I have no idea what magic this display object uses to
     // get a resized method. - Evan :(

Diff for: lib/util/index.js

@@ -189,10 +189,11 @@ function renderDataToSvgPath(renderData) {
   return renderData
     .map((d, k) => {
       if (k === 0) return `M${d.x} ${d.y}`
-      if (d.arc)
+      if (d.arc) {
         return `A${d.radius} ${d.radius} ${d.arc} 0 ${d.arc > 0 ? 0 : 1} ${
           d.x
         } ${d.y}`
+      }
       return `L${d.x} ${d.y}`
     })
     .join(' ')