node package manager

mastarm

mastarm

NPM version Build status

Conveyal's front-end JavaScript tool-belt. Build, run, lint and deploy front-end code.

Table of Contents

Install

With node v6 and npm 3 installed:

$ npm install -g mastarm

Configuration

Mastarm can be pointed to a directory containing configuration files using the --config flag. It will fall back to files in the configurations/default path of the current working directory if one of the files below does not exist in config folder specified.

env.yml

This file should contain strings that can be replaced in front-end JavaScript code using envify. Example in Scenario Editor.

messages.yml

This file should contain string messages to be used throughout the application. It will replace process.env.MESSAGES with a string-ified version of the object. Just JSON.parse it on the client to have access to all of your messages.

settings.yml

Settings contain both Mastarm configuration settings and per environment settings to be used in the application and are usually duplicates of what can be passed from the command line. Current Mastarm settings are:

  • cloudfront {String} CloudFront distribution id that will automatically invalidate file paths after they are deployed to S3
  • entries {Array} input:output JavaScript & CSS file pairs
  • env {String} environment override
  • environments {Object} override top level settings (see example)
  • flyle {Boolean} serve map tiles from a local cache for working offline
  • s3bucket {String} bucket to deploy to
  • serve {Boolean} serve client side files via budo

store.yml

Auto-populate your redux store with this configuration data instead of setting defaults directly in code.

style.css

Add a stylesheet that gets @imported at the beginning of your entry stylesheet. This allows you to override styles for specific deployments and use custom CSS properties. Useful for configuration specific images and colors.

CLI Usage

Not all options pertain to all commands. Entries are in the format input/file.js:output/file.js.

$ mastarm --help
 
  Usage: mastarm <cmd> [options]
 
 
  Commands:
 
    build [entries...] [options]   Bundle JavaScript & CSS
    commit                         Force intelligent commit messages.
    deploy [entries...] [options]  Bundle & Deploy JavaScript & CSS
    lint [paths...]                Lint JavaScript [& CSS coming soon!]
    test [options]                 Run tests using Jest test runner
    lint-messages [paths...]       Lint message strings, making sure all messages used in source files are present in messages.yml
 
  Options:
 
    -h, --help                     output usage information
    -V, --version                  output the version number
    -c, --config <path>            Path to configuration files.
    -e, --env <environment>        Environment to use.
    -m, --minify                   Minify built files.
    -p, --proxy <address>          Proxy calls through to target address.
    -s, --serve                    Serve with budo. Auto-matically rebuilds on changes.
    -u, --update-snapshots         Force update of jest snapshots. USE WITH CAUTION.
    -w, --watch                    Rebuild on changes with watchify.

build

Compile JS, HTML, CSS, YAML, Markdown into a single .js. Utilizes babel, browserify, budo, and postcss.

$ mastarm build [options] [entries...]
 
  Options:
 
    -h, --help             output usage information
    -F, --flyle            Cache and serve tiles.
    -p, --proxy <address>  Proxy calls through to target address.
    -s, --serve            Serve with budo. Auto-matically rebuilds on changes.
    -w, --watch            Automatically rebuild on changes.

If no entries are provided, mastarm will use the entries option from your settings.yml config file. If no entries are found, build will not run.

CSS Building

CSS builds occur separately from the browserify build. Any CSS imports into a JavaScript file cause a build error. To build CSS file(s), specify the CSS file(s) as entries in the command. When running in serve or watch mode, the CSS files get automatically rebuilt, but a manual page refresh is necessary.

commit

Utilize best practices when forming a commit message using Commitzen & the Conventional Changelog standard.

deploy

Build, push to S3, and invalidate CloudFront in one command.

$ mastarm deploy --help
 
Usage: deploy [options] [entries...]
 
Bundle & Deploy JavaScript & CSS
 
Options:
 
  -h, --help    output usage information
  --cloudfront  CloudFront Distribution ID to invalidate.
  --s3bucket    S3 Bucket to push to.
 

Slack Notifications

To enable Slack notifications during the deploy process create a Slack Webhook and add two entries SLACK_WEBHOOK and SLACK_CHANNEL to your env.yml.

SLACK_CHANNEL: '#devops'
SLACK_WEBHOOK: https://hooks.slack.com/services/fake-code

lint

Lint using Standard. Everything is passed directly to standard-engine.

$ mastarm lint [paths...]

Optionally pass in a directory (or directories) using the glob pattern. Quote paths containing glob patterns so that they are expanded by standard instead of your shell:

$ mastarm lint "src/util/**/*.js" "test/**/*.js"

Note: by default standard will look for all files matching the patterns: "**/*.js", "**/*.jsx". Always quote the globs. Needed when used as an npm command.

prepublish

Transpile a library using Babel and our custom config. Usually used as a prepublish step for libraries written in ES6+ that will be published to NPM. Pass it a directory and it will look for .js files to transpile.

$ mastarm prepublish lib:build

test

Run the Jest test runner on your project. By default, mastarm will run Jest and generate coverage reports on all .js files in the lib folder of your project. The patterns argument will make Jest run only tests whose filename match the provided pattern.

$ mastarm test
 
Usage: test [options] [patterns...]
 
Run tests using Jest
 
Options:
 
  -h, --help                              output usage information
  -u, --update-snapshots                  Force update of snapshots. USE WITH CAUTION.
  --coverage                              Run Jest with coverage reporting
  --coverage-paths <paths>                Extra paths to collect code coverage from
  --no-cache                              Run Jest without cache (defaults to using cache)
  --run-in-band                           Run all tests serially in the current process
  --setup-files <paths>                   Setup files to run before each test
  --test-environment <env>                Jest test environment to use (Jest default is jsdom)
  --test-path-ignore-patterns <patterns>  File patterns to ignore when scanning for test files
 

lint-messages

$ mastarm lint-messages
 
Usage: lint-messages [options] [paths...]
 
Check that all messages used in source code are present in config. Pass in path to source file(s). Set the config with --config.
 

This checks to ensure that all of the messages referenced in JS code are defined in the messages.yml file. It defaults to using the messages in configurations/default/messages.yml, however a different config can be specified with --config. By default it will check the JS files in lib, but you can also pass in an arbitrary number of paths to directories or files to lint.

lint-messages is somewhat opinionated about how messages should be used in code. They should be imported from a local module called messages, and referred to using dot notation. It will work regardless of whether you import the top-level messages object or named children; the following all work:

import messages from '../utils/messages'
import msgs from './messages'
import { analysis } from './messages'
import msgs, { project as proj } from '../messages'
import {analysis, project as proj}, msgs from '../messages'

and permutations thereof. Messages should be referred to directly from these top-level imports, i.e. you should not refer to messages like this:

import messages from './messages'
const { analysis, project } = messages
return analysis.newScenario

but the following is fine:

import { analysis } from './messages'
return analysis.newScenario