gtfs-to-html 2.5.6 → 2.5.8

package/CHANGELOG.md

@@ -5,6 +5,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).
 
+## [2.5.8] - 2024-01-02
+
+### Fixed
+
+- Improved warning logging
+
+### Added
+
+- Handle case where a calendar_date is both included and excluded
+
+### Updated
+
+- Dependency updates
+
+## [2.5.7] - 2023-11-07
+
+### Updated
+
+- Dependency updates
+- Docusaurus 3.0 for documentation site
+
+### Added
+
+- Add is_timepoint value to each stop
+
 ## [2.5.6] - 2023-08-23
 
 ### Updated

package/lib/formatters.js

@@ -20,6 +20,7 @@ import {
   toGTFSTime,
   updateTimeByOffset,
 } from './time-utils.js';
+import { isTimepoint } from './utils.js';
 
 /*
  * Replace all instances in a string with items from an object.
@@ -141,13 +142,13 @@ function filterHourlyTimes(stops) {
     time,
   }));
   const sortedFirstStopTimesAndIndex = sortBy(firstStopTimesAndIndex, (item) =>
-    Number.parseInt(item.time.format('m'), 10)
+    Number.parseInt(item.time.format('m'), 10),
   );
 
   // Filter and arrange stoptimes for all stops based on sort.
   return stops.map((stop) => {
     stop.hourlyTimes = sortedFirstStopTimesAndIndex.map((item) =>
-      fromGTFSTime(stop.trips[item.idx].arrival_time).format(':mm')
+      fromGTFSTime(stop.trips[item.idx].arrival_time).format(':mm'),
     );
 
     return stop;
@@ -234,7 +235,7 @@ export function formatTrip(trip, timetable, calendars, config) {
     trip.route_short_name = timetable.routes[0].route_short_name;
   } else {
     const route = timetable.routes.find(
-      (route) => route.route_id === trip.route_id
+      (route) => route.route_id === trip.route_id,
     );
     trip.route_short_name = route.route_short_name;
   }
@@ -274,7 +275,7 @@ export function formatFrequency(frequency, config) {
  */
 export function formatTimetableId(timetable) {
   let timetableId = `${timetable.route_ids.join('_')}|${calendarToCalendarCode(
-    timetable
+    timetable,
   )}`;
   if (!isNullOrEmpty(timetable.direction_id)) {
     timetableId += `|${timetable.direction_id}`;
@@ -328,7 +329,7 @@ export function formatStops(timetable, config) {
         const departureStoptime = clone(stoptime);
         departureStoptime.type = 'departure';
         timetable.stops[stopIndex + 1].trips.push(
-          formatStopTime(departureStoptime, timetable, config)
+          formatStopTime(departureStoptime, timetable, config),
         );
       }
 
@@ -343,8 +344,13 @@ export function formatStops(timetable, config) {
     for (const stop of timetable.stops) {
       const lastStopTime = last(stop.trips);
       if (!lastStopTime || lastStopTime.trip_id !== trip.trip_id) {
-        const emptyStoptime = createEmptyStoptime(stop.stop_id, trip.trip_id);
-        stop.trips.push(formatStopTime(emptyStoptime, timetable, config));
+        stop.trips.push(
+          formatStopTime(
+            createEmptyStoptime(stop.stop_id, trip.trip_id),
+            timetable,
+            config,
+          ),
+        );
       }
     }
   }
@@ -353,6 +359,10 @@ export function formatStops(timetable, config) {
     timetable.stops = filterHourlyTimes(timetable.stops);
   }
 
+  for (const stop of timetable.stops) {
+    stop.is_timepoint = stop.trips.some((stoptime) => isTimepoint(stoptime));
+  }
+
   return timetable.stops;
 }
 
@@ -393,15 +403,18 @@ export function formatTripContinuesAs(trip) {
  */
 export function resetStoptimesToMidnight(trip) {
   const offsetSeconds = secondsAfterMidnight(
-    first(trip.stoptimes).departure_time
+    first(trip.stoptimes).departure_time,
   );
   if (offsetSeconds > 0) {
     for (const stoptime of trip.stoptimes) {
       stoptime.departure_time = toGTFSTime(
-        fromGTFSTime(stoptime.departure_time).subtract(offsetSeconds, 'seconds')
+        fromGTFSTime(stoptime.departure_time).subtract(
+          offsetSeconds,
+          'seconds',
+        ),
       );
       stoptime.arrival_time = toGTFSTime(
-        fromGTFSTime(stoptime.arrival_time).subtract(offsetSeconds, 'seconds')
+        fromGTFSTime(stoptime.arrival_time).subtract(offsetSeconds, 'seconds'),
       );
     }
   }
@@ -418,11 +431,11 @@ export function updateStoptimesByOffset(trip, offsetSeconds) {
     delete stoptime._id;
     stoptime.departure_time = updateTimeByOffset(
       stoptime.departure_time,
-      offsetSeconds
+      offsetSeconds,
     );
     stoptime.arrival_time = updateTimeByOffset(
       stoptime.arrival_time,
-      offsetSeconds
+      offsetSeconds,
     );
     stoptime.trip_id = trip.trip_id;
     return stoptime;
@@ -483,9 +496,9 @@ export function formatTimetablePageLabel(timetablePage) {
     const routes = uniqBy(
       flatMap(
         timetablePage.consolidatedTimetables,
-        (timetable) => timetable.routes
+        (timetable) => timetable.routes,
       ),
-      'route_id'
+      'route_id',
     );
     const timetablePageLabel = routes.map((route) => formatRouteName(route));
 
@@ -509,7 +522,7 @@ export function mergeTimetablesWithSameId(timetables) {
     const mergedTimetable = omit(timetableGroup[0], 'route_id');
 
     mergedTimetable.route_ids = timetableGroup.map(
-      (timetable) => timetable.route_id
+      (timetable) => timetable.route_id,
     );
 
     return mergedTimetable;

package/lib/gtfs-to-html.js

@@ -51,7 +51,7 @@ const gtfsToHtml = async (initialConfig) => {
   } catch (error) {
     if (error instanceof Error && error.code === 'SQLITE_CANTOPEN') {
       config.logError(
-        `Unable to open sqlite database "${config.sqlitePath}" defined as \`sqlitePath\` config.json. Ensure the parent directory exists or remove \`sqlitePath\` from config.json.`
+        `Unable to open sqlite database "${config.sqlitePath}" defined as \`sqlitePath\` config.json. Ensure the parent directory exists or remove \`sqlitePath\` from config.json.`,
       );
     }
 
@@ -84,7 +84,7 @@ const gtfsToHtml = async (initialConfig) => {
   const timetablePages = [];
   const timetablePageIds = map(
     getTimetablePagesForAgency(config),
-    'timetable_page_id'
+    'timetable_page_id',
   );
   await prepDirectory(exportPath);
 
@@ -95,7 +95,7 @@ const gtfsToHtml = async (initialConfig) => {
   const bar = progressBar(
     `${agencyKey}: Generating ${config.outputFormat.toUpperCase()} timetables {bar} {value}/{total}`,
     timetablePageIds.length,
-    config
+    config,
   );
 
   /* eslint-disable no-await-in-loop */
@@ -103,15 +103,9 @@ const gtfsToHtml = async (initialConfig) => {
     try {
       const timetablePage = await getFormattedTimetablePage(
         timetablePageId,
-        config
+        config,
       );
 
-      if (timetablePage.consolidatedTimetables.length === 0) {
-        throw new Error(
-          `No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`
-        );
-      }
-
       for (const timetable of timetablePage.timetables) {
         for (const warning of timetable.warnings) {
           outputStats.warnings.push(warning);
@@ -119,6 +113,12 @@ const gtfsToHtml = async (initialConfig) => {
         }
       }
 
+      if (timetablePage.consolidatedTimetables.length === 0) {
+        throw new Error(
+          `No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`,
+        );
+      }
+
       outputStats.timetables += timetablePage.consolidatedTimetables.length;
       outputStats.timetablePages += 1;
 
@@ -130,7 +130,7 @@ const gtfsToHtml = async (initialConfig) => {
 
       timetablePage.relativePath = path.join(
         datePath,
-        sanitize(timetablePage.filename)
+        sanitize(timetablePage.filename),
       );
 
       if (config.outputFormat === 'csv') {
@@ -139,7 +139,7 @@ const gtfsToHtml = async (initialConfig) => {
           const csvPath = path.join(
             exportPath,
             datePath,
-            generateCSVFileName(timetable, timetablePage)
+            generateCSVFileName(timetable, timetablePage),
           );
           await writeFile(csvPath, csv);
         }
@@ -148,7 +148,7 @@ const gtfsToHtml = async (initialConfig) => {
         const htmlPath = path.join(
           exportPath,
           datePath,
-          sanitize(timetablePage.filename)
+          sanitize(timetablePage.filename),
         );
         await writeFile(htmlPath, html);
 
@@ -192,19 +192,19 @@ const gtfsToHtml = async (initialConfig) => {
 
   const fullExportPath = path.join(
     exportPath,
-    config.zipOutput ? '/timetables.zip' : ''
+    config.zipOutput ? '/timetables.zip' : '',
   );
 
   // Print stats
   config.log(
-    `${agencyKey}: ${config.outputFormat.toUpperCase()} timetables created at ${fullExportPath}`
+    `${agencyKey}: ${config.outputFormat.toUpperCase()} timetables created at ${fullExportPath}`,
   );
 
   logStats(outputStats, config);
 
   const seconds = Math.round(timer.time() / 1000);
   config.log(
-    `${agencyKey}: ${config.outputFormat.toUpperCase()} timetable generation required ${seconds} seconds`
+    `${agencyKey}: ${config.outputFormat.toUpperCase()} timetable generation required ${seconds} seconds`,
   );
 
   timer.stop();

package/lib/log-utils.js

@@ -110,7 +110,7 @@ export function formatError(error) {
   const messageText = error instanceof Error ? error.message : error;
   const errorMessage = `${colors.underline('Error')}: ${messageText.replace(
     'Error: ',
-    ''
+    '',
   )}`;
   return colors.red(errorMessage);
 }
@@ -136,7 +136,7 @@ export function logStats(stats, config) {
     ['🔄 Routes', stats.routes],
     ['🚍 Trips', stats.trips],
     ['🛑 Stops', stats.stops],
-    ['⛔️ Warnings', stats.warnings.length]
+    ['⛔️ Warnings', stats.warnings.length],
   );
 
   config.log(table.toString());
@@ -209,7 +209,7 @@ export function progressBar(formatString, barTotal, config) {
     interrupt(text) {
       // Log two lines to avoid overwrite by progress bar
       config.logWarning(text);
-      config.logWarning('');
+      config.log('');
     },
     increment() {
       barProgress += 1;

package/lib/utils.js

@@ -86,7 +86,7 @@ const { version } = JSON.parse(
 /*
  * Determine if a stoptime is a timepoint.
  */
-const isTimepoint = (stoptime) => {
+export const isTimepoint = (stoptime) => {
   if (isNullOrEmpty(stoptime.timepoint)) {
     return (
       !isNullOrEmpty(stoptime.arrival_time) &&
@@ -101,13 +101,15 @@ const isTimepoint = (stoptime) => {
  * Find the longest trip (most stops) in a group of trips and return stoptimes.
  */
 const getLongestTripStoptimes = (trips, config) => {
-  // If `showOnlyTimepoint` is true, then filter out all non-timepoints.
-  const filteredTripStoptimes =
-    config.showOnlyTimepoint === true
-      ? trips.map((trip) =>
-          trip.stoptimes.filter((stoptime) => isTimepoint(stoptime)),
-        )
-      : trips.map((trip) => trip.stoptimes);
+  const filteredTripStoptimes = trips.map((trip) =>
+    trip.stoptimes.filter((stoptime) => {
+      // If `showOnlyTimepoint` is true, then filter out all non-timepoints.
+      if (config.showOnlyTimepoint === true) {
+        return isTimepoint(stoptime);
+      }
+      return true;
+    }),
+  );
 
   return maxBy(filteredTripStoptimes, (stoptimes) => size(stoptimes));
 };
@@ -290,26 +292,32 @@ const getCalendarDatesForTimetable = (timetable, config) => {
   );
   const start = fromGTFSDate(timetable.start_date);
   const end = fromGTFSDate(timetable.end_date);
-  const filteredCalendarDates = {
-    excludedDates: [],
-    includedDates: [],
-  };
+  const excludedDates = [];
+  const includedDates = [];
 
   for (const calendarDate of calendarDates) {
     if (moment(calendarDate.date, 'YYYYMMDD').isBetween(start, end)) {
       if (calendarDate.exception_type === 1) {
-        filteredCalendarDates.includedDates.push(
-          formatDate(calendarDate, config.dateFormat),
-        );
+        includedDates.push(formatDate(calendarDate, config.dateFormat));
       } else if (calendarDate.exception_type === 2) {
-        filteredCalendarDates.excludedDates.push(
-          formatDate(calendarDate, config.dateFormat),
-        );
+        excludedDates.push(formatDate(calendarDate, config.dateFormat));
       }
     }
   }
 
-  return filteredCalendarDates;
+  // Remove dates that are both included and excluded from both lists
+  const includedAndExcludedDates = excludedDates.filter((date) =>
+    includedDates.includes(date),
+  );
+
+  return {
+    excludedDates: excludedDates.filter(
+      (date) => !includedAndExcludedDates.includes(date),
+    ),
+    includedDates: includedDates.filter(
+      (date) => !includedAndExcludedDates.includes(date),
+    ),
+  };
 };
 
 /*
@@ -674,13 +682,15 @@ const getStopOrder = (timetable, config) => {
     const stopGraph = [];
 
     for (const trip of timetable.orderedTrips) {
-      // If `showOnlyTimepoint` is true, then filter out all non-timepoints.
-      const sortedStopIds =
-        config.showOnlyTimepoint === true
-          ? trip.stoptimes
-              .filter((stoptime) => isTimepoint(stoptime))
-              .map((stoptime) => stoptime.stop_id)
-          : trip.stoptimes.map((stoptime) => stoptime.stop_id);
+      const sortedStopIds = trip.stoptimes
+        .filter((stoptime) => {
+          // If `showOnlyTimepoint` is true, then filter out all non-timepoints.
+          if (config.showOnlyTimepoint === true) {
+            return isTimepoint(stoptime);
+          }
+          return true;
+        })
+        .map((stoptime) => stoptime.stop_id);
 
       for (const [index, stopId] of sortedStopIds.entries()) {
         if (index === sortedStopIds.length - 1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-html",
-  "version": "2.5.6",
+  "version": "2.5.8",
   "private": false,
   "description": "Build human readable transit timetables as HTML, PDF or CSV from GTFS",
   "keywords": [
@@ -37,19 +37,19 @@
   "dependencies": {
     "@turf/helpers": "^6.5.0",
     "@turf/simplify": "^6.5.0",
-    "archiver": "^6.0.0",
+    "archiver": "^6.0.1",
     "cli-table": "^0.3.11",
     "copy-dir": "^1.3.0",
-    "csv-stringify": "^6.4.0",
+    "csv-stringify": "^6.4.5",
     "express": "^4.18.2",
-    "gtfs": "^4.5.0",
-    "js-beautify": "^1.14.9",
+    "gtfs": "^4.5.1",
+    "js-beautify": "^1.14.11",
     "lodash-es": "^4.17.21",
-    "moment": "^2.29.4",
+    "moment": "^2.30.1",
     "morgan": "^1.10.0",
     "pretty-error": "^4.0.0",
     "pug": "^3.0.2",
-    "puppeteer": "^21.1.0",
+    "puppeteer": "^21.6.1",
     "sanitize-filename": "^1.6.3",
     "sqlstring": "^2.3.3",
     "timer-machine": "^1.1.0",
@@ -60,8 +60,8 @@
   },
   "devDependencies": {
     "husky": "^8.0.3",
-    "lint-staged": "^14.0.1",
-    "prettier": "^3.0.2"
+    "lint-staged": "^15.2.0",
+    "prettier": "^3.1.1"
   },
   "engines": {
     "node": ">= 18.0.0"

package/views/default/timetable_horizontal.pug

@@ -28,7 +28,7 @@
             th(scope="row" colspan=`${stop.trips.length + 1}`)= stop.stop_city
           - previousCity = stop.stop_city
 
-        tr.stop-row(id=`stop_id_${formatHtmlId(stop.stop_id)}` data-stop-id=`${stop.stop_id}`)
+        tr.stop-row(id=`stop_id_${formatHtmlId(stop.stop_id)}` data-stop-id=`${stop.stop_id}` data-is-timepoint=`${stop.is_timepoint}`)
           th.stop-name-container(scope="row")
             include timetable_stop_name.pug
 

package/views/default/timetable_vertical.pug

@@ -12,7 +12,7 @@
     caption.sr-only= `${timetable.timetable_label} | ${timetable.dayList}`
     colgroup
       each stop, idx in timetable.stops
-        col(id=`stop_id_${formatHtmlId(stop.stop_id)}` class=`stop-${idx}` data-stop-id=`${stop.stop_id}`)
+        col(id=`stop_id_${formatHtmlId(stop.stop_id)}` class=`stop-${idx}` data-stop-id=`${stop.stop_id}` data-is-timepoint=`${stop.is_timepoint}`)
     thead
       tr
         if timetable.has_continues_from_route

package/www/blog/2021-11-06-CSV-Export.md

@@ -11,7 +11,7 @@ GTFS-to-HTML Version 2.3.0 adds support for exporting timetables as CSV. Setting
 
 An example of a CSV timetable:
 
-```
+```csv
 ,San Francisco Ferry Building,Vallejo Ferry Terminal,Mare Island Ferry Terminal
 Run #1,10:30am,11:30am,
 Run #2,11:30am,12:30pm,