andykim88 / grunt-angular-combine

Grunt task for combining AngularJS partials into a single HTML file.

grunt-angular-combine

Combine AngularJS partials into a single HTML file.

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-angular-combine --save-dev

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

grunt.loadNpmTasks('grunt-angular-combine');

The "angularCombine" task

Overview

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

grunt.initConfig({
  angularCombine: {
    combine: {
      options : {
        appBaseDir : "app",
        target : "dist/index.html",
        remove : true
      },
      files : [
        {
          expand : true,
          cwd : "dist",
          src : "partials/**",
          dest : "dist"
        }
      ]
    },
  },
})

Options

options.appBaseDir

Type: String Default value: ''

A string value that is used to define the app directory.

options.target

Type: String Default value: ''

A string value that is used to define which file the files should be combined with. If the file does not exist, a new one will be created with that name.

Usage Examples

Options

In this example, all HTML files located into dist/views will be merged into a single file : dist/views.html.

grunt.initConfig({
  angularCombine: {
    combine: {
      options : {
        appBaseDir : "app",
        target : "dist/views.html",
        remove : true
      },
      files : [
        {
          expand : true,
          cwd : "dist",
          src : "views/**",
          dest : "dist"
        }
      ]
    },
  },
})

By defaults, it works in the current base directory.

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.1.0 : initial version
• 0.1.1 : fix other-than-html file management
• 0.1.2 : fix only html files (filename ending with .html) should be processed
• 0.1.3 : manage nested folder
• 0.1.4 : change plugin name to stick with camel case convention