Nostalgic Punchcard Missing
    Wondering what’s next for npm?Check out our public roadmap! »

    budo

    3.0.0-rc2 • Public • Published

    budō

    stable

    This is a browserify development server inspired by beefy and wzrd, but specifically focused on incremental reloading and LiveReload integration (including CSS injection).

    Note that budo needs a copy of watchify installed. It can be either local (preferred) or global.

    npm install budo watchify -g

    The simplest use cases will start up a server with a default index.html and incrementally bundle your source on filesave. The requests are delayed until the bundle has finished, so you won't be served stale or empty bundles if you refresh the page mid-update. Examples:

    # serve file on port 9966 
    budo index.js
     
    # show timing information on re-bundle 
    budo index.js --verbose
     
    # transpile ES6 and trigger LiveReload on html/css/js change 
    budo index.js --live --transform babelify

    Then open http://localhost:9966 to see the content in action.

    To pretty-print in terminal, garnish, bistre or another ndjson-based stream can be used:

    budo index.js | garnish

    See docs for more features. PRs/suggestions/comments welcome.

    docs

    usage

    NPM

    CLI

    Details for budo command-line interface. Other options like --transform are sent to browserify/watchify.

    Usage:
      budo [entries] [opts]
     
    Options:
      --help, -h       show help message
      --port           the port to run, default 9966
      --host           the host, default "localhost"
      --dir            the directory to serve, and the base for --outfile
      --live           enable LiveReload integration
      --live-plugin    enable LiveReload but do not inject script tag
      --live-port      the LiveReload port, default 35729
      --verbose, -v    verbose timing information for re-bundles
      --poll=N         use polling for file watch, with optional interval N

    By default, the --debug option will be sent to browserify (for source maps). If this is unwanted, you can use --no-debug or --debug=false to disable source maps.

    API

    The API mirrors the CLI except you must provide a stream for logging, and it does not attempt to auto-portfind.

    var budo = require('budo')
     
    budo('./src/index.js', {
      live: true,             //live reload
      stream: process.stdout, //log to stdout
      port: 8000              //use this port
    }).on('connnect', function(ev) {
      //...
    })

    See API usage for more details.

    Script Injection

    screenshot

    (click for demo)

    The original motivation for making budō was to build a simple tool around Chrome Script Injection. This has since split off into its own repository: budo-chrome to minimize the scope of budō.

    License

    MIT, see LICENSE.md for details.

    Install

    npm i [email protected]

    Version

    3.0.0-rc2

    License

    MIT

    Last publish

    Collaborators

    • avatar
    • avatar