benjamine / grunt-requiregrep

Grunt Task that greps AMD dependencies on source files

Grunt Require-Grep Task

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

Example:

<!-- a/path/to/page.html -->
<!-- require("jquery, widgets, twitter") -->

<!-- another/path/to/anotherpage.html -->
<!-- require("jquery, widgets, fx") -->

Running grunt-requiregrep can generate:

define(['jquery', 'widgets', 'twitter', 'fx'], function()){
	console.log('all modules loaded');
});

Now you can include this new module in your requirejs main config file. This way if you use a bundler like r.js (check grunt-contrib-requirejs) it will include all modules used on your source files automatically.

Installation

Install this grunt plugin with: npm install grunt-requiregrep

Then add this line to your grunt.js gruntfile:

grunt.loadNpmTasks('grunt-requiregrep');

Documentation

Supports the following options:

• src/files: source files to grep for AMD dependencies (default: **/*.*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!');).
  • forEachFile: function that will be called for each parsed file with these arguments: file, contents, registerDependency (use this function add a dependency programmatically)

Example Usage

/*jslint node:true*/

module.exports = function (grunt) {

	'use strict';

	grunt.loadNpmTasks('grunt-requiregrep'); // load the task

	grunt.initConfig({
		watch: {
			files: '<config:requiregrep.files>',
			tasks: 'requiregrep'
		},

		requiregrep: { // configure the task
			all: {
				files: {
					'scripts/all.js': [
						'home.html',
						'view/**/*.html'
					]
				},
				options: {
					onLoad: 'if (window.console){window.console('all modules loaded');}', // run after all dependencies are loaded
				}
			}
		}
	});

	grunt.registerTask('default', 'watch');
};

grunt-requiregrep's Issues

Contrib

Hi, I'm on the grunt team. I noticed you're using contrib in your plugin name. The grunt-contrib namespace is reserved for tasks maintained by the grunt team. I would kindly ask you to remove contrib from the repo name, readme and npm package. Thanks.

Grunt 0.4 Release

I'm posting this issue to let you know that we will be publishing Grunt 0.4 on Monday, February 18th.

If your plugin is not already Grunt 0.4 compatible, would you please consider updating it? For an overview of what's changed, please see our migration guide.

If you'd like to develop against the final version of Grunt before Monday, please specify "grunt": "0.4.0rc8" as a devDependency in your project. After Monday's release, you'll be able to use "grunt": "~0.4.0" to actually publish your plugin. If you depend on any plugins from the grunt-contrib series, please see our list of release candidates for compatible versions. All of these will be updated to final status when Grunt 0.4 is published.

Also, in an effort to reduce duplication of effort and fragmentation in the developer community, could you review the grunt-contrib series of plugins to see if any of your functionality overlaps significantly with them? Grunt-contrib is community maintained with 40+ contributors—we'd love to discuss any additions you'd like to make.

Finally, we're working on a new task format that doesn't depend on Grunt: it's called node-task. Once this is complete, there will be one more conversion, and then we'll never ask you to upgrade your plugins to support our changes again. Until that happens, thanks for bearing with us!

If you have any questions about how to proceed, please respond here, or join us in #grunt on irc.freenode.net.

Thanks, we really appreciate your work!