gtfs-to-html 2.5.9 → 2.6.0

package/CHANGELOG.md

@@ -5,6 +5,21 @@ 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.6.0] - 2024-02-27
+
+### Updated
+
+- Improved timetable_page_label for pages with a single timetable
+- Better default timetable styles
+- Default route_color and route_text_color values
+- Better system map layer ordering
+- Dependency updates
+
+### Added
+
+- `showCalendarExceptions` configuration option
+- Add "timepoint" class to stoptimes
+
 ## [2.5.9] - 2024-01-24
 
 ### Updated

package/config-sample.json

@@ -11,14 +11,22 @@
   "coordinatePrecision": 5,
   "dateFormat": "MMM D, YYYY",
   "daysShortStrings": ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"],
-  "daysStrings": ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"],
+  "daysStrings": [
+    "Monday",
+    "Tuesday",
+    "Wednesday",
+    "Thursday",
+    "Friday",
+    "Saturday",
+    "Sunday"
+  ],
   "defaultOrientation": "vertical",
   "effectiveDate": "July 8, 2016",
   "interpolatedStopSymbol": "•",
   "interpolatedStopText": "Estimated time of arrival",
-  "linkStopUrls": true,
+  "linkStopUrls": false,
   "mapboxAccessToken": "YOUR MAPBOX ACCESS TOKEN",
-  "menuType": "simple",
+  "menuType": "jump",
   "noDropoffSymbol": "‡",
   "noDropoffText": "No drop off available",
   "noHead": false,
@@ -34,8 +42,9 @@
   "serviceNotProvidedOnText": "Service not provided on",
   "serviceProvidedOnText": "Service provided on",
   "showArrivalOnDifference": 0.2,
+  "showCalendarExceptions": true,
   "showMap": true,
-  "showOnlyTimepoint": false,
+  "showOnlyTimepoint": true,
   "showRouteTitle": true,
   "showStopCity": false,
   "showStopDescription": false,

package/lib/file-utils.js

@@ -12,7 +12,12 @@ import puppeteer from 'puppeteer';
 import sanitize from 'sanitize-filename';
 import untildify from 'untildify';
 
-import { isNullOrEmpty, formatDays } from './formatters.js';
+import {
+  isNullOrEmpty,
+  formatDays,
+  formatRouteColor,
+  formatRouteTextColor,
+} from './formatters.js';
 import * as templateFunctions from './template-functions.js';
 
 /*
@@ -22,12 +27,12 @@ export async function getConfig(argv) {
   try {
     const data = await readFile(
       path.resolve(untildify(argv.configPath)),
-      'utf8'
+      'utf8',
     ).catch((error) => {
       console.error(
         new Error(
-          `Cannot find configuration file at \`${argv.configPath}\`. Use config-sample.json as a starting point, pass --configPath option`
-        )
+          `Cannot find configuration file at \`${argv.configPath}\`. Use config-sample.json as a starting point, pass --configPath option`,
+        ),
       );
       throw error;
     });
@@ -45,8 +50,8 @@ export async function getConfig(argv) {
   } catch (error) {
     console.error(
       new Error(
-        `Cannot parse configuration file at \`${argv.configPath}\`. Check to ensure that it is valid JSON.`
-      )
+        `Cannot parse configuration file at \`${argv.configPath}\`. Check to ensure that it is valid JSON.`,
+      ),
     );
     throw error;
   }
@@ -65,14 +70,14 @@ function getTemplatePath(templateFileName, config) {
   if (config.templatePath !== undefined) {
     return path.join(
       untildify(config.templatePath),
-      `${fullTemplateFileName}.pug`
+      `${fullTemplateFileName}.pug`,
     );
   }
 
   return path.join(
     fileURLToPath(import.meta.url),
     '../../views/default',
-    `${fullTemplateFileName}.pug`
+    `${fullTemplateFileName}.pug`,
   );
 }
 
@@ -86,7 +91,7 @@ export async function prepDirectory(exportPath) {
   } catch (error) {
     if (error.code === 'ENOENT') {
       throw new Error(
-        `Unable to write to ${exportPath}. Try running this command from a writable directory.`
+        `Unable to write to ${exportPath}. Try running this command from a writable directory.`,
       );
     }
 
@@ -100,7 +105,7 @@ export async function prepDirectory(exportPath) {
 export function copyStaticAssets(exportPath) {
   const staticAssetPath = path.join(
     fileURLToPath(import.meta.url),
-    '../../public'
+    '../../public',
   );
   copydir.sync(path.join(staticAssetPath, 'css'), path.join(exportPath, 'css'));
   copydir.sync(path.join(staticAssetPath, 'js'), path.join(exportPath, 'js'));
@@ -181,6 +186,8 @@ export async function renderTemplate(templateFileName, templateVars, config) {
   const html = await renderFile(templatePath, {
     _,
     ...templateFunctions,
+    formatRouteColor,
+    formatRouteTextColor,
     ...templateVars,
   });
 

package/lib/formatters.js

@@ -116,6 +116,10 @@ function formatStopTime(stoptime, timetable, config) {
     }
   }
 
+  if (stoptime.timepoint === 1) {
+    stoptime.classes.push('timepoint');
+  }
+
   return stoptime;
 }
 /* eslint-enable complexity */
