gtfs-to-html 2.7.2 → 2.8.1

package/app/index.js

@@ -1,138 +0,0 @@
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-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 {
-  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 selectedConfig = JSON.parse(readFileSync(configPath));
-
-const config = setDefaultConfig(selectedConfig);
-// Override noHead config option so full HTML pages are generated
-config.noHead = false;
-config.assetPath = '/';
-config.log = console.log;
-config.logWarning = console.warn;
-config.logError = console.error;
-
-try {
-  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.`,
-    );
-  }
-
-  throw error;
-}
-
-/*
- * Show all timetable pages
- */
-router.get('/', async (request, response, next) => {
-  try {
-    const timetablePages = [];
-    const timetablePageIds = map(
-      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}`,
-        );
-      }
-
-      timetablePage.relativePath = `/timetables/${timetablePage.timetable_page_id}`;
-      for (const timetable of timetablePage.consolidatedTimetables) {
-        timetable.timetable_label = formatTimetableLabel(timetable);
-      }
-
-      timetablePages.push(timetablePage);
-    }
-
-    const html = await generateOverviewHTML(timetablePages, config);
-    response.send(html);
-  } catch (error) {
-    console.error(error);
-    next(error);
-  }
-});
-
-/*
- * Show a specific timetable page
- */
-router.get('/timetables/:timetablePageId', async (request, response, next) => {
-  const { timetablePageId } = request.params;
-
-  if (!timetablePageId) {
-    return next(new Error('No timetablePageId provided'));
-  }
-
-  try {
-    const timetablePage = await getFormattedTimetablePage(
-      timetablePageId,
-      config,
-    );
-
-    const html = await generateTimetableHTML(timetablePage, config);
-    response.send(html);
-  } catch (error) {
-    next(error);
-  }
-});
-
-app.set('views', path.join(fileURLToPath(import.meta.url), '../../views'));
-app.set('view engine', 'pug');
-
-app.use(logger('dev'));
-
-// 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);
-
-const server = app.listen(app.get('port'), () => {
-  console.log(`Express server listening on port ${server.address().port}`);
-});

package/bin/gtfs-to-html.js

@@ -1,48 +0,0 @@
-#!/usr/bin/env node
-
-import yargs from 'yargs';
-import { hideBin } from 'yargs/helpers';
-import PrettyError from 'pretty-error';
-
-import { getConfig } from '../lib/file-utils.js';
-import { formatError } from '../lib/log-utils.js';
-import gtfsToHtml from '../index.js';
-
-const pe = new PrettyError();
-
-const { argv } = yargs(hideBin(process.argv))
-  .usage('Usage: $0 --configPath ./config.json')
-  .help()
-  .option('c', {
-    alias: 'configPath',
-    describe: 'Path to config file',
-    default: './config.json',
-    type: 'string',
-  })
-  .option('s', {
-    alias: 'skipImport',
-    describe: 'Don’t import GTFS file.',
-    type: 'boolean',
-  })
-  .default('skipImport', undefined)
-  .option('t', {
-    alias: 'showOnlyTimepoint',
-    describe: 'Show only stops with a `timepoint` value in `stops.txt`',
-    type: 'boolean',
-  })
-  .default('showOnlyTimepoint', undefined);
-
-const handleError = (error) => {
-  const text = error || 'Unknown Error';
-  process.stdout.write(`\n${formatError(text)}\n`);
-  console.error(pe.render(error));
-  process.exit(1);
-};
-
-const setupImport = async () => {
-  const config = await getConfig(argv);
-  await gtfsToHtml(config);
-  process.exit();
-};
-
-setupImport().catch(handleError);

package/config-sample.json

