gtfs-to-chart 2.0.3 → 2.0.5

package/.eslintrc.json

@@ -0,0 +1,28 @@
+{
+  "env": {
+    "node": true,
+    "es2021": true
+  },
+  "extends": ["xo", "prettier"],
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "rules": {
+    "arrow-parens": ["error", "always"],
+    "camelcase": [
+      "error",
+      {
+        "properties": "never"
+      }
+    ],
+    "indent": "off",
+    "object-curly-spacing": ["error", "always"],
+    "no-unused-vars": [
+      "error",
+      {
+        "varsIgnorePattern": "^[A-Z]"
+      }
+    ]
+  }
+}

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx pretty-quick --staged && npm run lint

package/CHANGELOG.md

@@ -4,13 +4,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [2.0.5] - 2022-12-31
+### Updated
+- Update to node-gtfs v4
+- Dependency updates  
+- Add Husky
+
+## [2.0.4] - 2022-11-09
+### Updated
+- Dependency updates
+
+### Fixed
+- Fixed charts path in generated charts HTML
+
+## [2.0.3] - 2022-06-25
 ### Updated
 - Dependency updates
 
 ### Fixed
 - Fixed charts path in generated index.html
 
+## [2.0.2] - 2022-06-25
+### Updated
+- Dependency updates
+- Readme udpates
+
 ## [2.0.1] - 2021-08-17
 ### Updated
 - Dependency updates
@@ -20,4 +38,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [2.0.0] - 2021-05-14
 ### Breaking Changes
-- Converted to ES6 Module
+- Converted to ES6 Module

package/README.md

@@ -9,7 +9,6 @@
   <br /><br />
   <a href="https://www.npmjs.com/package/gtfs-to-chart" rel="nofollow"><img src="https://img.shields.io/npm/v/gtfs-to-chart.svg?style=flat" style="max-width: 100%;"></a>
   <a href="https://www.npmjs.com/package/gtfs-to-chart" rel="nofollow"><img src="https://img.shields.io/npm/dm/gtfs-to-chart.svg?style=flat" style="max-width: 100%;"></a>
-  <a href="https://github.com/BlinkTagInc/gtfs-to-chart/actions?query=workflow%3A%22Node+CI%22"><img src="https://img.shields.io/github/workflow/status/BlinkTagInc/gtfs-to-chart/Node%20CI.svg" alt="CircleCI" style="max-width: 100%;"></a>
   <img src="https://img.shields.io/badge/License-MIT-yellow.svg">
   <br /><br />
   Generate stringline charts from GTFS transit data.
