Merge pull request #46 from conveyal/dev

Merge dev branch into master

Author: trevorgerhardt

README.md

@@ -33,7 +33,7 @@ Settings contain both Mastarm configuration settings and per environment setting
 
 ## Usage
 
-Entries are in the format `input/file.js:output/file.js`. Not all options pertain to all commands.
+Not all options pertain to all commands.  Entries are in the format `input/file.js:output/file.js`.
 
 ```shell
 $ mastarm --help
@@ -43,9 +43,9 @@ $ mastarm --help
 
   Commands:
 
-    build [entries...]             Bundle JavaScript & CSS
+    build [entries...] [options]   Bundle JavaScript & CSS
     commit                         Force intelligent commit messages.
-    deploy [options] [entries...]  Bundle & Deploy JavaScript & CSS
+    deploy [entries...] [options]  Bundle & Deploy JavaScript & CSS
     lint [paths...]                Lint JavaScript [& CSS coming soon!]
     test [options]                 Run tests using Jest test runner
 
@@ -67,6 +67,26 @@ $ mastarm --help
 
 Compile JS, HTML, CSS, YAML, Markdown into a single `.js`. Utilizes [babel](https://babeljs.io/), [browserify](https://github.com/substack/node-browserify), [budo](https://github.com/mattdesl/budo), and [postcss](http://postcss.org/).
 
+```shell
+$ mastarm build [entries...] [options]
+
+  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 attempt to find the entry file. It will first see if the `entry` option has been set in the `settings.yml` config file. If that setting or the file does not exist, it will attempt to build the file specified as `main` in your project's `package.json` file. And finally, if both of those options fail, mastarm will attempt to look for the `index.js` and `index.css` file in the current working directory and attempt to compile each into `assets/index.js` and `assets/index.css` respectively.  
+
+If entries are provided, mastarm will build only those files.
+
+#### CSS Building
+
+Starting with mastarm 1.0.0, CSS builds will occur separately from the browserify build. Thus, any CSS imports into a JavaScript file will cause a build error. Instead, to build CSS file(s), you must specify the file(s) as entries in the command. Also, when running in `serve` or `watch` mode, the CSS files will get automatically rebuilt, but a manual page refresh will be necessary.
+
 ### `commit`
 
 Utilize best practices when forming a commit message using [Commitzen](http://commitizen.github.io/cz-cli/) & the [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog) standard.

bin/mastarm

@@ -4,7 +4,7 @@ const commander = require('commander')
 const path = require('path')
 
 const loadConfig = require('../lib/load-config')
-const pkg = require('../lib/pkg')
+const util = require('../lib/util')
 
 commander
   .version(require('../package.json').version)
@@ -19,35 +19,41 @@ commander
   .option('-F, --flyle', 'Cache and serve tiles.')
   .option('-p, --proxy <address>', 'Proxy calls through to target address.')
   .option('-s, --serve', 'Serve with budo. Auto-matically rebuilds on changes.')
-  .option('-w, --watch', 'Rebuild on changes with watchify.')
+  .option('-w, --watch', 'Automatically rebuild on changes.')
   .action(function (entries, options) {
     checkDependencies()
     const config = loadConfig(process.cwd(), commander.config, commander.env)
-    const get = (item) => val([options, commander, config.settings], item)
-    const files = parseEntries(entries, get)
+    const get = util.makeGetFn([options, commander, config.settings])
+    const files = util.parseEntries(entries, get)
+    if (files.length === 0) {
+      console.log('No entry point found!  Did you spell the filename correctly?')
+      process.exit(1)
+    }
     if (get('serve')) {
       const budo = require('../lib/budo')
-      files.map(budo({
+      budo({
         config,
+        files,
         flyle: get('flyle'),
         proxy: get('proxy')
-      }))
+      })
     } else {
       const build = require('../lib/build')
-      files.map(build({
+      build({
         config,
         env: get('env'),
+        files,
         minify: get('minify'),
         watch: get('watch')
-      }))
+      })
     }
   })
 
 commander
   .command('commit')
   .description('Force intelligent commit messages.')
   .action(function () {
-    popMastarmFromArgv()
+    util.popMastarmFromArgv()
     const path = require('path')
     const bootstrap = require('commitizen/dist/cli/git-cz').bootstrap
     bootstrap({
@@ -67,8 +73,12 @@ commander
     checkDependencies()
     const pushToS3 = require('../lib/push-to-s3')
     const config = loadConfig(process.cwd(), commander.config, commander.env)
-    const get = (item) => val([options, commander, config.settings], item)
-    const files = parseEntries(entries, get)
+    const get = util.makeGetFn([options, commander, config.settings])
+    const files = util.parseEntries(entries, get)
+    if (files.length === 0) {
+      console.log('No file(s) found!  Did you spell the filename correctly?')
+      process.exit(1)
+    }
     files.map(pushToS3({
       cloudfront: get('cloudfront'),
       config,
@@ -164,11 +174,7 @@ commander.parse(process.argv)
 
 function checkDependencies () {
   if (!commander.skipCheckDependencies) {
-    const checkDependenciesSync = require('check-dependencies').sync
-    const results = checkDependenciesSync({
-      install: true,
-      packageDir: process.cwd()
-    })
+    const results = util.updateDependencies()
     if (results.status !== 0) {
       console.error(results.error)
       process.exit(results.status)
@@ -178,34 +184,3 @@ function checkDependencies () {
     }
   }
 }
-
-function parseEntries (entries, get) {
-  const files = entries.map((entry) => {
-    entry = entry.split(':')
-    if (entry.length === 1) {
-      entry.push(`assets/${entry[0]}`)
-    }
-    return entry
-  })
-
-  if (files.length === 0) {
-    files.push([
-      get('entry') || pkg.main || 'index.js',
-      get('outfile') || 'assets/index.js'
-    ])
-  }
-
-  return files
-}
-
-/**
- * A lot of subcommands utilize exact argument lengths. Pop mastarm to handle it.
- */
-function popMastarmFromArgv () {
-  process.argv = process.argv.slice(0, 1).concat(process.argv.slice(2))
-}
-
-function val (targets, i) {
-  const ts = targets.filter((t) => t[i] !== undefined)
-  if (ts.length > 0) return ts[0][i]
-}

lib/browserify.js

@@ -2,14 +2,13 @@ const browserify = require('browserify')
 const path = require('path')
 const uglifyify = require('uglifyify')
 
-const transform = require('./transform')
+const transform = require('./js-transform')
 
 module.exports = function ({
   config,
   entry,
   env,
-  minify,
-  outfile
+  minify
 }) {
   const pipeline = browserify(entry, {
     basedir: process.cwd(),
@@ -22,8 +21,7 @@ module.exports = function ({
     ],
     transform: transform({
       config,
-      env,
-      outfile
+      env
     })
   })
   .on('error', function (err) {

lib/budo.js

@@ -1,63 +1,76 @@
 const budo = require('budo')
 const path = require('path')
 
-const transform = require('./transform')
+const transformJs = require('./js-transform')
+const transformCss = require('./css-transform')
 
 module.exports = function ({
   config,
+  files,
   flyle,
   proxy
 }) {
-  return function ([entry, outfile]) {
-    const budoOpts = {
-      browserify: {
-        debug: true,
-        paths: [
-          path.join(process.cwd(), '/node_modules'),
-          path.join(__dirname, '/../node_modules')
-        ],
-        transform: transform({
-          config,
-          env: 'development',
-          outfile
-        })
-      },
-      cors: true,
-      middleware: [],
-      pushstate: true
-    }
-    if (proxy) {
-      const httpProxy = require('http-proxy')
-      const proxyServer = httpProxy.createProxyServer({target: proxy})
-      proxyServer.on('error', function (err, req, res) {
-        console.error(err.stack)
-        res.writeHead(500, {'Content-Type': 'text/plain'})
-        res.end(err.message)
-      })
-      budoOpts.middleware.push(function (req, res, next) {
-        if (req.url.indexOf('/api') === 0) {
-          req.url = req.url.slice(4)
-          proxyServer.web(req, res)
-        } else {
-          next()
-        }
+  const budoOpts = {
+    browserify: {
+      debug: true,
+      paths: [
+        path.join(process.cwd(), '/node_modules'),
+        path.join(__dirname, '/../node_modules')
+      ],
+      transform: transformJs({
+        config,
+        env: 'development'
       })
-    }
-    if (flyle) {
-      const serveTiles = require('./flyle')
-      budoOpts.middleware.push(function (req, res, next) {
-        if (req.url.indexOf('/tile') === 0) {
-          serveTiles(req, res)
-        } else {
-          next()
-        }
+    },
+    cors: true,
+    middleware: [],
+    pushstate: true
+  }
+  if (proxy) {
+    const httpProxy = require('http-proxy')
+    const proxyServer = httpProxy.createProxyServer({target: proxy})
+    proxyServer.on('error', function (err, req, res) {
+      console.error(err.stack)
+      res.writeHead(500, {'Content-Type': 'text/plain'})
+      res.end(err.message)
+    })
+    budoOpts.middleware.push(function (req, res, next) {
+      if (req.url.indexOf('/api') === 0) {
+        req.url = req.url.slice(4)
+        proxyServer.web(req, res)
+      } else {
+        next()
+      }
+    })
+  }
+  if (flyle) {
+    const serveTiles = require('./flyle')
+    budoOpts.middleware.push(function (req, res, next) {
+      if (req.url.indexOf('/tile') === 0) {
+        serveTiles(req, res)
+      } else {
+        next()
+      }
+    })
+  }
+
+  const budoFiles = []
+
+  files.map((file) => {
+    if (file[1].split('.').pop() === 'css') {
+      transformCss({
+        filename: file[0],
+        outfile: file[1],
+        watch: true
       })
+    } else {
+      budoFiles.push(file.join(':'))
     }
+  })
 
-    budo
-      .cli([entry + ':' + outfile], budoOpts)
-      .on('error', function (err) {
-        console.error(err.stack)
-      })
-  }
+  budo
+    .cli(budoFiles, budoOpts)
+    .on('error', function (err) {
+      console.error(err.stack)
+    })
 }

lib/build.js

@@ -2,14 +2,16 @@ const fs = require('fs')
 const exorcist = require('exorcist')
 
 const browserify = require('./browserify')
+const transformCss = require('./css-transform')
 
 module.exports = function ({
   config,
   env,
+  files,
   minify,
   watch
 }) {
-  return function ([entry, outfile]) {
+  function buildJs ([entry, outfile]) {
     const pipeline = browserify({
       config,
       entry,
@@ -33,4 +35,16 @@ module.exports = function ({
 
     bundle()
   }
+
+  files.map((file) => {
+    if (file[1].split('.').pop() === 'css') {
+      transformCss({
+        filename: file[0],
+        outfile: file[1],
+        watch
+      })
+    } else {
+      buildJs(file)
+    }
+  })
 }