@@ -1,59 +0,0 @@
-{
-  "agencies": [
-    {
-      "agency_key": "bart",
-      "url": "http://www.bart.gov/dev/schedules/google_transit.zip"
-    }
-  ],
-  "sqlitePath": "/tmp/gtfs",
-  "allowEmptyTimetables": false,
-  "beautify": false,
-  "coordinatePrecision": 5,
-  "dateFormat": "MMM D, YYYY",
-  "daysShortStrings": ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"],
-  "daysStrings": [
-    "Monday",
-    "Tuesday",
-    "Wednesday",
-    "Thursday",
-    "Friday",
-    "Saturday",
-    "Sunday"
-  ],
-  "defaultOrientation": "vertical",
-  "effectiveDate": "July 8, 2016",
-  "interpolatedStopSymbol": "•",
-  "interpolatedStopText": "Estimated time of arrival",
-  "linkStopUrls": false,
-  "mapboxAccessToken": "YOUR MAPBOX ACCESS TOKEN",
-  "menuType": "jump",
-  "noDropoffSymbol": "‡",
-  "noDropoffText": "No drop off available",
-  "noHead": false,
-  "noPickupSymbol": "**",
-  "noPickupText": "No pickup available",
-  "noServiceSymbol": "—",
-  "noServiceText": "No service at this stop",
-  "outputFormat": "html",
-  "requestDropoffSymbol": "†",
-  "requestDropoffText": "Must request drop off",
-  "requestPickupSymbol": "***",
-  "requestPickupText": "Request stop - call for pickup",
-  "serviceNotProvidedOnText": "Service not provided on",
-  "serviceProvidedOnText": "Service provided on",
-  "showArrivalOnDifference": 0.2,
-  "showCalendarExceptions": true,
-  "showMap": true,
-  "showOnlyTimepoint": true,
-  "showRouteTitle": true,
-  "showStopCity": false,
-  "showStopDescription": false,
-  "showStoptimesForRequestStops": true,
-  "skipImport": false,
-  "sortingAlgorithm": "common",
-  "templatePath": "views/default",
-  "timeFormat": "h:mma",
-  "useParentStation": true,
-  "verbose": true,
-  "zipOutput": false
-}

package/docker/Dockerfile

@@ -1,14 +0,0 @@
-# syntax=docker/dockerfile:1
-FROM node:20
-
-RUN apt update
-RUN apt install -y chromium
-
-RUN cd ~/
-COPY config.json ./
-
-ENV NPM_CONFIG_PREFIX=/home/node/.npm-global
-ENV PATH=$PATH:/home/node/.npm-global/bin
-RUN npm install -g gtfs-to-html
-
-CMD [ "gtfs-to-html" ]

package/docker/README.md

@@ -1,5 +0,0 @@
-# Docker area 🐳
-
-Use the files contained in this folder to run GTFS-to-HTML with `docker` (or `docker-compose`).
-
-Read more in the documentation.

package/docker/docker-compose.yml

@@ -1,10 +0,0 @@
-version: '3'
-
-services:
-  gtfs-to-html:
-    image: gtfs-to-html
-    build:
-      context: .
-    volumes:
-      - ./html:/html
-      - ./config.json:/config.json

package/examples/stop_attributes.txt

@@ -1,6 +0,0 @@
-stop_id,stop_city
-1001,"Fresno, CA"
-1002,"Fresno, CA"
-1003,"Hanford, CA"
-1004,"Hanford, CA"
-1005,"Lemoore, CA"

package/examples/timetable_notes.txt

@@ -1,8 +0,0 @@
-note_id,symbol,note
-1,,"No service during baseball games"
-2,,"No express service during a full moon"
-3,,"Trip is cancelled if drawbridge is up"
-4,,"This stop is sometimes underwater"
-5,,"Driver will only stop if prearranged by fax"
-6,§,"Vehicle can arrive early if leap second is added during trip and *will not wait*"
-7,,"[See list of holidays](http://transitagency.org/holidays)"

package/examples/timetable_notes_references.txt

@@ -1,8 +0,0 @@
-note_id,timetable_id,route_id,trip_id,stop_id,stop_sequence,show_on_stoptime
-1,131,,,,,
-2,,17,,,,
-3,,,17010,,,1
-4,,,,254514,,
-5,,,,254514,11,
-6,,,17010,235269,,
-7,131,,,,,

