Grunt RequireDep Task

Searchs for dependencies required on your source code (eg. template files) and generates an AMD module from it.

Example:

1<!-- a/path/to/page.html -->
2<!-- require("jquery, widgets, twitter") -->
3
4<!-- another/path/to/anotherpage.html -->
5<!-- require("jquery, widgets, fx") -->

Running grunt requiredep can generate:

1// all.js
2define(['jquery', 'widgets', 'twitter', 'fx'], function()){
3	console.log('all modules loaded');
4});

Now you can include this new module in your requirejs main config file. This allows you to use a AMD bundler like r.js (check grunt-contrib-requirejs).

Installation

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-contrib-requiregrep

Then add this line to your project's gruntfile:

1grunt.loadNpmTasks('grunt-requiregrep');

Documentation

Supports the following options:

• files: source files to grep for AMD dependencies (eg. *.html).
• dest: output filename (eg all.js)
• options:
  • requirePattern: regex to detect dependencies on source files, first capture group should be a comma-separated list of module names. default: /require\(\s*[\'\"]([^\'\"]*)[\'\"]/gi
  • moduleName: output module name. default: null, ie. anonymous module
  • onLoad: code to include on module load (eg. console.log('all modules loaded!');). default: ''
  • forEachFile: function that will be called for each parsed file with these arguments: file, contents, registerDependency (use this function add a dependency)

Example Usage

1/*jslint node:true*/
2
3module.exports = function (grunt) {

4
5	'use strict';
6
7	grunt.loadNpmTasks('grunt-requiregrep'); // load the task
8
9	grunt.initConfig({
10		watch: {
11			files: '<config:requiregrep.files>',
12			tasks: 'requiregrep'
13		},
14
15		requiregrep: { // configure the task
16			all: {
17				files: [ // some example files
18					'home.html',
19					'view/**/*.html'
20				],
21				dest: 'scripts/all.js',
22				options: {
23					onLoad: 'if (window.console){window.console('all modules loaded');}', // run after all dependencies are loaded
24				}
25			}
26		}
27	});
28
29	grunt.registerTask('default', 'watch');
30};