@@ -374,8 +378,8 @@ export function formatStopName(stop) {
     stop.type === 'arrival'
       ? ' (Arrival)'
       : stop.type === 'departure'
-      ? ' (Departure)'
-      : ''
+        ? ' (Departure)'
+        : ''
   }`;
 }
 
@@ -442,6 +446,22 @@ export function updateStoptimesByOffset(trip, offsetSeconds) {
   });
 }
 
+/*
+ * Format a route color as a hex color.
+ */
+export function formatRouteColor(route) {
+  // Defaults to #000000 (black) if no color is provided.
+  return route.route_color ? `#${route.route_color}` : '#000000';
+}
+
+/*
+ * Format a route text color as a hex color.
+ */
+export function formatRouteTextColor(route) {
+  // Defaults to #FFFFFF (white) if no color is provided.
+  return route.route_text_color ? `#${route.route_text_color}` : '#FFFFFF';
+}
+
 /*
  * Format a label for a timetable.
  */
@@ -488,21 +508,26 @@ export function formatTimetablePageLabel(timetablePage) {
     return timetablePage.timetable_page_label;
   }
 
-  // Get label from first timetable.
   if (
     timetablePage.consolidatedTimetables &&
     timetablePage.consolidatedTimetables.length > 0
   ) {
-    const routes = uniqBy(
-      flatMap(
-        timetablePage.consolidatedTimetables,
-        (timetable) => timetable.routes,
-      ),
-      'route_id',
-    );
-    const timetablePageLabel = routes.map((route) => formatRouteName(route));
+    if (timetablePage.consolidatedTimetables.length === 1) {
+      // Get label from first timetable if there is only one
+      return timetablePage.consolidatedTimetables[0].timetable_label;
+    } else {
+      // Otherwise, use route names from all timetables
+      const routes = uniqBy(
+        flatMap(
+          timetablePage.consolidatedTimetables,
+          (timetable) => timetable.routes,
+        ),
+        'route_id',
+      );
+      const timetablePageLabel = routes.map((route) => formatRouteName(route));
 
-    return timetablePageLabel.join(' and ');
+      return timetablePageLabel.join(' and ');
+    }
   }
 
   return 'Unknown';

package/lib/utils.js

