gtfs-to-html 2.4.0 → 2.4.1

package/CHANGELOG.md

@@ -5,6 +5,14 @@ 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.4.1] - 2022-07-10
+
+### Updated
+
+- Update Dockerfile to node 16
+- Dependency updates
+- Use yoctocolors instead of chalk
+
 ## [2.4.0] - 2022-06-07
 
 ### Updated

package/docker/Dockerfile

@@ -1,5 +1,5 @@
 # syntax=docker/dockerfile:1
-FROM node:14
+FROM node:16
 
 RUN apt update
 RUN apt install -y chromium

package/lib/log-utils.js

@@ -1,7 +1,7 @@
 import { clearLine, cursorTo } from 'node:readline';
 import PrettyError from 'pretty-error';
 import { noop } from 'lodash-es';
-import chalk from 'chalk';
+import * as colors from 'yoctocolors';
 import { getFeedInfo } from 'gtfs';
 import Table from 'cli-table';
 
@@ -99,19 +99,20 @@ export function logError(config) {
  * Format console warning text
  */
 export function formatWarning(text) {
-  return `${chalk.yellow.underline('Warning')}${chalk.yellow(
-    ':'
-  )} ${chalk.yellow(text)}`;
+  const warningMessage = `${colors.underline('Warning')}: ${text}`;
+  return colors.yellow(warningMessage);
 }
 
 /*
  * Format console error text
  */
 export function formatError(error) {
-  const message = error instanceof Error ? error.message : error;
-  return `${chalk.red.underline('Error')}${chalk.red(':')} ${chalk.red(
-    message.replace('Error: ', '')
+  const messageText = error instanceof Error ? error.message : error;
+  const errorMessage = `${colors.underline('Error')}: ${messageText.replace(
+    'Error: ',
+    ''
   )}`;
+  return colors.red(errorMessage);
 }
 
 /*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-html",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "private": false,
   "description": "Build human readable transit timetables as HTML, PDF or CSV from GTFS",
   "keywords": [
@@ -38,15 +38,14 @@
     "@turf/helpers": "^6.5.0",
     "@turf/simplify": "^6.5.0",
     "archiver": "^5.3.1",
-    "chalk": "^5.0.1",
     "cli-table": "^0.3.11",
     "copy-dir": "^1.3.0",
-    "csv-stringify": "^6.1.0",
+    "csv-stringify": "^6.1.3",
     "express": "^4.18.1",
-    "gtfs": "^3.3.1",
-    "js-beautify": "^1.14.3",
+    "gtfs": "^3.5.0",
+    "js-beautify": "^1.14.4",
     "lodash-es": "^4.17.21",
-    "moment": "^2.29.3",
+    "moment": "^2.29.4",
     "morgan": "^1.10.0",
     "pretty-error": "^4.0.0",
     "pug": "^3.0.2",
@@ -56,14 +55,15 @@
     "timer-machine": "^1.1.0",
     "toposort": "^2.0.2",
     "untildify": "^4.0.0",
-    "yargs": "^17.5.1"
+    "yargs": "^17.5.1",
+    "yoctocolors": "^1.0.0"
   },
   "devDependencies": {
-    "eslint": "^8.17.0",
+    "eslint": "^8.19.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-xo": "^0.41.0",
     "husky": "^8.0.1",
-    "prettier": "^2.6.2",
+    "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3"
   },
   "engines": {

package/www/docs/configuration.md

@@ -490,7 +490,7 @@ The default trip-sorting algorithm is `common`.
 
 ### sqlitePath
 
-{String} A path to an SQLite database. Optional, defaults to using an in-memory database with a value of `:memory:`. If you want the data imported to persist, you need to specify a value for `sqlitePath`
+{String} A path to an SQLite database. Optional, defaults to using an in-memory database with a value of `:memory:`. If you want the data imported to persist, you need to specify a value for `sqlitePath`. Supports tilde as part of the path, like `~/Documents/gtfs`.
 
 ```
     "sqlitePath": "/tmp/gtfs"

package/www/docs/quick-start.md

@@ -29,7 +29,6 @@ Skips importing GTFS into SQLite. Useful if you are rerunning with an unchanged
 
     gtfs-to-html --skipImport
 
-
 ### Processing very large GTFS files.
 
 By default, node has a memory limit of 512 MB or 1 GB. If you have a very large GTFS file and want to use the option `showOnlyTimepoint` = `false` you may need to allocate more memory. Use the `max-old-space-size` option. For example to allocate 4 GB:
@@ -44,17 +43,17 @@ You can use both [`docker`](https://docker.com) and [`docker-compose`](https://d
 
 A `Dockerfile` is available in the `docker` directory.
 
-* Create a `config.json` file and save in the same directory as your `Dockerfile`. You can use `config-sample.json` from the project root as a starting point.
+- Create a `config.json` file and save in the same directory as your `Dockerfile`. You can use `config-sample.json` from the project root as a starting point. For Docker usage, remove any `sqlitePath` and `templatePath` values from the config.json.
 
-* Build the docker image:
+- Build the docker image:
 
         docker build -t gtfs-to-html .
 
-* Run the docker image:
+- Run the docker image:
 
         docker run gtfs-to-html
 
-* Copy the generated HTML out of the docker container
+- Copy the generated HTML out of the docker container
 
         // Figure out what your container ID is
         docker container ls -a
@@ -69,17 +68,16 @@ A `Dockerfile` is available in the `docker` directory.
 
 Docker compose is used for multi-container Docker applications. In this context, it is just a convenient way to manage volumes. This allows (_i_) to get the generated HTML out of the docker container without explicitly copying with `docker cp`, and (_ii_) to tweak and run a new configuration without rebuilding the container from scratch.
 
-* Create a `config.json` file and save in the same directory as your `Dockerfile` and `docker-compose.yml`;
+- Create a `config.json` file and save in the same directory as your `Dockerfile` and `docker-compose.yml`;
 
-* build and run the container:
+- build and run the container:
 
         docker-compose up
 
-* the generated HTML will be available in the folder `html` next to docker files.
+- the generated HTML will be available in the folder `html` next to docker files.
 
 Do you want to change something? Just delete the old HTML, change your `config.json`, and finally run `docker-compose up` again.
 
-
 ## Usage as a node module
 
 If you are using this as a node module as part of an application, you can include it in your project's `package.json` file.
@@ -87,22 +85,25 @@ If you are using this as a node module as part of an application, you can includ
 ### Code example
 
 ```javascript
-    import gtfsToHtml from 'gtfs-to-html';
-    import { readFile } from 'fs/promises';
-    const config = JSON.parse(await readFile(new URL('./config.json', import.meta.url)));
-
-    gtfsToHtml(config)
-    .then(() => {
-      console.log('HTML Generation Successful');
-      process.exit();
-    })
-    .catch(err => {
-      console.error(err);
-      process.exit(1);
-    });
+import gtfsToHtml from 'gtfs-to-html';
+import { readFile } from 'fs/promises';
+const config = JSON.parse(
+  await readFile(new URL('./config.json', import.meta.url))
+);
+
+gtfsToHtml(config)
+  .then(() => {
+    console.log('HTML Generation Successful');
+    process.exit();
+  })
+  .catch((err) => {
+    console.error(err);
+    process.exit(1);
+  });
 ```
 
 ### Example Application
+
 An example Express application that uses `gtfs-to-html` is included in the `app` folder. After an initial run of `gtfs-to-html`, the GTFS data will be downloaded and loaded into SQLite.
 
 You can view an individual route HTML on demand by running the included Express app:
@@ -115,17 +116,16 @@ By default, `gtfs-to-html` will look for a `config.json` file in the project roo
 
 Once running, you can view the HTML in your browser at [localhost:3000](http://localhost:3000)
 
-
 ## Usage as a hosted web app
 
 A [hosted version of GTFS-to-HTML as a service](https://run.gtfstohtml.com) allows you to use it entirely within your browser - no downloads or command line necessary.
 
 It provides:
 
-* a web-based interface for finding GTFS feeds or ability to enter your own URL
-* support for adding [custom configuration](/docs/configuration) as JSON
-* creation of HTML timetables as a downloadable .zip file
-* a preview of all timetables generated directly in your browser
+- a web-based interface for finding GTFS feeds or ability to enter your own URL
+- support for adding [custom configuration](/docs/configuration) as JSON
+- creation of HTML timetables as a downloadable .zip file
+- a preview of all timetables generated directly in your browser
 
 [run.gtfstohtml.com](https://run.gtfstohtml.com)
 
@@ -136,8 +136,8 @@ Currently, it is limited to relatively small GTFS files and doesn't offer suppor
 ### SQLite3 unable to be installed with `Failed to exec install script`
 
 For an error like:
-```lifecycle sqlite3@5.0.0~install: Failed to exec install script```
+`lifecycle sqlite3@5.0.0~install: Failed to exec install script`
 
 Try installing `gtfs-to-html` using the following flags:
 
-```npm install --unsafe-perm --allow-root -g```
+`npm install --unsafe-perm --allow-root -g`

package/www/package.json

@@ -9,11 +9,11 @@
     "deploy": "docusaurus deploy"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.21",
-    "@docusaurus/preset-classic": "^2.0.0-beta.21",
-    "clsx": "^1.1.1",
-    "react": "^18.1.0",
-    "react-dom": "^18.1.0"
+    "@docusaurus/core": "^2.0.0-beta.22",
+    "@docusaurus/preset-classic": "^2.0.0-beta.22",
+    "clsx": "^1.2.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "browserslist": {
     "production": [

package/www/src/pages/index.js

@@ -7,7 +7,6 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import CodeBlock from '@theme/CodeBlock';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import styles from './styles.module.css';
-import { hsl } from 'chalk';
 
 const features = [
   {
@@ -15,28 +14,32 @@ const features = [
     imageUrl: 'img/undraw_proud_coder.svg',
     description: (
       <>
-        Most transit agencies have schedule data in GTFS format but need to show each route's schedule to users on a website.
+        Most transit agencies have schedule data in GTFS format but need to show
+        each route's schedule to users on a website.
       </>
-    )
+    ),
   },
   {
     title: <>What?</>,
     imageUrl: 'img/undraw_spreadsheets.svg',
     description: (
       <>
-        This tool automates the process of creating nicely formatted HTML timetables for inclusion on a transit agency website.
+        This tool automates the process of creating nicely formatted HTML
+        timetables for inclusion on a transit agency website.
       </>
-    )
+    ),
   },
   {
     title: <>Automate schedule changes</>,
     imageUrl: 'img/undraw_happy_music.svg',
     description: (
       <>
-        Automating timetable creation means that timetables can be kept up to date and accurate when schedule changes happen and the likelihood of errors is reduced.
+        Automating timetable creation means that timetables can be kept up to
+        date and accurate when schedule changes happen and the likelihood of
+        errors is reduced.
       </>
-    )
-  }
+    ),
+  },
 ];
 
 function Feature({ imageUrl, title, description }) {
@@ -60,25 +63,35 @@ function Home() {
   return (
     <Layout
       title="GTFS-to-HTML"
-      description="GTFS-to-HTML creates human-readable, user-friendly transit timetables in HTML format directly from GTFS transit data.">
+      description="GTFS-to-HTML creates human-readable, user-friendly transit timetables in HTML format directly from GTFS transit data."
+    >
       <header className={clsx('hero hero--dark', styles.heroBanner)}>
         <div className="container">
           <div className="row">
             <div className="col col--4">
-              <img src="/img/gtfs-to-html-logo.svg" style={{ maxWidth: '150px' }} alt="" />
+              <img
+                src="/img/gtfs-to-html-logo.svg"
+                style={{ maxWidth: '150px' }}
+                alt=""
+              />
             </div>
 
             <div className="col col--8">
               <h1 className="hero__title">{siteConfig.title}</h1>
               <p className="hero__subtitle">{siteConfig.tagline}</p>
-              <img alt="npm" src="https://img.shields.io/npm/v/gtfs-to-html?color=%2325c2a0&amp;label=stable&amp;style=for-the-badge" className="margin-bottom--sm" />
+              <img
+                alt="npm"
+                src="https://img.shields.io/npm/v/gtfs-to-html?color=%2325c2a0&amp;label=stable&amp;style=for-the-badge"
+                className="margin-bottom--sm"
+              />
               <div className={styles.buttons}>
                 <Link
                   className={clsx(
                     'button button--outline button--secondary button--lg',
                     styles.heroButton
                   )}
-                  to={useBaseUrl('docs/')}>
+                  to={useBaseUrl('docs/')}
+                >
                   Get Started
                 </Link>
               </div>
@@ -99,19 +112,44 @@ function Home() {
           </section>
         )}
 
-        <section style={{backgroundColor: 'hsl(0, 0%, 85%)'}} className="padding--lg">
+        <section
+          style={{ backgroundColor: 'hsl(0, 0%, 85%)' }}
+          className="padding--lg"
+        >
           <div className="container">
             <div className="row">
               <div className="col"></div>
               <div className="col">
                 <div className="avatar avatar--vertical margin-bottom--sm">
                   <div className="avatar__photo avatar__photo--xl">
-                    <img src="https://avatars.githubusercontent.com/u/46612183?v=4" alt="Brody" width="200" height="200" style={{width: '100%', height: 'auto', maxWidth: '100%', marginBottom: '-4px'}} /></div>
-                  <div className="avatar__intro padding-top--sm"><div className="avatar__name">Brody</div>
-                    <small className="avatar__subtitle"><a href="https://github.com/transcollines">Transcollines</a></small>
+                    <img
+                      src="https://avatars.githubusercontent.com/u/46612183?v=4"
+                      alt="Brody"
+                      width="200"
+                      height="200"
+                      style={{
+                        width: '100%',
+                        height: 'auto',
+                        maxWidth: '100%',
+                        marginBottom: '-4px',
+                      }}
+                    />
+                  </div>
+                  <div className="avatar__intro padding-top--sm">
+                    <div className="avatar__name">Brody</div>
+                    <small className="avatar__subtitle">
+                      <a href="https://github.com/transcollines">
+                        Transcollines
+                      </a>
+                    </small>
                   </div>
                 </div>
-                <p className="text--center text--italic padding-horiz--md">It's been a huge success. Not only do the timetables look fantastic, but I've had customer service agents tell me the interactive timetables are a total game changer and they make their jobs way easier.</p>
+                <p className="text--center text--italic padding-horiz--md">
+                  It's been a huge success. Not only do the timetables look
+                  fantastic, but I've had customer service agents tell me the
+                  interactive timetables are a total game changer and they make
+                  their jobs way easier.
+                </p>
               </div>
               <div className="col"></div>
             </div>