package/examples/timetable_pages.txt

@@ -1,3 +0,0 @@
-timetable_page_id,timetable_page_label,filename
-1,"Cloverdale, Healdsburg, Windsor, Santa Rosa","60.html"
-2,"Sebastopol, Rohnert Park, Cotati","26.html"

package/examples/timetable_stop_order.txt

@@ -1,16 +0,0 @@
-timetable_id,stop_id,stop_sequence
-1,757717,0
-1,757722,1
-1,757728,2
-1,757668,3
-1,757751,4
-1,757683,5
-1,757689,6
-1,757691,7
-1,757692,8
-1,757700,9
-1,757703,10
-1,757068,11
-1,757074,12
-1,757080,13
-1,757277,14

package/examples/timetables.txt

@@ -1,9 +0,0 @@
-timetable_id,route_id,direction_id,start_date,end_date,monday,tuesday,wednesday,thursday,friday,saturday,sunday,start_time,end_time,include_exceptions,timetable_label,service_notes,orientation,timetable_page_id,timetable_sequence,direction_name,show_trip_continuation
-0,2034,0,20150101,20151122,1,1,1,1,1,1,0,00:00:00,13:00:00,0,101 Northbound,Mon-Sat AM,horizontal,1,0,Northbound,0
-1,2034,0,20150101,20151122,1,1,1,1,1,1,0,13:00:00,24:00:00,0,101 Northbound,Mon-Sat PM,horizontal,1,1,Northbound,0
-2,2035,1,20150819,20151122,1,1,0,1,1,0,0,,,0,101T Northbound,"Mon,Tue,Thur,Fri",horizontal,1,0,Northbound,0
-3,2035,0,20150819,20151122,0,0,1,0,0,0,0,,,0,101T Southbound,Wednesday,horizontal,1,0,Southbound,0
-4,2036,1,20150101,20151122,0,0,0,0,0,0,1,,,0,102 Eastbound,Sunday,horizontal,1,0,Eastbound,0
-5,2036,0,20150101,20151122,1,1,1,1,1,0,0,,,0,102 Westbound,Mon-Fri,horizontal,1,0,Westbound,0
-6,2036,1,20150101,20151122,0,0,0,0,0,1,0,,,0,102 Eastbound,Saturday,horizontal,1,0,Eastbound,0
-7,2037,0,20150101,20151122,1,1,1,1,1,0,0,,,0,103 Westbound,Mon-Fri,horizontal,1,0,Westbound,0

package/index.js

@@ -1 +0,0 @@
-export { default } from './lib/gtfs-to-html.js';

package/lib/file-utils.js

