CLI + utilities for bulletproof email development and testing
npm install makemail> makemail currently only supports building template with mjml and handlebars. Check out the examples section for more info.
``bash`
npm install makemail
Create a makemail.yml config file
`bash`
makemail init
Run on root dir
`bash`
makemail dev
Run a specific folder - good for separating workspaces with different makemail.yml configs.
`bash`
makemail dev my-folder/
Or tell makemail where to look for input files
`bash`
makemail dev -f my-other-folder/src
Compile all files for production
`bash`
makemail prod
Compile a specific file for production
`bash`
makemail prod -f my-folder/index.mjml
All options
`bash
$ makemail --help
Usage: makemail [options] [command]
CLI for makemail
Options:
-V, --version output the version number
-v --verbose verbose output
-f --files
-w --watch watch for changes
--settings
-s --src
-i --input
-o --output
-l --locales
-D --delete-out-dir delete the output directory before
compiling
-b --browser-sync start browser-sync
-B --browser-sync-options
--no-open do not open browser-sync window on start
--port
--start-path
-u, --upload upload files and assets to s3 if not
already uploaded
--force-upload force upload assets to s3 (even if they
already exist)
--bucket
--region
--omit-default-locale omit the default locale from the file
name
--env-path
-h, --help display help for command
Commands:
init step-by-step setup a new project
dev [workspace] compile templates to html
prod [workspace] compile templates to html, minify,
inline css, etc.
help [command] display help for command
$3
Available helpers:
typescript
t
description: used to output the correct text based on the locale
usage: {{t "hello" "hola" "bonjour"}}// The above was auto-generated by running
$3
Check out the example project in example/
Developing
From root...
bash
npm install
`Then run one of these:
bash
from package.json 'scripts'
npm run compile # Compile the source code
npm run compile:watch # Compile the source code and watch for changes
npm run test # Run the tests (todo)
npm run prepare # runs: husky installThe above was auto-generated by running
$3
There are bunch of scripts in here that aid in developing docs and doing other chores. It is called in a pre-commit hook.
Misc.
Special shoutouts:
- Repo set up with help from npm-ts-workspaces-example
- CLI inspired by this tutorial
#### To-do:
- [x] prettier/eslint config for consistency
- [ ] Test with not-exact image sizes
- [ ] Docker
- [ ] Use workspace name to create bucket
- [ ] .env file should be discoverable even when workspace is set in cli args
- [ ] BUG:
#### Roadmap:
- [x] parse yaml frontmatter in templates for handlebars/mjml config + context
- [x] i18n config
- [ ] prod/preview script
- [x] upload html file to s3 + replace URLS in template
- [x] upload assets to S3 + replace URLS in template
- [ ] resize assets
- [ ] with flag, upload html to EmailOnAcid/Litmus + return URL to test on all screens (pending API approval for testing)