grunt-component-build

Build and watch Components

npm install grunt-component-build
72 downloads in the last day
261 downloads in the last week
803 downloads in the last month

grunt-component-build Build Status

Build Components using Grunt.

Getting Started

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, install this plugin with this command:

npm install grunt-component-build --save-dev

then load the tasks in your Gruntfile with

grunt.loadNpmTasks('grunt-component-build');

The Basics

Add a component section to your Grunt file:

componentbuild: {
  options: {
     dev: true,
     sourceUrls: true
  },
  components: {
    options: {
      name: 'dev'
    },
    src: 'my-component',
    dest: 'my-component/build'
  }
}

You can add as many sub-tasks to the componentbuild task and they will be compiled separately.

Extending Component with Plugins

Builder.js allows us to extending it so we can add support for other languages, like Coffeescript or Jade. You can do this easily in the configure option in your grunt file.

componentbuild: {
  options: {
    configure: function(builder){
      builder.use(plugin);
    }
  }
}

These plugins are extremely simple. You can grab them from npm or write your own.
List of plugins

Options

name

Set the name of the built file.

dev

Set --dev flag to true. This builds in development dependencies.

sourceUrls

Include source urls in built files

ignore

Ignore parts of specific components

ignore: {
  'component-name': ['scripts', 'templates']
}

standalone

The same --standalone flag in component build. Setting this to a string will name the global variable to that is exported. Setting this to true will do the same, but it will use the component name by default.

paths

Add lookup paths for local components

prefix

Prefix CSS URLs with a string. Useful for rewriting URLs to point to a CDN.

copy

Copy component assets instead of symlinking.

noRequire

Exclude the require function at the top of the built component.

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

0.4.3

  • Fix ignore option

0.4.0

  • Refactor to support Grunt 0.4.0+ API

0.3.2

  • Add noRequire option

0.3.1

  • Upgrade component-build to 0.9.x

0.3.0

  • Define a default output /build. The output option is now optional.

0.2.8

  • Add an option for verbose output (similar to component build -v)

0.2.7

  • Rename task to component_build
  • Add Travis

0.2.6

  • Upgrade component-build to 0.8.1

0.2.5

  • Updated support for component-builder 0.7.0
  • Updated grunt task to use new Builder config name
  • .conf changed to .config

0.2.4

  • Upgraded component-build to 0.6.4

0.2.0beta

  • Added support for grunt 0.4.0

0.1.4

  • Added builder.js plugin support

0.1.0

  • First release

License

Copyright (c) 2012 Anthony Short
Licensed under the MIT license.

npm loves you