Tommy: web assets optimverter

Tommy will process, optimize and convert all your static assets ready to use for the web.

Arguments

• --src specify the source directory (where your assets are located)
• --dst specify the destination directory (where your assets will be generated)

Optional argumenmts

• --force regenerate all assets ignoring cache
• --config specify a JSON file containing an extension to the configuration
• --webserver will spawn an HTTP webserver that access via POST / a request to run
• --port is the webserver port (default: 80)
• --watch will enable a persistent watch over the src directory to detect instant file changes

⚡️️️ Always set --dst option to an empty directory: this directory should only be used by Tommy because files in could be potentially deleted if Tommy is started with a weird configuration or a corrupted database ⚡️

How to: run with Docker

The main advantage of using Tommy is that all dependencies used to process/convert entities are encapsulated into a docker image.

For this reason, you should use the docker run command to use Tommy in the original way it was created.

docker run \
-v "$(pwd)/test/src":/src \
-v "$(pwd)/test/dst":/dst \
-v "$(pwd)/config.json:/root/config.json" \
kopiro/tommy:latest \
--src /src \
--dst /dst \
--config /root/config.json

Explanation of mounts:

• -v "$(pwd)/test/src":/src mount the source directory (where your assets are located) into container /src
• -v "$(pwd)/test/dst":/dst mount the destination directory (where your assets will be generated) into container /dst
• -v "$(pwd)/config.json:/root/config.json" mount your (optional) configuration JSON file into container /root/config.json

How to: run in MacOS

You can also use the native NPM package on OSX.

Installation

npm -g i kopiro-tommy

Run

tommy --src ./test/src --dst ./test/dst

Configuration

By providing a JSON file to --config, you configuration will be extended with the default one.

tommy --config config.json

Example:

{
  "processor.resize": {
    "enabled": false
  },
  "processor.resize": {
    "enabled": true,
    "suffix": "-resized-${i}.${ext}",
    "dimensions": [100, 300],
    "quality": 60
  },
  "ignore": [".dockerignore"]
}

First-level keys

Available services

Images

Videos

Fonts

Audios

Disabling service

By settings enabled: false in a key, you'll disable that service.

...
"processor.resize": {
   "enabled": false
}
...

Specific configurations for services

processor.resize

processor.image

processor.videoThumbs

processor.lazyLoadBlurried

processor.poster

processor.favicon

convert.{webm,*_mp4}

These are the general settings used for video. You can override manually in every section

converter.webm

converter.h264_mp4

converter.av1_mp4

converter.hvec_mp4

Howto: testing locally

You can use the command npm run test-docker to build the image and test against a test directory.

If you need samples, run npm run download-samples

License

MIT