grunt-flo

grunt plugin for fb-flo

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-flo --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-flo');

The "flo" task

Overview

In your project's Gruntfile, add a section named flo to the data object passed into grunt.initConfig().

grunt.initConfig({
  flo: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.port

Type: Integer Default value: 8888

Port number for fb-flo to listen on

options.host

Type: String Default value: localhost

Host for fb-flo to listen on

options.verbose

Type: Boolean Default value: false

Turn verbose mode on

options.forever

Type: Boolean Default value: true

To run the server forever (probably required at this point).

options.base

Type: String Default value: .

The base directory for fb-flo to watch.

options.glob

Type: Array Default value: []

An array of globbing patterns. Note this is used instead of grunt's default files or src arrays because fb-flo does their own globbing relative to options.base. Using this option to try to avoid confusion.

options.resolver

Type: Function Default value: null

This is a function that maps between a filename and its contents. Please view the fb-flo documentation for what the function is called with. By default it will simply read the file that changed and pass its filename (relative to options.base) as the url.

Usage Examples

Custom resolver

Here's an example of a custom resolver where you serve your static files from a different path than the base watch path. i.e. the file path is lib/js/file.js but the URL to the file should be /js/file.js

grunt.initConfig({
  flo: {
    dev: {
      options: {
        glob: [
          'lib/js/**/*.js',
          'build/lib/css/**/*.css'
        ],
        resolver: function(fp, callback) {
          var path = require('path');
          var fs = require('fs');

          if (fp.match(/\.js$/)) {
            callback({
              resourceURL: fp.replace(/^lib\/js/, '/js'),
              contents: fs.readFileSync('<%= flo.dev.options.base %> + '/' + fp).toString()
            });
          }
          else if (fp.match(/^build.*?\.css$/)) {
            callback({
              resourceURL: fp.replace(/^build\/lib\/css/, '/css'),
              contents: fs.readFileSync('<%= flo.dev.options.base %> + '/' + fp).toString()
            });
          }
        }
      }
    }
  }
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

License

Copyright (c) 2014 Billy Vong. Licensed under the MIT license.