budo - npm Package Versions

6.0.0

Major Changes

• garnish is now included by default in CLI and API
  • you can use --ndjson and ndjson: true to have raw output (for custom pretty-printers)

Minor Changes

• added --title option for the default HTML title
• added --css option for a default style sheet

5.0.0

Major Changes

• you can just type budo . | garnish for the entry point (or index.js)
• added --onupdate for things like linting, see the docs
• if no --host is specified, resolves to internal IP
  • you can still hit localhost:9966 and it will work
• the <script> src defaults to the filename of the first entry
  • eg: budo src/index.js leads to <script src="index.js">
• browserify options must come after a full stop --
  • except --no-debug which is passed as a budo option
  • eg: budo index.js --no-debug -- -t babelify
• --dir can be passed multiple times to use multiple static folders
  • budo index.js --dir public --dir tmp
• removed --live-plugin option to reduce code complexity
  • might be added back into CLI later
  • API still supports budo.live({ plugin: true })
• portfinding is enabled by default in API and CLI
  • user can disbale with --no-portfind or portfind: false
• removed --verbose, -v, timing is logged by default now
• entry files are now optional (i.e. if you just need a static HTML with LiveReload)
• added --open, -o to launch browser on connect
• syntax errors in code are shown in the DOM body now
  • can disable with --no-error-handler
  • in API can use errorHandler: Boolean|Function
• added --version to CLI
• --live can optionally be a string to only LiveReload on those globs, eg:
  • budo index.js --live=*.{css,html}
• removed --ignore-watch and --interval
  • use budo.watch(glob, chokidarOpts) instead
• shorthand for most CLI options now exists
• arg parsing has improved and uses camel-case in API
• most args are now supported before entries, eg:
  • budo --live src/index.js
• cleaner error messaging in terminal

API Changes

• dir can be a string or array of static paths
• the 'connect' event now passes livePort
• the 'connect' event ev.host now uses internal IP by default
• exposed a CLI feature
  • require('budo').cli(process.argv.slice(2), { overrides... })
• errorHandler can be used for custom bundle error handling
• middleware can be a fn(req, res, next) function for custom routes
• 'update' event now passes (contents, updates)

Browserify Args

Users creating CLI tools on top of budo can use opt.browserifyArgs to handle subarg correctly. Example with minimist:

var args = process.argv.slice(2)
var opts = require('minimist')(args, { '--': true })
budo.cli(args, {
  browserifyArgs: opts['--']
})

If no browserifyArgs is specified, then opt.browserify can be used to send the actual JS object to the browserify constructor.

budo.cli(args, {
  browserify: {
    transform: require('babelify')
  }
})