@@ -1,202 +0,0 @@
-import path from 'node:path';
-import { createWriteStream } from 'node:fs';
-import { fileURLToPath } from 'node:url';
-import { readFile, rm, mkdir } from 'node:fs/promises';
-
-import copydir from 'copy-dir';
-import _ from 'lodash-es';
-import archiver from 'archiver';
-import beautify from 'js-beautify';
-import { renderFile } from 'pug';
-import puppeteer from 'puppeteer';
-import sanitize from 'sanitize-filename';
-import untildify from 'untildify';
-import insane from 'insane';
-import { marked } from 'marked';
-
-import {
-  isNullOrEmpty,
-  formatDays,
-  formatRouteColor,
-  formatRouteTextColor,
-} from './formatters.js';
-import * as templateFunctions from './template-functions.js';
-
-/*
- * Attempt to parse the specified config JSON file.
- */
-export async function getConfig(argv) {
-  let data;
-  let config;
-
-  try {
-    data = await readFile(path.resolve(untildify(argv.configPath)), 'utf8');
-  } catch (error) {
-    throw new Error(
-      `Cannot find configuration file at \`${argv.configPath}\`. Use config-sample.json as a starting point, pass --configPath option`,
-    );
-  }
-
-  try {
-    config = JSON.parse(data);
-  } catch (error) {
-    throw new Error(
-      `Cannot parse configuration file at \`${argv.configPath}\`. Check to ensure that it is valid JSON.`,
-    );
-  }
-
-  if (argv.skipImport === true) {
-    config.skipImport = argv.skipImport;
-  }
-
-  if (argv.showOnlyTimepoint === true) {
-    config.showOnlyTimepoint = argv.showOnlyTimepoint;
-  }
-
-  return config;
-}
-
-/*
- * Get the full path of the template file for generating timetables based on
- * config.
- */
-function getTemplatePath(templateFileName, config) {
-  let fullTemplateFileName = templateFileName;
-  if (config.noHead !== true) {
-    fullTemplateFileName += '_full';
-  }
-
-  const templatePath =
-    config.templatePath === undefined
-      ? path.join(fileURLToPath(import.meta.url), '../../views/default')
-      : untildify(config.templatePath);
-
-  return path.join(templatePath, `${fullTemplateFileName}.pug`);
-}
-
-/*
- * Prepare the specified directory for saving HTML timetables by deleting everything.
- */
-export async function prepDirectory(exportPath) {
-  await rm(exportPath, { recursive: true, force: true });
-  try {
-    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 error;
-  }
-}
-
-/*
- * Copy needed CSS and JS to export path.
- */
-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'));
-}
-
-/*
- * Zips the content of the specified folder.
- */
-export function zipFolder(exportPath) {
-  const output = createWriteStream(path.join(exportPath, 'timetables.zip'));
-  const archive = archiver('zip');
-
-  return new Promise((resolve, reject) => {
-    output.on('close', resolve);
-    archive.on('error', reject);
-    archive.pipe(output);
-    archive.glob('**/*.{txt,css,js,html}', {
-      cwd: exportPath,
-    });
-    archive.finalize();
-  });
-}
-
-/*
- * Generate the filename for a given timetable.
- */
-export function generateFileName(timetable, config, extension = 'html') {
-  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, '-')}`;
-  }
-
-  if (!isNullOrEmpty(timetable.direction_id)) {
-    filename += `_${timetable.direction_id}`;
-  }
-
-  filename += `_${formatDays(timetable, config).replace(/\s/g, '')}.${extension}`;
-
-  return sanitize(filename).toLowerCase();
-}
-
-/*
- * Generates the folder name for a timetable page based on the date.
- */
-export function generateFolderName(timetablePage) {
-  // Use first timetable in timetable page for start date and end date
-  const timetable = timetablePage.consolidatedTimetables[0];
-  if (!timetable.start_date || !timetable.end_date) {
-    return 'timetables';
-  }
-
-  return sanitize(`${timetable.start_date}-${timetable.end_date}`);
-}
-
-/*
- * Render the HTML for a timetable based on the config.
- */
-export async function renderTemplate(templateFileName, templateVars, config) {
-  const templatePath = getTemplatePath(templateFileName, config);
-
-  // Make template functions, lodash and marked available inside pug templates.
-  const html = await renderFile(templatePath, {
-    _,
-    md: (text) => insane(marked.parseInline(text)),
-    ...templateFunctions,
-    formatRouteColor,
-    formatRouteTextColor,
-    ...templateVars,
-  });
-
-  // Beautify HTML if `beautify` is set in config.
-  if (config.beautify === true) {
-    return beautify.html_beautify(html, {
-      indent_size: 2,
-    });
-  }
-
-  return html;
-}
-
-/*
- * Render the PDF for a timetable based on the config.
- */
-export async function renderPdf(htmlPath) {
-  const pdfPath = htmlPath.replace(/html$/, 'pdf');
-  const browser = await puppeteer.launch();
-  const page = await browser.newPage();
-  await page.emulateMediaType('screen');
-  await page.goto(`file://${htmlPath}`, {
-    waitUntil: 'networkidle0',
-  });
-  await page.pdf({
-    path: pdfPath,
-  });
-
-  await browser.close();
-}