bud

minimalistic task manager

npm install bud
10 downloads in the last month

Minimalistic task manager.

browserify = bin 'browserify/cmd'
uglify = bin 'uglify-js/uglifyjs'

target 'dist.js', 'entry.js', ->
    browserify 'entry.js -o dist.js'

target 'dist.min.js', 'dist.js', ->
    uglify 'dist.js -o dist.min.js'

task 'clean', ->
    rm '-rf logs/*.txt'

Install

$ npm install -g bud

Usage

Create a new Devfile, and code your tasks in JavaScript or CoffeeScript.

Defining A Task

task 'run', ->
    exec 'node app'

Or

task('run', function(){
    exec('node app');
});

To run:

$ bud run

Shell Commands

ShellJS is available in Devfiles globally.

task 'hello/world', ->
    mkdir '-p', 'hello/world'
    write 'hello/world/README.txt', 'Hello World!'

    cp 'stuff/*', '../hello/world'

    ls './', (file) ->
        debug "Copied lib/#{file} to hello/world/."

Watching Files

The parameters after a task name considered as files to watch. Following task will watch run.js and lib/ and restart the task on any change:

task 'start', 'lib', 'run.js', ->
    exec.async 'node app'

The first parameter of the given callback will have the list of changed files;

task 'watch', 'lib/**/*.js', 'run.js', (files) ->
    files.forEach (file) ->
        debug "#{file} has been changed."

Defining Targets

target is an alias that would make your tasks look more meaningful.

target 'dist.js', 'index.js', 'lib', ->
    exec 'onejs index -o dist.js'

Calling Commands

uglify = cmd "uglifyjs"

task "minify", ->
  uglify "src.js -o min.js"
  debug "done"

Calling Asynchronously

All commands are run synchronously by default. Use async method to change it:

staticServer = cmd.async "python -m SimpleHTTPServer"
apiServer = cmd.async "node server"

all "api-server", "serve-static"

task "api-server", ->
    apiServer()
    debug "api server up"

task "serve-static", ->
    staticServer()
    debug "static server up"

Calling bud on this file will start these two servers at the time.

Shortcut to node_modules/bin

stylus = bin "stylus" # node_modules/stylus/bin/stylus
uglify = bin "uglify-js/uglifyjs" # node_modules/uglify-js/bin/uglifyjs
serve = bin.async "serve" # node_modules/serve/bin/serve

target "dist.js", ->
    uglify "index.js -o dist.js"

target "style.css", ->
    stylus "style.styl"

target "serve", ->
    serve()

Defining Multiple Tasks

all 'run', 'public/js', 'public/css'

task 'run', './app.js', './lib', ->
    exec.async 'node app'

target 'public/js', 'javascripts', ->
    cd 'frontend'
    exec 'browserify javascripts/main.js -o public/bundle.js'

target 'public/css', 'styles', ->
    cd 'frontend'
    exec 'stylus styles -o public/css'

To run all tasks:

$ bud

To run specific tasks;

$ bud public/js public/css

Define aliases to type less:

alias 'assets', 'public/js', 'public/css'
$ bud assets

Debugging

$ DEBUG=bud:* bud
npm loves you