@@ -1413,11 +1413,12 @@ export function setDefaultConfig(initialConfig) {
     interpolatedStopSymbol: '•',
     interpolatedStopText: 'Estimated time of arrival',
     gtfsToHtmlVersion: version,
+    linkStopUrls: false,
     menuType: 'jump',
     noDropoffSymbol: '‡',
     noDropoffText: 'No drop off available',
     noHead: false,
-    noPickupSymbol: '***',
+    noPickupSymbol: '**',
     noPickupText: 'No pickup available',
     noServiceSymbol: '-',
     noServiceText: 'No service at this stop',
@@ -1429,6 +1430,7 @@ export function setDefaultConfig(initialConfig) {
     serviceNotProvidedOnText: 'Service not provided on',
     serviceProvidedOnText: 'Service provided on',
     showArrivalOnDifference: 0.2,
+    showCalendarExceptions: true,
     showMap: false,
     showOnlyTimepoint: false,
     showRouteTitle: true,
@@ -1482,10 +1484,6 @@ export function getFormattedTimetablePage(timetablePageId, config) {
     ['route_color', 'route_text_color', 'agency_id'],
   );
 
-  timetablePage.routeColors = timetableRoutes.map((route) => route.route_color);
-  timetablePage.routeTextColors = timetableRoutes.map(
-    (route) => route.route_text_color,
-  );
   timetablePage.agency_ids = compact(
     timetableRoutes.map((route) => route.agency_id),
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-html",
-  "version": "2.5.9",
+  "version": "2.6.0",
   "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.1",
+    "archiver": "^6.0.2",
     "cli-table": "^0.3.11",
     "copy-dir": "^1.3.0",
-    "csv-stringify": "^6.4.5",
+    "csv-stringify": "^6.4.6",
     "express": "^4.18.2",
-    "gtfs": "^4.6.0",
-    "js-beautify": "^1.14.11",
+    "gtfs": "^4.7.1",
+    "js-beautify": "^1.15.1",
     "lodash-es": "^4.17.21",
     "moment": "^2.30.1",
     "morgan": "^1.10.0",
     "pretty-error": "^4.0.0",
     "pug": "^3.0.2",
-    "puppeteer": "^21.9.0",
+    "puppeteer": "^22.3.0",
     "sanitize-filename": "^1.6.3",
     "sqlstring": "^2.3.3",
     "timer-machine": "^1.1.0",
@@ -59,9 +59,9 @@
     "yoctocolors": "^1.0.0"
   },
   "devDependencies": {
-    "husky": "^8.0.3",
-    "lint-staged": "^15.2.0",
-    "prettier": "^3.2.4"
+    "husky": "^9.0.11",
+    "lint-staged": "^15.2.2",
+    "prettier": "^3.2.5"
   },
   "engines": {
     "node": ">= 18.0.0"

package/public/css/timetable_styles.css

@@ -163,22 +163,22 @@ a:hover {
 }
 
 .route-color-swatch {
-  min-width: 26px;
-  height: 26px;
-  border-radius: 13px;
+  min-width: 34px;
+  height: 34px;
+  border-radius: 17px;
   text-align: center;
-  line-height: 26px;
+  line-height: 34px;
   font-size: 14px;
   letter-spacing: -0.5px;
   padding: 0 5px;
 }
 
 .route-color-swatch-large {
-  min-width: 40px;
-  height: 40px;
-  border-radius: 20px;
+  min-width: 46px;
+  height: 46px;
+  border-radius: 23px;
   text-align: center;
-  line-height: 40px;
+  line-height: 46px;
   font-size: 20px;
   font-weight: bold;
   letter-spacing: -1px;

package/public/js/system-map.js

@@ -3,33 +3,33 @@
 
 const maps = {};
 
-function formatRouteName(route) {
-  let routeName = '';
-  if (route.route_short_name !== undefined) {
-    routeName += route.route_short_name;
-  } else if (route.route_long_name !== undefined) {
-    routeName += route.route_long_name;
-  }
-
-  return routeName;
+function formatRouteColor(route) {
+  return route.route_color || '#000000';
 }
 
 function formatRoute(route) {
   const html = route.route_url
-    ? $('<a>').attr('href', route.route_url)
+    ? $('<a>').attr('href', route.route_url).addClass('hover:no-underline')
     : $('<div>');
 
-  html.addClass('route-item text-sm mb-2');
+  html.addClass('route-item text-xs mb-2');
 
   if (route.route_color) {
+    // Only add color swatch if route has a color
     $('<div>')
-      .addClass('route-color-swatch mr-2 flex-shrink-0')
-      .css('backgroundColor', route.route_color)
+      .addClass('flex items-center gap-2')
+      .html([
+        $('<div>')
+          .addClass('route-color-swatch flex-shrink-0 text-white')
+          .css('backgroundColor', formatRouteColor(route))
+          .text(route.route_short_name || ''),
+        $('<div>')
+          .addClass('hover:underline')
+          .text(route.route_long_name || ''),
+      ])
       .appendTo(html);
   }
 
-  $('<span>').text(formatRouteName(route)).appendTo(html);
-
   return html.prop('outerHTML');
 }
 
@@ -60,7 +60,7 @@ function formatStopPopup(feature) {
     $('<strong>').text(feature.properties.stop_code).appendTo(html);
   }
 
-  $('<div>').text('Routes Served:').appendTo(html);
+  $('<div>').addClass('text-sm').text('Routes Served:').appendTo(html);
 
   $(html).append(routes.map((route) => formatRoute(route)));
 
@@ -83,7 +83,7 @@ function getBounds(geojson) {
 }
 
 function createSystemMap(id, geojson) {
-  const defaultRouteColor = '#FF4728';
+  const defaultRouteColor = '#000000';
   const lineLayout = {
     'line-join': 'round',
     'line-cap': 'round',
@@ -220,54 +220,54 @@ function createSystemMap(id, geojson) {
       firstSymbolId,
     );
 
-    // Add highlighted route white outlines next
+    // Add route lines next
     map.addLayer(
       {
-        id: `highlighted-route-outlines`,
+        id: 'routes',
         type: 'line',
         source: {
           type: 'geojson',
           data: geojson,
         },
         paint: {
-          'line-color': '#FFFFFF',
+          'line-color': ['coalesce', ['get', 'route_color'], defaultRouteColor],
           'line-opacity': 1,
           'line-width': {
-            base: 10,
+            base: 4,
             stops: [
-              [14, 16],
-              [18, 40],
+              [14, 6],
+              [18, 16],
             ],
           },
         },
         layout: lineLayout,
-        filter: ['==', ['get', 'route_id'], 'none'],
+        filter: ['has', 'route_id'],
       },
       firstSymbolId,
     );
 
-    // Add route lines next
+    // Add highlighted route white outlines next
     map.addLayer(
       {
-        id: 'routes',
+        id: `highlighted-route-outlines`,
         type: 'line',
         source: {
           type: 'geojson',
           data: geojson,
         },
         paint: {
-          'line-color': ['coalesce', ['get', 'route_color'], defaultRouteColor],
+          'line-color': '#FFFFFF',
           'line-opacity': 1,
           'line-width': {
-            base: 4,
+            base: 10,
             stops: [
-              [14, 6],
-              [18, 16],
+              [14, 16],
+              [18, 40],
             ],
           },
         },
         layout: lineLayout,
-        filter: ['has', 'route_id'],
+        filter: ['==', ['get', 'route_id'], 'none'],
       },
       firstSymbolId,
     );

package/public/js/timetable-map.js

@@ -3,33 +3,33 @@
 
 const maps = {};
 
-function formatRouteName(route) {
-  let routeName = '';
-  if (route.route_short_name !== undefined) {
-    routeName += route.route_short_name;
-  } else if (route.route_long_name !== undefined) {
-    routeName += route.route_long_name;
-  }
-
-  return routeName;
+function formatRouteColor(route) {
+  return route.route_color || '#000000';
 }
 
 function formatRoute(route) {
   const html = route.route_url
-    ? $('<a>').attr('href', route.route_url)
+    ? $('<a>').attr('href', route.route_url).addClass('hover:no-underline')
     : $('<div>');
 
-  html.addClass('route-item text-sm mb-2');
+  html.addClass('route-item text-xs mb-2');
 
   if (route.route_color) {
+    // Only add color swatch if route has a color
     $('<div>')
-      .addClass('route-color-swatch mr-2 flex-shrink-0')
-      .css('backgroundColor', route.route_color)
+      .addClass('flex items-center gap-2')
+      .html([
+        $('<div>')
+          .addClass('route-color-swatch flex-shrink-0 text-white')
+          .css('backgroundColor', formatRouteColor(route))
+          .text(route.route_short_name || ''),
+        $('<div>')
+          .addClass('hover:underline')
+          .text(route.route_long_name || ''),
+      ])
       .appendTo(html);
   }
 
-  $('<span>').text(formatRouteName(route)).appendTo(html);
-
   return html.prop('outerHTML');
 }
 
@@ -48,7 +48,7 @@ function formatStopPopup(feature, routes) {
     $('<strong>').text(feature.properties.stop_code).appendTo(html);
   }
 
-  $('<div>').text('Routes Served:').appendTo(html);
+  $('<div>').addClass('text-sm').text('Routes Served:').appendTo(html);
 
   $(html).append(routeIds.map((routeId) => formatRoute(routes[routeId])));
 
@@ -71,7 +71,7 @@ function getBounds(geojson) {
 }
 
 function createMap(id, geojson, routes) {
-  const defaultRouteColor = '#FF4728';
+  const defaultRouteColor = '#000000';
   const lineLayout = {
     'line-join': 'round',
     'line-cap': 'round',

package/views/default/overview.pug

@@ -10,12 +10,12 @@ include formatting_functions.pug
         h1.text-2xl.pt-4.pb-2= `${formatAgencyName(timetablePageGroup.agency)} Routes`
         each timetablePage in timetablePageGroup.timetablePages
           if config.allowEmptyTimetables || timetablePage.consolidatedTimetables.length > 0
-            a.block.p-2.border-b.border-slate-200(class="hover:bg-slate-200 hover:no-underline" href=`${timetablePage.relativePath}` data-route-ids=`${timetablePage.route_ids ? timetablePage.route_ids.join(',') : ''}`)
+            a.block.p-2.border-b.border-slate-200(class="hover:bg-slate-100 hover:no-underline" href=`${timetablePage.relativePath}` data-route-ids=`${timetablePage.route_ids ? timetablePage.route_ids.join(',') : ''}`)
               .text-lg.text-gray-800.leading-none= timetablePage.timetable_page_label
               each route in _.uniqBy(_.flatMap(timetablePage.consolidatedTimetables, timetable => timetable.routes), 'route_id')
-                .flex.my-1
-                  .route-color-swatch.flex-none.mr-2(style=`background-color: #${route.route_color}; color: #${route.route_text_color};`)= route.route_short_name || ''
-                  .mt-1.text-gray-600.leading-none= formatRouteName(route)
+                .flex.my-1.items-center.gap-1
+                  .route-color-swatch.flex-none(style=`background-color: ${formatRouteColor(route)}; color: ${formatRouteTextColor(route)};`)= route.route_short_name || ''
+                  .text-gray-600.leading-none= formatRouteName(route)
               .inline-flex.items-center.justify-center.px-2.py-1.text-xs.font-bold.leading-none.text-slate-800.bg-slate-200.rounded-full= timetablePage.dayList
     if config.showMap
       .map.ml-4.h-full.w-full(id="system_map")

package/views/default/timetablepage.pug

@@ -4,9 +4,9 @@ include formatting_functions.pug
 .timetable-page(class=`menu-type-${config.menuType}`)
   .container.mx-4(class="md:mx-auto")
     if config.showRouteTitle
-      h1.timetable-page-label.text-2xl.pt-4.flex.items-center
+      h1.timetable-page-label.text-2xl.pt-4.flex.items-center.gap-2
         each route in _.uniqBy(_.flatMap(timetablePage.consolidatedTimetables, timetable => timetable.routes), 'route_id')
-          .route-color-swatch-large.mr-2.flex-none(style=`background-color: #${route.route_color}; color: #${route.route_text_color}`)= route.route_short_name || ''
+          .route-color-swatch-large.flex-none(style=`background-color: ${formatRouteColor(route)}; color: ${formatRouteTextColor(route)};`)= route.route_short_name || ''
         div= timetablePage.timetable_page_label
       if config.effectiveDate
         .effective-date.text-gray-600.mb-2= `Effective ${config.effectiveDate}`
@@ -16,11 +16,12 @@ include formatting_functions.pug
     each timetable in timetablePage.consolidatedTimetables
       .timetable.mb-10(id=`timetable_id_${formatHtmlId(timetable.timetable_id)}` data-day-list=timetable.dayList data-direction-name=timetable.direction_name data-timetable-id=timetable.timetable_id data-direction-id=timetable.direction_id data-route-id=timetable.route_ids.join('_'))
         if config.showRouteTitle
-          h2.text-xl= `${timetable.timetable_label} | ${timetable.dayListLong}`
-            each note in getNotesForTimetableLabel(timetable.notes)
-              include timetable_note_symbol.pug
-          if timetable.service_notes !== null
-            .service-notes= timetable.service_notes
+          .mb-2
+            h2.text-xl= `${timetable.timetable_label} | ${timetable.dayListLong}`
+              each note in getNotesForTimetableLabel(timetable.notes)
+                include timetable_note_symbol.pug
+            if timetable.service_notes !== null
+              .service-notes= timetable.service_notes
 
         if config.showMap
           .map(id=`map_timetable_id_${formatHtmlId(timetable.timetable_id)}`)
@@ -55,8 +56,8 @@ include formatting_functions.pug
               each note in _.uniqBy(timetable.notes, 'note_id')
                 .note(id=`note-${timetable.timetable_id}-${note.note_id}`)= `${note.symbol} = ${note.note}`
 
-          if timetable.calendarDates.includedDates.length
+          if config.showCalendarExceptions && timetable.calendarDates.includedDates.length
             .included-dates= `${config.serviceProvidedOnText}: ${timetable.calendarDates.includedDates.join(', ')}`
 
-          if timetable.calendarDates.excludedDates.length
+          if config.showCalendarExceptions && timetable.calendarDates.excludedDates.length
             .excluded-dates= `${config.serviceNotProvidedOnText}: ${timetable.calendarDates.excludedDates.join(', ')}`

package/www/docs/configuration.md

@@ -46,6 +46,7 @@ All files starting with `config*.json` are .gitignored - so you can create multi
 | [`serviceNotProvidedOnText`](#servicenotprovidedontext)         | string           | The text used to label days where service is not provided.                                       |
 | [`serviceProvidedOnText`](#serviceprovidedontext)               | string           | The text used to label days where service is provided.                                           |
 | [`showArrivalOnDifference`](#showarrivalondifference)           | float            | Defines a difference between departure and arrival, on which arrival column/row will be shown.   |
+| [`showCalendarExceptions`](#showcalendarexecptions)             | boolean          | Whether or not to show a list of calendar exceptions below each timetable. |
 | [`showMap`](#showmap)                                           | boolean          | Whether or not to show a map of the route on the timetable.                                      |
 | [`showOnlyTimepoint`](#showonlytimepoint)                       | boolean          | Whether or not all stops should be shown, or only stops with a `timepoint` value in `stops.txt`. |
 | [`showRouteTitle`](#showroutetitle)                             | boolean          | Whether or not to show the route title at the top of the timetable page.                         |
@@ -414,6 +415,14 @@ gtfsToHtml(config);
 "showArrivalOnDifference": 0.2
 ```
 
+### showCalendarExceptions
+
+\{Boolean\} Whether or not to show a list of calendar exceptions below each timetable. Uses dates defined in calendar_dates.txt. Defaults to `true`.
+
+```json
+"showCalendarExceptions": true
+```
+
 ### showMap
 
 \{Boolean\} Whether or not to show a map of the route on the timetable. Defaults to `false`.