gtfs-to-html 2.6.11 → 2.7.0

package/CHANGELOG.md

@@ -5,6 +5,26 @@ 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.7.0] - 2024-07-27
+
+### Fixed
+- Fixes for horizontal orientation labels
+
+### Updated
+- Better date format documentation
+- Better default for timetable_page_label
+- Larger map on desktop
+- Improved button styles
+- Serve static assets from templatePath
+- Move static js and css to views/default
+- Dependency updates
+
+## [2.6.12] - 2024-07-26
+
+### Updated
+- Dependency updates
+- Improved styles for default template
+
 ## [2.6.11] - 2024-07-24
 
 ### Updated

package/app/index.js

@@ -4,9 +4,9 @@ import { readFileSync } from 'node:fs';
 import { map } from 'lodash-es';
 import yargs from 'yargs';
 import { openDb } from 'gtfs';
-
 import express from 'express';
 import logger from 'morgan';
+import untildify from 'untildify';
 
 import { formatTimetableLabel } from '../lib/formatters.js';
 import {
@@ -44,7 +44,7 @@ try {
 } 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.`,
     );
   }
 
@@ -59,14 +59,14 @@ router.get('/', async (request, response, next) => {
     const timetablePages = [];
     const timetablePageIds = map(
       getTimetablePagesForAgency(config),
-      'timetable_page_id'
+      'timetable_page_id',
     );
 
     for (const timetablePageId of timetablePageIds) {
       // eslint-disable-next-line no-await-in-loop
       const timetablePage = await getFormattedTimetablePage(
         timetablePageId,
-        config
+        config,
       );
 
       if (
@@ -74,7 +74,7 @@ router.get('/', async (request, response, next) => {
         timetablePage.consolidatedTimetables.length === 0
       ) {
         console.error(
-          `No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`
+          `No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`,
         );
       }
 
@@ -107,7 +107,7 @@ router.get('/timetables/:timetablePageId', async (request, response, next) => {
   try {
     const timetablePage = await getFormattedTimetablePage(
       timetablePageId,
-      config
+      config,
     );
 
     const html = await generateTimetableHTML(timetablePage, config);
@@ -121,9 +121,14 @@ app.set('views', path.join(fileURLToPath(import.meta.url), '../../views'));
 app.set('view engine', 'pug');
 
 app.use(logger('dev'));
-app.use(
-  express.static(path.join(fileURLToPath(import.meta.url), '../../public'))
-);
+
+// Serve static assets
+const staticAssetPath =
+  config.templatePath === undefined
+    ? path.join(fileURLToPath(import.meta.url), '../../views/default')
+    : untildify(config.templatePath);
+
+app.use(express.static(staticAssetPath));
 
 app.use('/', router);
 app.set('port', process.env.PORT || 3000);

package/lib/file-utils.js

@@ -66,18 +66,12 @@ function getTemplatePath(templateFileName, config) {
     fullTemplateFileName += '_full';
   }
 
-  if (config.templatePath !== undefined) {
-    return path.join(
-      untildify(config.templatePath),
-      `${fullTemplateFileName}.pug`,
-    );
-  }
+  const templatePath =
+    config.templatePath === undefined
+      ? path.join(fileURLToPath(import.meta.url), '../../views/default')
+      : untildify(config.templatePath);
 
-  return path.join(
-    fileURLToPath(import.meta.url),
-    '../../views/default',
-    `${fullTemplateFileName}.pug`,
-  );
+  return path.join(templatePath, `${fullTemplateFileName}.pug`);
 }
 
 /*
@@ -101,11 +95,12 @@ export async function prepDirectory(exportPath) {
 /*
  * Copy needed CSS and JS to export path.
  */
-export function copyStaticAssets(exportPath) {
-  const staticAssetPath = path.join(
-    fileURLToPath(import.meta.url),
-    '../../public',
-  );
+export function copyStaticAssets(config, exportPath) {
+  const staticAssetPath =
+    config.templatePath === undefined
+      ? path.join(fileURLToPath(import.meta.url), '../../views/default')
+      : untildify(config.templatePath);
+
   copydir.sync(path.join(staticAssetPath, 'css'), path.join(exportPath, 'css'));
   copydir.sync(path.join(staticAssetPath, 'js'), path.join(exportPath, 'js'));
 }

package/lib/formatters.js

@@ -247,20 +247,6 @@ export function formatTrip(trip, timetable, calendars, config) {
   return trip;
 }
 
-/*
- * Format a route name.
- */
-export function formatRouteName(route) {
-  let routeName = 'Route ';
-  if (!isNullOrEmpty(route.route_short_name)) {
-    routeName += route.route_short_name;
-  } else if (!isNullOrEmpty(route.route_long_name)) {
-    routeName += route.route_long_name;
-  }
-
-  return routeName;
-}
-
 /*
  * Format a frequency.
  */
@@ -384,7 +370,7 @@ export function formatStopName(stop) {
 }
 
 /*
- * Formats trip "Contines from".
+ * Formats trip "Continues from".
  */
 export function formatTripContinuesFrom(trip) {
   return trip.continues_from_route
@@ -393,7 +379,7 @@ export function formatTripContinuesFrom(trip) {
 }
 
 /*
- * Formats trip "Contines as".
+ * Formats trip "Continues as".
  */
 export function formatTripContinuesAs(trip) {
   return trip.continues_as_route
@@ -500,33 +486,6 @@ export function formatTimetableLabel(timetable) {
   return timetableLabel;
 }
 
-/*
- * Format a label for a timetable page.
- */
-export function formatTimetablePageLabel(timetablePage) {
-  if (!isNullOrEmpty(timetablePage.timetable_page_label)) {
-    return timetablePage.timetable_page_label;
-  }
-
-  if (
-    timetablePage.consolidatedTimetables &&
-    timetablePage.consolidatedTimetables.length > 0
-  ) {
-    // Use route names from all timetables
-    const routes = uniqBy(
-      flatMap(
-        timetablePage.consolidatedTimetables,
-        (timetable) => timetable.routes,
-      ),
-      'route_id',
-    );
-
-    return routes.map((route) => formatRouteName(route)).join(' and ');
-  }
-
-  return 'Unknown';
-}
-
 /*
  * Merge timetables with same `timetable_id`.
  */

package/lib/gtfs-to-html.js

@@ -89,7 +89,7 @@ const gtfsToHtml = async (initialConfig) => {
   await prepDirectory(exportPath);
 
   if (config.noHead !== true && ['html', 'pdf'].includes(config.outputFormat)) {
-    copyStaticAssets(exportPath);
+    copyStaticAssets(config, exportPath);
   }
 
   const bar = progressBar(
@@ -134,7 +134,7 @@ const gtfsToHtml = async (initialConfig) => {
       );
 
       if (config.outputFormat === 'csv') {
-        for (const timetable of timetablePage.timetables) {
+        for (const timetable of timetablePage.consolidatedTimetables) {
           const csv = await generateTimetableCSV(timetable);
           const csvPath = path.join(
             exportPath,

package/lib/utils.js

@@ -58,7 +58,6 @@ import {
   formatStops,
   formatTimetableId,
   formatTimetableLabel,
-  formatTimetablePageLabel,
   formatTrip,
   formatTripContinuesAs,
   formatTripContinuesFrom,
@@ -1505,7 +1504,6 @@ export function getFormattedTimetablePage(timetablePageId, config) {
     timetablePage.timetables,
     config,
   );
-  timetablePage.timetable_page_label = formatTimetablePageLabel(timetablePage);
   timetablePage.dayList = formatDays(
     getDaysFromCalendars(timetablePage.consolidatedTimetables),
     config,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-html",
-  "version": "2.6.11",
+  "version": "2.7.0",
   "private": false,
   "description": "Build human readable transit timetables as HTML, PDF or CSV from GTFS",
   "keywords": [
@@ -40,9 +40,9 @@
     "archiver": "^7.0.1",
     "cli-table": "^0.3.11",
     "copy-dir": "^1.3.0",
-    "csv-stringify": "^6.5.0",
+    "csv-stringify": "^6.5.1",
     "express": "^4.19.2",
-    "gtfs": "^4.13.1",
+    "gtfs": "^4.13.2",
     "insane": "^2.6.2",
     "js-beautify": "^1.15.1",
     "lodash-es": "^4.17.21",
@@ -51,7 +51,7 @@
     "morgan": "^1.10.0",
     "pretty-error": "^4.0.0",
     "pug": "^3.0.3",
-    "puppeteer": "^22.13.1",
+    "puppeteer": "^22.14.0",
     "sanitize-filename": "^1.6.3",
     "sqlstring": "^2.3.3",
     "timer-machine": "^1.1.0",
@@ -61,7 +61,7 @@
     "yoctocolors": "^2.1.1"
   },
   "devDependencies": {
-    "husky": "^9.1.1",
+    "husky": "^9.1.3",
     "lint-staged": "^15.2.7",
     "prettier": "^3.3.3"
   },

package/{public → views/default}/css/overview_styles.css

@@ -36,7 +36,59 @@ a:hover {
 
 /* Overview styles */
 
-.route-color-swatch {
+
+.timetable-overview {
+  height: 100vh;
+  align-items: stretch;
+}
+
+@media (min-width: 768px) {
+  .timetable-overview {
+    display: flex;
+  }
+}
+
+.timetable-overview h1 {
+  font-size: 1.5rem;
+  line-height: 2rem;
+  margin-left: 1rem;
+  margin-right: 1rem;
+  padding-top: 0.75rem;
+  padding-bottom: 0.75rem;
+}
+
+.timetable-overview .overview-list {
+  flex: none;
+}
+
+@media (min-width: 768px) {
+  .timetable-overview .overview-list {
+    max-width: 24rem;
+    overflow-y: scroll;
+  }
+}
+
+.timetable-overview a.timetable-page-link {
+  display: flex;
+  align-items: center;
+  gap: 0.5rem;
+  border-bottom: 1px solid rgb(226 232 240);
+  text-decoration: none;
+  padding: 0.5rem;
+}
+
+.timetable-overview a.timetable-page-link:hover {
+  background-color: rgb(241 245 249);
+  text-decoration: none;
+}
+
+.timetable-overview a.timetable-page-link .timetable-page-label {
+  font-size: 1.25rem;
+  line-height: 1;
+  color: rgb(30 41 59)
+}
+
+.timetable-overview .route-color-swatch {
   min-width: 34px;
   height: 34px;
   border-radius: 17px;
@@ -45,9 +97,11 @@ a:hover {
   font-size: 14px;
   letter-spacing: -0.5px;
   padding: 0 5px;
+  flex: none;
+  flex-shrink: 0;
 }
 
-.route-color-swatch-large {
+.timetable-overview .route-color-swatch-large {
   min-width: 46px;
   height: 46px;
   border-radius: 23px;
@@ -57,11 +111,13 @@ a:hover {
   font-weight: bold;
   letter-spacing: -1px;
   padding: 0 6px;
+  flex: none;
+  flex-shrink: 0;
 }
 
-.btn-blue {
+.timetable-overview .btn-blue {
   color: rgb(255 255 255);
-  padding: 0.75rem 2rem;
+  padding: 0.75rem 1.5rem;
   background-color: rgb(37 99 235);
   border-radius: 0.375rem;
   justify-content: center;
@@ -71,172 +127,71 @@ a:hover {
   text-decoration: none;
 }
 
-.btn-blue:hover {
+.timetable-overview .btn-blue:hover {
   background-color: rgb(29 78 216);
   text-decoration: none;
 }
 
-.btn-sm {
+.timetable-overview .btn-sm {
   padding: 0.25rem 1rem;
   border-radius: 0.25rem;
 }
 
-.mr-1 {
-  margin-right: 0.25rem;
-}
-
-.mx-4 {
-  margin-left: 1rem;
-  margin-right: 1rem;
-}
-
-.mb-2 {
-  margin-bottom: 0.5rem;
-}
-
-.block {
-  display: block;
-}
-
-.flex {
-  display: flex;
-}
-
-.inline-flex {
+.timetable-overview .badge-gray {
   display: inline-flex;
-}
-
-.h-full {
-  height: 100%;
-}
-
-.h-screen {
-  height: 100vh;
-}
-
-.w-full {
-  width: 100%;
-}
-
-.flex-none {
-  flex: none;
-}
-
-.items-center {
   align-items: center;
-}
-
-.items-stretch {
-  align-items: stretch;
-}
-
-.justify-center {
   justify-content: center;
-}
-
-.gap-2 {
-  gap: 0.5rem;
-}
-
-.rounded-full {
-  border-radius: 9999px;
-}
-
-.border-b {
-  border-bottom-width: 1px;
-}
-
-.border-slate-200 {
-  border-color: rgb(226 232 240);
-}
-
-.bg-slate-200 {
-  background-color: rgb(226 232 240);
-}
-
-.p-2 {
-  padding: 0.5rem;
-}
-
-.px-2 {
   padding-left: 0.5rem;
   padding-right: 0.5rem;
-}
-
-.py-1 {
   padding-top: 0.25rem;
   padding-bottom: 0.25rem;
-}
-
-.py-3 {
-  padding-top: 0.75rem;
-  padding-bottom: 0.75rem;
-}
-
-.text-2xl {
-  font-size: 1.5rem;
-  line-height: 2rem;
-}
-
-.text-xl {
-  font-size: 1.25rem;
-  line-height: 1.75rem;
-}
-
-.text-xs {
   font-size: 0.75rem;
-  line-height: 1rem;
-}
-
-.font-bold {
-  font-weight: 700;
-}
-
-.leading-none {
   line-height: 1;
-}
-
-.text-slate-800 {
+  font-weight: 700;
   color: rgb(30 41 59);
+  background-color: rgb(226 232 240);
+  border-radius: 9999px;
 }
 
-.hover\:bg-slate-100:hover {
-  background-color: rgb(241 245 249);
-}
-
-.hover\:no-underline:hover {
-  text-decoration-line: none;
-}
-
-@media (min-width: 768px) {
-  .md\:flex {
-    display: flex;
-  }
-
-  .md\:max-w-96 {
-    max-width: 24rem;
-  }
+/* Map Styles */
 
-  .md\:overflow-y-scroll {
-    overflow-y: scroll;
-  }
+.overview-map {
+  height: 100%;
+  width: 100%;
 }
 
-/* Map Styles */
-
-.map .mapboxgl-popup-content .popup-title {
+.overview-map .mapboxgl-popup-content .popup-title {
   margin: 0 20px 5px 0;
   font-size: 16px;
   font-weight: bold;
 }
 
-.map .mapboxgl-popup-content .route-item {
+.overview-map .mapboxgl-popup-content .popup-label {
+  margin-right: 0.25rem;
+}
+
+.overview-map .mapboxgl-popup-content .route-list {
+  margin-bottom: 0.5rem;
+}
+
+.overview-map .mapboxgl-popup-content .map-route-item {
   display: flex;
   align-items: center;
+  font-size: 0.75rem;
   line-height: 1;
+  margin-bottom: 0.5rem;
+  gap: 0.5rem;
+}
+
+.overview-map .mapboxgl-popup-content .map-route-item:hover {
+  text-decoration: none;
+}
+
+.overview-map .mapboxgl-popup-content a.map-route-item .underline-hover:hover {
+  text-decoration: underline;
 }
 
-.map .mapboxgl-popup-content .mapboxgl-popup-close-button {
+.overview-map .mapboxgl-popup-content .mapboxgl-popup-close-button {
   padding: 0 5px;
 }