gtfs-to-html 2.5.8 → 2.6.0

package/CHANGELOG.md

@@ -5,6 +5,33 @@ 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
+
+- Move stop markers above map labels
+- Update to Mapbox GL JS v3
+- Dependency updates
+
+### Fixed
+
+- Handle routes with no route_short_name in map marker popups
+
 ## [2.5.8] - 2024-01-02
 
 ### Fixed

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.8",
+  "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.5.1",
-    "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.6.1",
+    "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.1.1"
+    "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;