grunt-dependability

grunt-dependability

Dependable ordering of JS & CSS files during build and dynamically during build.

Getting Started

This plugin requires Grunt ~0.4.1

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-dependability --save-dev

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

grunt.loadNpmTasks('grunt-dependability');

The "dependability" task

Overview

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

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

Options

options.base

Type: String

Path to the files you wish to build. Must be specified.

options.include

Type: String or array

Either a single file extension (e.g. "js") or an array (e.g. `["js", "jsc"]) to include. (Optional if you want all files.)

options.out

Type: String

Path to write the combined file too.

options.mode

Type: String Default: build

Sets the dependability mode to build.

Usage Examples

Javscript

In this example we will combine all javascript files in src (in the same order as using the dependability module)

grunt.initConfig({
  dependability: {
    js: {
      base: path.resolve('src'),
      include: 'js',
      out: path.resolve('build/js/' + artifactName + '.js')
    },
  },
})

CSS

In this example we will combine all CSS files in src (in the same order as using the dependability module)

grunt.initConfig({
  dependability: {
    css: {
      base: path.resolve('src'),
      include: 'css',
      out: path.resolve('build/css/' + artifactName + '.css')
    }
  }
})

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)