@@ -100,7 +99,7 @@ All files starting with `config*.json` are .gitignored - so you can create multi
 | ------ | ---- | ----------- |
 | [`agencies`](#agencies) | array | An array of GTFS files to be imported. |
 | [`beautify`](#beautify) | boolean | Whether or not to beautify the HTML output. |
-| [`chartDate`](#templatepath) | string | The date to use for generating the stringline chart. |
+| [`chartDate`](#chartdate) | string | The date to use for generating the stringline chart. |
 | [`templatePath`](#templatepath) | string | Path to custom pug template for rendering chart html. |
 
 ### agencies

package/app/routes.js

@@ -24,7 +24,7 @@ openDb(config);
  */
 router.get('/', async (request, response, next) => {
   try {
-    const routes = await getRoutes();
+    const routes = getRoutes();
     const html = await generateOverviewHTML(config, routes);
     response.send(html);
   } catch (error) {

package/lib/gtfs-to-chart.js

@@ -14,7 +14,7 @@ import { formatRouteName } from './formatters.js';
 /*
  * Generate HTML charts from GTFS
  */
-const gtfsToChart = async initialConfig => {
+const gtfsToChart = async (initialConfig) => {
   const config = setDefaultConfig(initialConfig);
   config.log = log(config);
   config.logWarning = logWarning(config);
@@ -25,7 +25,7 @@ const gtfsToChart = async initialConfig => {
     throw new Error('No agencies defined in `config.json`');
   }
 
-  return Promise.all(config.agencies.map(async agency => {
+  return Promise.all(config.agencies.map(async (agency) => {
     const timer = new Timer();
     const agencyKey = agency.agency_key;
     const exportPath = path.join(process.cwd(), 'charts', sanitize(agencyKey));
@@ -45,12 +45,12 @@ const gtfsToChart = async initialConfig => {
 
     await prepDirectory(exportPath);
 
-    const routes = await getRoutes();
+    const routes = getRoutes();
     const bar = progressBar(`${agencyKey}: Generating charts [:bar] :current/:total`, { total: routes.length }, config);
 
     // Make directory if it doesn't exist
     await mkdir(exportPath, { recursive: true });
-    config.assetPath = '';
+    config.assetPath = '../';
 
     /* eslint-disable no-await-in-loop */
     for (const route of routes) {

package/lib/log-utils.js

@@ -36,7 +36,7 @@ export function logWarning(config) {
     return config.logFunction;
   }
 
-  return text => {
+  return (text) => {
     process.stdout.write(`\n${formatWarning(text)}\n`);
   };
 }
@@ -49,7 +49,7 @@ export function logError(config) {
     return config.logFunction;
   }
 
-  return text => {
+  return (text) => {
     process.stdout.write(`\n${formatError(text)}\n`);
   };
 }
@@ -79,20 +79,18 @@ export function progressBar(formatString, barOptions, config) {
 
   if (config.logFunction) {
     let barProgress = 0;
-    const renderProgressString = () => {
-      return formatString
+    const renderProgressString = () => formatString
         .replace(':current', barProgress)
         .replace(':total', barOptions.total)
         .replace('[:bar] ', '');
-    };
 
     config.log(renderProgressString());
 
     return {
-      interrupt: text => {
+      interrupt(text) {
         config.logWarning(text);
       },
-      tick: () => {
+      tick() {
         barProgress += 1;
         config.log(renderProgressString());
       }
@@ -103,10 +101,10 @@ export function progressBar(formatString, barOptions, config) {
   bar.render();
 
   return {
-    interrupt: text => {
+    interrupt(text) {
       bar.interrupt(text);
     },
-    tick: () => {
+    tick() {
       bar.tick();
     }
   };

package/lib/utils.js

@@ -49,12 +49,12 @@ const reverseStationDistances = (stations, oppositeDirectionDistance) => {
 /*
  * Find longest trip
  */
-const findLongestTrip = trips => maxBy(trips, trip => size(trip.stoptimes));
+const findLongestTrip = (trips) => maxBy(trips, (trip) => size(trip.stoptimes));
 
 /*
  * Determine if a stoptime is a timepoint.
  */
-const isTimepoint = stoptime => {
+const isTimepoint = (stoptime) => {
   if (stoptime.timepoint === null) {
     return stoptime.arrival_time !== '' && stoptime.departure_time !== '';
   }
@@ -62,9 +62,9 @@ const isTimepoint = stoptime => {
   return stoptime.timepoint === 1;
 };
 
-const getStationsFromTrip = async trip => {
-  const stops = await Promise.all(trip.stoptimes.map(async stoptime => {
-    const stops = await getStops({
+const getStationsFromTrip = (trip) => {
+  const stops = trip.stoptimes.map((stoptime) => {
+    const stops = getStops({
       stop_id: stoptime.stop_id
     });
 
@@ -73,12 +73,12 @@ const getStationsFromTrip = async trip => {
     }
 
     return stops[0];
-  }));
+  });
 
   let previousStationCoordinates;
   return trip.stoptimes.map((stoptime, index) => {
     const stop = stops[index];
-    const hasShapeDistance = every(trip.stoptimes, stoptime => stoptime.shape_dist_traveled !== null);
+    const hasShapeDistance = every(trip.stoptimes, (stoptime) => stoptime.shape_dist_traveled !== null);
 
     if (!hasShapeDistance) {
       if (index === 0) {
@@ -107,24 +107,20 @@ const getStationsFromTrip = async trip => {
 /*
  * Get all trips and stoptimes for a given route
  */
-const getDataforChart = async (config, routeId) => {
-  const db = await openDb(config);
+const getDataforChart = (config, routeId) => {
+  const db = openDb(config);
   const notes = [];
   const dayOfWeek = moment(config.chartDate, 'YYYYMMDD').format('dddd').toLowerCase();
-  const calendars = await db.all(`SELECT DISTINCT service_id FROM calendar WHERE start_date <= ? AND end_date >= ? AND ${sqlString.escapeId(dayOfWeek)} = 1`, [
-    config.chartDate,
-    config.chartDate
-  ]);
+  const calendars = db.prepare(`SELECT DISTINCT service_id FROM calendar WHERE start_date <= $date AND end_date >= $date AND ${sqlString.escapeId(dayOfWeek)} = 1`).all({ date: config.chartDate });
 
   if (calendars.length === 0) {
     throw new Error(`No calendars found for route ${routeId} on ${moment(config.chartDate, 'YYYYMMDD').format('MMM D, YYYY')}`);
   }
 
-  const serviceIds = calendars.map(calendar => calendar.service_id);
-  const trips = await db.all(`SELECT service_id, trip_id, trip_headsign, direction_id, shape_id FROM trips where route_id = ? AND service_id IN (${serviceIds.map(() => '?').join(', ')})`, [
+  const serviceIds = calendars.map((calendar) => calendar.service_id);
+  const trips = db.prepare(`SELECT service_id, trip_id, trip_headsign, direction_id, shape_id FROM trips where route_id = ? AND service_id IN (${serviceIds.map(() => '?').join(', ')})`).all(
     routeId,
-    ...serviceIds
-  ]);
+    ...serviceIds);
 
   if (trips.length === 0) {
     throw new Error(`No trips found for route ${routeId} on ${moment(config.chartDate, 'YYYYMMDD').format('MMM D, YYYY')}`);
@@ -136,8 +132,8 @@ const getDataforChart = async (config, routeId) => {
     throw new Error('Route has no shapes.');
   }
 
-  await Promise.all(trips.map(async trip => {
-    const stoptimes = await getStoptimes(
+  for (const trip of trips) {
+    const stoptimes = getStoptimes(
       {
         trip_id: trip.trip_id
       },
@@ -153,11 +149,11 @@ const getDataforChart = async (config, routeId) => {
       ]
     );
 
-    trip.stoptimes = stoptimes.filter(stoptime => isTimepoint(stoptime));
-  }));
+    trip.stoptimes = stoptimes.filter((stoptime) => isTimepoint(stoptime));
+  }
 
   const longestTrip = findLongestTrip(trips);
-  let stations = await getStationsFromTrip(longestTrip);
+  let stations = getStationsFromTrip(longestTrip);
   const tripDistance = max(map(stations, 'distance'));
   const directionGroups = groupBy(trips, 'direction_id');
 
@@ -165,13 +161,14 @@ const getDataforChart = async (config, routeId) => {
   if (size(directionGroups) > 1) {
     const oppositeDirection = longestTrip.direction_id === 1 ? '0' : '1';
     const longestTripOppositeDirection = findLongestTrip(directionGroups[oppositeDirection]);
-    const stationsOppositeDirection = await getStationsFromTrip(longestTripOppositeDirection);
+    const stationsOppositeDirection = getStationsFromTrip(longestTripOppositeDirection);
 
     reverseStationDistances(stationsOppositeDirection, tripDistance);
 
     stations = [...stations, ...stationsOppositeDirection];
   }
-  const hasShapeDistance = every(longestTrip.stoptimes, stoptime => stoptime.shape_dist_traveled !== null);
+
+  const hasShapeDistance = every(longestTrip.stoptimes, (stoptime) => stoptime.shape_dist_traveled !== null);
   if (!hasShapeDistance) {
     notes.push('Distance between stops calculated assuming a straight line.');
   }
@@ -201,7 +198,7 @@ export function setDefaultConfig(initialConfig) {
  * Generate the HTML for the agency overview page.
  */
 export async function generateOverviewHTML(config, routes) {
-  const agencies = await getAgencies();
+  const agencies = getAgencies();
   if (agencies.length === 0) {
     throw new Error('No agencies found');
   }
@@ -215,7 +212,7 @@ export async function generateOverviewHTML(config, routes) {
   const templateVars = {
     agency,
     config,
-    routes: sortBy(routes, r => Number.parseInt(r.route_short_name, 10))
+    routes: sortBy(routes, (r) => Number.parseInt(r.route_short_name, 10))
   };
   return renderTemplate('overview_page', templateVars, config);
 }
@@ -224,7 +221,7 @@ export async function generateOverviewHTML(config, routes) {
  * Generate the HTML for a chart.
  */
 export async function generateChartHTML(config, routeId) {
-  const routes = await getRoutes({
+  const routes = getRoutes({
     route_id: routeId
   });
 
@@ -232,7 +229,7 @@ export async function generateChartHTML(config, routeId) {
     throw new Error('Invalid route id provided');
   }
 
-  const chartData = await getDataforChart(config, routeId);
+  const chartData = getDataforChart(config, routeId);
 
   return renderTemplate('chart_page', {
     route: routes[0],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-chart",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "private": false,
   "description": "Generate stringline charts of a transit routes from GTFS",
   "keywords": [
@@ -24,30 +24,15 @@
   },
   "scripts": {
     "start": "node ./app",
-    "test": "xo"
-  },
-  "xo": {
-    "esnext": true,
-    "rules": {
-      "camelcase": [
-        "error",
-        {
-          "properties": "never"
-        }
-      ],
-      "object-curly-spacing": [
-        "error",
-        "always"
-      ]
-    },
-    "space": true
+    "lint": "eslint app/**/*.js lib/**/*.js public/**/*.js --fix",
+    "prepare": "husky install"
   },
   "dependencies": {
     "better-copy": "^1.0.4",
-    "chalk": "^5.1.2",
+    "chalk": "^5.2.0",
     "connect-slashes": "^1.4.0",
     "express": "^4.18.2",
-    "gtfs": "^3.6.0",
+    "gtfs": "^4.0.1",
     "js-beautify": "^1.14.7",
     "lodash-es": "^4.17.21",
     "moment": "^2.29.4",
@@ -59,13 +44,30 @@
     "sqlstring": "^2.3.3",
     "timer-machine": "^1.1.0",
     "untildify": "^4.0.0",
-    "yargs": "^17.6.0"
+    "yargs": "^17.6.2"
   },
   "devDependencies": {
-    "xo": "^0.52.4"
+    "eslint": "^8.31.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-xo": "^0.43.1",
+    "husky": "^7.0.0",
+    "prettier": "^2.8.1",
+    "pretty-quick": "^3.1.3"
   },
   "engines": {
     "node": ">= 14.x"
   },
-  "false": {}
+  "release-it": {
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/keep-a-changelog": {
+        "filename": "CHANGELOG.md"
+      }
+    }
+  },
+  "prettier": {
+    "singleQuote": true
+  }
 }

package/public/js/chart.js

@@ -15,9 +15,8 @@ function padTimeRange(range) {
 }
 
 function geStopsFromStoptimes(stoptimes, stations) {
-  /* eslint-disable-next-line unicorn/no-array-reduce */
   return stoptimes.reduce((memo, stoptime) => {
-    const station = stations.find(station => station.stop_id === stoptime.stop_id);
+    const station = stations.find((station) => station.stop_id === stoptime.stop_id);
     if (stoptime.arrival_time === stoptime.departure_time) {
       memo.push({
         station,
@@ -58,7 +57,7 @@ function formatStopTime(stop) {
 
 function getPrimaryDirectionId(stations) {
   const directionGroups = _.groupBy(stations, 'direction_id');
-  const largestDirectionGroup = _.maxBy(Object.values(directionGroups), group => group.length);
+  const largestDirectionGroup = _.maxBy(Object.values(directionGroups), (group) => group.length);
   return largestDirectionGroup[0].direction_id;
 }
 
@@ -68,85 +67,85 @@ function renderChart(data) {
     stations
   } = data;
 
-  const formattedTrips = trips.map(trip => ({
+  const formattedTrips = trips.map((trip) => ({
     number: trip.trip_id,
     direction: trip.direction_id,
     trip_headsign: trip.trip_headsign,
     stops: geStopsFromStoptimes(trip.stoptimes, stations)
   }));
 
-  const stops = formattedTrips.flatMap(trip => trip.stops.map(stop => ({
+  const stops = formattedTrips.flatMap((trip) => trip.stops.map((stop) => ({
     trip,
     stop
   })));
 
   const height = 2400;
   const width = 800;
-  const topMargin = 20 + (_.max(_.map(stations, station => station.name.length)) * 4.6);
+  const topMargin = 20 + (_.max(_.map(stations, (station) => station.name.length)) * 4.6);
   const margin = ({ top: topMargin, right: 30, bottom: topMargin, left: 50 });
 
   const primaryDirectionId = getPrimaryDirectionId(stations);
 
   const line = d3.line()
-    .x(d => x(d.station.distance))
-    .y(d => y(d.time));
+    .x((d) => x(d.station.distance))
+    .y((d) => y(d.time));
 
   const x = d3.scaleLinear()
-    .domain(d3.extent(stations, d => d.distance))
+    .domain(d3.extent(stations, (d) => d.distance))
     .range([margin.left + 10, width - margin.right]);
 
   const y = d3.scaleUtc()
-    .domain(padTimeRange(d3.extent(stops, s => s.stop.time)))
+    .domain(padTimeRange(d3.extent(stops, (s) => s.stop.time)))
     .range([margin.top, height - margin.bottom]);
 
-  const xAxis = g => g
+  const xAxis = (g) => g
     .style('font', '10px sans-serif')
     .selectAll('g')
     .data(stations)
     .join('g')
-    .attr('transform', d => `translate(${x(d.distance)},0)`)
-    .call(g => g.append('line')
+    .attr('transform', (d) => `translate(${x(d.distance)},0)`)
+    .call((g) => g.append('line')
       .attr('y1', margin.top - 6)
       .attr('y2', margin.top)
       .attr('stroke', 'currentColor'))
-    .call(g => g.append('line')
+    .call((g) => g.append('line')
       .attr('y1', height - margin.bottom + 6)
       .attr('y2', height - margin.bottom)
       .attr('stroke', 'currentColor'))
-    .call(g => g.append('line')
+    .call((g) => g.append('line')
       .attr('y1', margin.top)
       .attr('y2', height - margin.bottom)
       .attr('stroke-opacity', 0.2)
       .attr('stroke-dasharray', '1.5,2')
       .attr('stroke', 'currentColor'))
-    .call(g => g.append('text')
+    .call((g) => g.append('text')
       .attr('transform', `translate(0,${margin.top}) rotate(-90)`)
       .attr('x', 12)
       .attr('dy', '0.35em')
-      .text(d => d.name))
-    .style('display', d => d.direction_id === primaryDirectionId ? 'block' : 'none')
-    .call(g => g.append('text')
+      .text((d) => d.name))
+    .style('display', (d) => d.direction_id === primaryDirectionId ? 'block' : 'none')
+    .call((g) => g.append('text')
       .attr('text-anchor', 'end')
       .attr('transform', `translate(0,${height - margin.top}) rotate(-90)`)
       .attr('x', -12)
       .attr('dy', '0.35em')
-      .text(d => d.name));
+      .text((d) => d.name));
 
-  const yAxis = g => g
+  const yAxis = (g) => g
     .attr('transform', `translate(${margin.left},0)`)
     .call(d3.axisLeft(y)
       .ticks(d3.utcHour)
       .tickFormat(d3.utcFormat('%-I %p')))
-    .call(g => g.select('.domain').remove())
-    .call(g => g.selectAll('.tick line').clone().lower()
+    .call((g) => g.select('.domain').remove())
+    .call((g) => g.selectAll('.tick line').clone().lower()
       .attr('stroke-opacity', 0.2)
       .attr('x2', width));
 
   const voronoi = d3.Delaunay
-    .from(stops, d => x(d.stop.station.distance), d => y(d.stop.time))
+    .from(stops, (d) => x(d.stop.station.distance), (d) => y(d.stop.time))
     .voronoi([0, 0, width, height]);
 
-  const tooltip = g => {
+  const tooltip = (g) => {
     const tooltip = g.append('g')
       .style('font', '10px sans-serif');
 
@@ -176,7 +175,7 @@ function renderChart(data) {
       .join('path')
       .attr('d', (d, i) => voronoi.renderCell(i))
       .on('mouseout', () => tooltip.style('display', 'none'))
-      .on('mouseover', d => {
+      .on('mouseover', (d) => {
         tooltip.style('display', null);
         line1.text(`Trip ${d.trip.number} to ${d.trip.trip_headsign}`);
         line2.text(d.stop.station.name);
@@ -216,16 +215,16 @@ function renderChart(data) {
 
   vehicle.append('path')
     .attr('fill', 'none')
-    .attr('stroke', d => 'rgb(34, 34, 34)')
-    .attr('d', d => line(d.stops));
+    .attr('stroke', (d) => 'rgb(34, 34, 34)')
+    .attr('d', (d) => line(d.stops));
 
   vehicle.append('g')
     .attr('stroke', 'white')
-    .attr('fill', d => 'rgb(34, 34, 34)')
+    .attr('fill', (d) => 'rgb(34, 34, 34)')
     .selectAll('circle')
-    .data(d => d.stops)
+    .data((d) => d.stops)
     .join('circle')
-    .attr('transform', d => `translate(${x(d.station.distance)},${y(d.time)})`)
+    .attr('transform', (d) => `translate(${x(d.station.distance)},${y(d.time)})`)
     .attr('r', 2.5);
 
   svg.append('g')