gtfs-to-html 2.2.0 → 2.3.2

package/README.md

@@ -1,35 +1,51 @@
-
-# GTFS to HTML
-
-[![NPM version](https://img.shields.io/npm/v/gtfs-to-html.svg?style=flat)](https://www.npmjs.com/package/gtfs-to-html)
-[![David](https://img.shields.io/david/blinktaginc/gtfs-to-html.svg)]()
-[![npm](https://img.shields.io/npm/dm/gtfs-to-html.svg?style=flat)]()
-[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
-
-[![NPM](https://nodei.co/npm/gtfs-to-html.png?downloads=true)](https://nodei.co/npm/gtfs-to-html/)
-
- See [gtfstohtml.com](https://gtfstohtml.com) for full documentation.
-
-`gtfs-to-html` creates human-readable, user-friendly transit timetables in HTML and PDF format directly from [GTFS transit data](https://developers.google.com/transit/gtfs/). Most transit agencies have schedule data in GTFS format but need to show each route's schedule to users on a website. This project automates the process of creating nicely formatted HTML timetables for inclusion on a transit agency website. This makes it easy to keep timetables up to date and accurate when schedule changes happen and reduces the likelihood of errors.
+<p align="center">
+  ➡️
+  <a href="https://gtfstohtml.com/docs/">Documentation</a> |
+  <a href="https://gtfstohtml.com/docs/quick-start">Quick Start</a> |
+  <a href="https://gtfstohtml.com/docs/configuration">Configuration</a> |
+  <a href="https://gtfstohtml.com/docs/contact">Questions and Support</a>
+  ⬅️
+  <br /><br />
+  <img src="www/static/img/gtfs-to-html-logo.svg" alt="GTFS-to-HTML" />
+  <br /><br />
+  <a href="https://www.npmjs.com/package/gtfs-to-html" rel="nofollow"><img src="https://img.shields.io/npm/v/gtfs-to-html.svg?style=flat" style="max-width: 100%;"></a>
+  <a href="https://www.npmjs.com/package/gtfs-to-html" rel="nofollow"><img src="https://img.shields.io/npm/dm/gtfs-to-html.svg?style=flat" style="max-width: 100%;"></a>
+  <img src="https://img.shields.io/badge/License-MIT-yellow.svg">
+  <br /><br />
+  Create human-readable, user-friendly transit timetables in HTML, PDF or CSV format directly from GTFS.
+  <br /><br />
+  <a href="https://nodei.co/npm/gtfs-to-html/" rel="nofollow"><img src="https://nodei.co/npm/gtfs-to-html.png?downloads=true" alt="NPM" style="max-width: 100%;"></a>
+</p>
+
+<hr>
+
+See [gtfstohtml.com](https://gtfstohtml.com) for full documentation.
+
+Most transit agencies have schedule data in [GTFS ](https://developers.google.com/transit/gtfs/) format but need to show each route's schedule to users on a website. GTFS-to-HTML automates the process of creating nicely formatted HTML timetables for inclusion on a transit agency website. This makes it easy to keep timetables up to date and accurate when schedule changes happen and reduces the likelihood of errors.
 
 <img width="1265" src="https://user-images.githubusercontent.com/96217/28296063-aed45568-6b1a-11e7-9794-94b3d915d668.png">
 
 ## Features
 
 ### Configurable and customizable
-`gtfs-to-html` has many options that configure how timetables are presented. It also allows using a completely custom template which makes it easy to build chunks of HTML that will fit perfectly into any website using any HTML structure and classes that you'd like. Or, create printable PDF versions of timetables using the `outputFormat` config option.
+
+`gtfs-to-html` has many options that configure how timetables are presented. It also allows using a completely custom template which makes it easy to build chunks of HTML that will fit perfectly into any website using any HTML structure and classes that you'd like. Or, create printable PDF versions or CSV exports of timetables using the `outputFormat` config option.
 
 ### Accessibility for all
+
 `gtfs-to-html` properly formats timetables to ensure they are screen-reader accessible and WCAG 2.0 compliant.
 
 ### Mobile responsiveness built in
+
 Built-in styling makes `gtfs-to-html` timetables ready to size and scroll easily on mobile phones and tablets.
 
 ### Schedule changes? A cinch.
+
 By generating future timetables and including dates in table metadata, your timetables can appear in advance of a schedule change, and you can validate that your new timetables and GTFS are correct.
 
 ### Auto-generated maps
-`gtfs-to-html` can also generate a map for each route that can be included with the schedule page. The map shows all stops for the route and lists all routes that serve each stop. See the `showMap` configuration option below. 
+
+`gtfs-to-html` can also generate a map for each route that can be included with the schedule page. The map shows all stops for the route and lists all routes that serve each stop. See the `showMap` configuration option below.
 
 Note: If you only want maps of GTFS data, use the [gtfs-to-geojson](https://github.com/blinktaginc/gtfs-to-geojson) package instead and skip making timetables entirely. If offers many different formats of GeoJSON for routes and stops.
 
@@ -40,34 +56,36 @@ Note: If you only want maps of GTFS data, use the [gtfs-to-geojson](https://gith
 You can now use `gtfs-to-html` without actually downloading any code or doing any configuration. [run.gtfstohtml.com](https://run.gtfstohtml.com) provides a web based interface for finding GTFS feeds for agencies, setting configuration and then generates a previewable and downloadable set of timetables.
 
 ## Current Usage
+
 Many transit agencies use `gtfs-to-html` to generate the schedule pages used on their websites, including:
 
-* [Advance Transit](https://advancetransit.com)
-* [Brockton Area Transit Authority](https://ridebat.com)
-* [Capital Transit (Helena, Montana)](http://www.ridethecapitalt.org)
-* [Capital Transit (Juneau, Alaska)](https://juneaucapitaltransit.org)
-* [Central Transit (Ellensburg, Washington)](https://centraltransit.org)
-* [County Connection (Contra Costa County, California)](https://countyconnection.com)
-* [El Dorado Transit](http://eldoradotransit.com)
-* [Greater Attleboro-Taunton Regional Transit Authority](https://www.gatra.org)
-* [Humboldt Transit Authority](http://hta.org)
-* [Kings Area Rural Transit (KART)](https://www.kartbus.org)
-* [Madera County Connection](http://mcctransit.com)
-* [Marin Transit](https://marintransit.org)
-* [Morongo Basin Transit Authority](https://mbtabus.com)
-* [Mountain Transit](http://mountaintransit.org)
-* [MVgo (Mountain View, CA)](https://mvgo.org)
-* [NW Connector (Oregon)](http://www.nworegontransit.org)
-* [Palo Verde Valley Transit Agency](http://pvvta.com)
-* [Petaluma Transit](http://transit.cityofpetaluma.net)
-* [RTC Washoe (Reno, NV)](https://www.rtcwashoe.com)
-* [Santa Barbara Metropolitan Transit District](https://sbmtd.gov)
-* [Sonoma County Transit](http://sctransit.com)
-* [Tahoe Truckee Area Regional Transit](https://tahoetruckeetransit.com)
-* [Transcollines](https://transcollines.ca)
-* [Tulare County Area Transit](https://ridetcat.org)
-* [Victor Valley Transit](https://vvta.org)
-* [Worcester Regional Transit Authority](https://therta.com)
+- [Advance Transit](https://advancetransit.com)
+- [Brockton Area Transit Authority](https://ridebat.com)
+- [Capital Transit (Helena, Montana)](http://www.ridethecapitalt.org)
+- [Capital Transit (Juneau, Alaska)](https://juneaucapitaltransit.org)
+- [Central Transit (Ellensburg, Washington)](https://centraltransit.org)
+- [County Connection (Contra Costa County, California)](https://countyconnection.com)
+- [El Dorado Transit](http://eldoradotransit.com)
+- [Greater Attleboro-Taunton Regional Transit Authority](https://www.gatra.org)
+- [Humboldt Transit Authority](http://hta.org)
+- [Kings Area Rural Transit (KART)](https://www.kartbus.org)
+- [Madera County Connection](http://mcctransit.com)
+- [Marin Transit](https://marintransit.org)
+- [Morongo Basin Transit Authority](https://mbtabus.com)
+- [Mountain Transit](http://mountaintransit.org)
+- [MVgo (Mountain View, CA)](https://mvgo.org)
+- [NW Connector (Oregon)](http://www.nworegontransit.org)
+- [Palo Verde Valley Transit Agency](http://pvvta.com)
+- [Petaluma Transit](http://transit.cityofpetaluma.net)
+- [RTC Washoe (Reno, NV)](https://www.rtcwashoe.com)
+- [Santa Barbara Metropolitan Transit District](https://sbmtd.gov)
+- [Sonoma County Transit](http://sctransit.com)
+- [Tahoe Transportation District](https://www.tahoetransportation.org)
+- [Tahoe Truckee Area Regional Transit](https://tahoetruckeetransit.com)
+- [Transcollines](https://transcollines.ca)
+- [Tulare County Area Transit](https://ridetcat.org)
+- [Victor Valley Transit](https://vvta.org)
+- [Worcester Regional Transit Authority](https://therta.com)
 
 Are you using `gtfs-to-html`? Let us know via email (brendan@blinktag.com) or via opening a github issue or pull request if your agency is using this library.
 

package/app/index.js

@@ -9,20 +9,26 @@ import express from 'express';
 import logger from 'morgan';
 
 import { formatTimetableLabel } from '../lib/formatters.js';
-import { setDefaultConfig, getTimetablePagesForAgency, getFormattedTimetablePage, generateOverviewHTML, generateHTML } from '../lib/utils.js';
-
-const { argv } = yargs(process.argv)
-  .option('c', {
-    alias: 'configPath',
-    describe: 'Path to config file',
-    default: './config.json',
-    type: 'string'
-  });
+import {
+  setDefaultConfig,
+  getTimetablePagesForAgency,
+  getFormattedTimetablePage,
+  generateOverviewHTML,
+  generateTimetableHTML,
+} from '../lib/utils.js';
+
+const { argv } = yargs(process.argv).option('c', {
+  alias: 'configPath',
+  describe: 'Path to config file',
+  default: './config.json',
+  type: 'string',
+});
 
 const app = express();
 const router = new express.Router();
 
-const configPath = argv.configPath || new URL('../config.json', import.meta.url);
+const configPath =
+  argv.configPath || new URL('../config.json', import.meta.url);
 const selectedConfig = JSON.parse(readFileSync(configPath));
 
 const config = setDefaultConfig(selectedConfig);
@@ -33,9 +39,11 @@ config.log = console.log;
 config.logWarning = console.warn;
 config.logError = console.error;
 
-openDb(config).catch(error => {
+openDb(config).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.`);
+    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.`
+    );
   }
 
   throw error;
@@ -47,14 +55,25 @@ openDb(config).catch(error => {
 router.get('/', async (request, response, next) => {
   try {
     const timetablePages = [];
-    const timetablePageIds = map(await getTimetablePagesForAgency(config), 'timetable_page_id');
+    const timetablePageIds = map(
+      await getTimetablePagesForAgency(config),
+      'timetable_page_id'
+    );
 
     for (const timetablePageId of timetablePageIds) {
       // eslint-disable-next-line no-await-in-loop
-      const timetablePage = await getFormattedTimetablePage(timetablePageId, config);
-
-      if (!timetablePage.consolidatedTimetables || timetablePage.consolidatedTimetables.length === 0) {
-        console.error(`No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`);
+      const timetablePage = await getFormattedTimetablePage(
+        timetablePageId,
+        config
+      );
+
+      if (
+        !timetablePage.consolidatedTimetables ||
+        timetablePage.consolidatedTimetables.length === 0
+      ) {
+        console.error(
+          `No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`
+        );
       }
 
       timetablePage.relativePath = `/timetables/${timetablePage.timetable_page_id}`;
@@ -76,19 +95,20 @@ router.get('/', async (request, response, next) => {
  * Show a specific timetable page
  */
 router.get('/timetables/:timetablePageId', async (request, response, next) => {
-  const {
-    timetablePageId
-  } = request.params;
+  const { timetablePageId } = request.params;
 
   if (!timetablePageId) {
     return next(new Error('No timetablePageId provided'));
   }
 
   try {
-    const timetablePage = await getFormattedTimetablePage(timetablePageId, config);
+    const timetablePage = await getFormattedTimetablePage(
+      timetablePageId,
+      config
+    );
 
-    const results = await generateHTML(timetablePage, config);
-    response.send(results.html);
+    const html = await generateTimetableHTML(timetablePage, config);
+    response.send(html);
   } catch (error) {
     next(error);
   }
@@ -98,7 +118,9 @@ 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')));
+app.use(
+  express.static(path.join(fileURLToPath(import.meta.url), '../../public'))
+);
 
 app.use('/', router);
 app.set('port', process.env.PORT || 3000);

package/bin/gtfs-to-html.js

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 
 import yargs from 'yargs';
-/* eslint-disable-next-line node/file-extension-in-import */
 import { hideBin } from 'yargs/helpers';
 
 import { getConfig } from '../lib/file-utils.js';
@@ -15,22 +14,22 @@ const { argv } = yargs(hideBin(process.argv))
     alias: 'configPath',
     describe: 'Path to config file',
     default: './config.json',
-    type: 'string'
+    type: 'string',
   })
   .option('s', {
     alias: 'skipImport',
     describe: 'Don’t import GTFS file.',
-    type: 'boolean'
+    type: 'boolean',
   })
   .default('skipImport', undefined)
   .option('t', {
     alias: 'showOnlyTimepoint',
     describe: 'Show only stops with a `timepoint` value in `stops.txt`',
-    type: 'boolean'
+    type: 'boolean',
   })
   .default('showOnlyTimepoint', undefined);
 
-const handleError = error => {
+const handleError = (error) => {
   const text = error || 'Unknown Error';
   process.stdout.write(`\n${formatError(text)}\n`);
   console.error(error);
@@ -43,5 +42,4 @@ const setupImport = async () => {
   process.exit();
 };
 
-setupImport()
-  .catch(handleError);
+setupImport().catch(handleError);

package/lib/file-utils.js

@@ -20,8 +20,15 @@ import * as templateFunctions from './template-functions.js';
  */
 export async function getConfig(argv) {
   try {
-    const data = await readFile(path.resolve(untildify(argv.configPath)), '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`));
+    const data = await readFile(
+      path.resolve(untildify(argv.configPath)),
+      '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`
+        )
+      );
       throw error;
     });
     const config = JSON.parse(data);
@@ -36,7 +43,11 @@ export async function getConfig(argv) {
 
     return config;
   } catch (error) {
-    console.error(new Error(`Cannot parse configuration file at \`${argv.configPath}\`. Check to ensure that it is valid JSON.`));
+    console.error(
+      new Error(
+        `Cannot parse configuration file at \`${argv.configPath}\`. Check to ensure that it is valid JSON.`
+      )
+    );
     throw error;
   }
 }
@@ -52,15 +63,21 @@ function getTemplatePath(templateFileName, config) {
   }
 
   if (config.templatePath !== undefined) {
-    return path.join(untildify(config.templatePath), `${fullTemplateFileName}.pug`);
+    return path.join(
+      untildify(config.templatePath),
+      `${fullTemplateFileName}.pug`
+    );
   }
 
-  return path.join(fileURLToPath(import.meta.url), '../../views/default', `${fullTemplateFileName}.pug`);
+  return path.join(
+    fileURLToPath(import.meta.url),
+    '../../views/default',
+    `${fullTemplateFileName}.pug`
+  );
 }
 
 /*
- * Prepare the specified directory for saving HTML timetables by deleting
- * everything and creating the expected folders.
+ * Prepare the specified directory for saving HTML timetables by deleting everything.
  */
 export async function prepDirectory(exportPath) {
   await rm(exportPath, { recursive: true, force: true });
@@ -68,7 +85,9 @@ export async function prepDirectory(exportPath) {
     await mkdir(exportPath, { recursive: true });
   } catch (error) {
     if (error.code === 'ENOENT') {
-      throw new Error(`Unable to write to ${exportPath}. Try running this command from a writable directory.`);
+      throw new Error(
+        `Unable to write to ${exportPath}. Try running this command from a writable directory.`
+      );
     }
 
     throw error;
@@ -79,7 +98,10 @@ 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');
+  const staticAssetPath = path.join(
+    fileURLToPath(import.meta.url),
+    '../../public'
+  );
   copydir.sync(path.join(staticAssetPath, 'css'), path.join(exportPath, 'css'));
   copydir.sync(path.join(staticAssetPath, 'js'), path.join(exportPath, 'js'));
 }
@@ -96,7 +118,7 @@ export function zipFolder(exportPath) {
     archive.on('error', reject);
     archive.pipe(output);
     archive.glob('**/*.{txt,css,js,html}', {
-      cwd: exportPath
+      cwd: exportPath,
     });
     archive.finalize();
   });
@@ -109,7 +131,9 @@ export function generateFileName(timetable, config) {
   let filename = timetable.timetable_id;
 
   for (const route of timetable.routes) {
-    filename += isNullOrEmpty(route.route_short_name) ? `_${route.route_long_name.replace(/\s/g, '-')}` : `_${route.route_short_name.replace(/\s/g, '-')}`;
+    filename += isNullOrEmpty(route.route_short_name)
+      ? `_${route.route_long_name.replace(/\s/g, '-')}`
+      : `_${route.route_short_name.replace(/\s/g, '-')}`;
   }
 
   if (!isNullOrEmpty(timetable.direction_id)) {
@@ -121,6 +145,19 @@ export function generateFileName(timetable, config) {
   return sanitize(filename).toLowerCase();
 }
 
+/*
+ * Generate the filename for a CSV timetable.
+ */
+export function generateCSVFileName(timetable, timetablePage) {
+  let filename = timetablePage.filename.replace(/.html$/, '');
+
+  if (timetablePage.timetables.length > 1) {
+    filename += `_${timetable.direction_id}`;
+  }
+
+  return sanitize(`${filename}.csv`);
+}
+
 /*
  * Generates the folder name for a timetable page based on the date.
  */
@@ -144,13 +181,13 @@ export async function renderTemplate(templateFileName, templateVars, config) {
   const html = await renderFile(templatePath, {
     _,
     ...templateFunctions,
-    ...templateVars
+    ...templateVars,
   });
 
   // Beautify HTML if `beautify` is set in config.
   if (config.beautify === true) {
     return beautify.html_beautify(html, {
-      indent_size: 2
+      indent_size: 2,
     });
   }
 
@@ -166,10 +203,10 @@ export async function renderPdf(htmlPath) {
   const page = await browser.newPage();
   await page.emulateMediaType('screen');
   await page.goto(`file://${htmlPath}`, {
-    waitUntil: 'networkidle0'
+    waitUntil: 'networkidle0',
   });
   await page.pdf({
-    path: pdfPath
+    path: pdfPath,
   });
 
   await browser.close();