grunt-requiregen

Contents

• What is grunt-requiregen?
• Installation
• Usage
• Bug Tracker
• Author
• License

What is grunt-requiregen?

A grunt plugin which generates a requirejs main.js file, which ensures js files are loaded in the right order

Require.js is a nice tool which combines plugin loading capabilities, and main application minification for prod. Maintaining dependancies between all your modules is a bit cumbersome, especially if you are using angular.js and its dependancy injection system. This would require declaring your dependancies twice.

Angularjs still does not resolves everything as it needs to be loaded first, and usually, you need a bootstrap code to be loaded last. There might be other needs, like jquery very first, app module before its services, etc.

Installation

1$ npm install grunt-requiregen

Usage

Include the following line in your Grunt file. (Here this is coffeescript version)

1    grunt.loadNpmTasks('grunt-requiregen')

1    # task that generates main.js (the require.js main file)
2    # Angular is actually very nice with its dependancy injection system
3    # basically, we just need angular is loaded first,  app second and run last
4    # we should not be modifying this config when the app is growing
5    requiregen:
6        main:
7            cwd: './.temp/scripts/'
8            # require json2 and html5shiv are loaded conditionally in the html file
9            src: ['**/*.js','!libs/require.js', '!libs/json2.js', '!libs/html5shiv-printshiv.js']
10            options:
11                order: [
12                # order is a list of minimatch 'glob' like matching
13                # modules, requiregen will generate the correct shim
14                # to load modules in this order
15                # if a module has been loaded in previous layers, it wont be loaded again
16                # so that you can use a more generic minimatch expression in the end
17                    'libs/jquery'
18                    'libs/angular' # angular needs jquery before or will use internal jqlite
19                    'libs/*'      # remaining libs before app
20                    'app'          # app needs libs
21                    '{routes,views,config,*/**}'  # remaining angularjs components
22                    'run'     # run has to be in the end, because it is triggering angular's own DI
23                ]
24            dest: '.temp/scripts/main.js'

Bug tracker

Have a bug? Please create an issue here on GitHub!

https://github.com/tardyp/grunt-requiregen/issues

Author

Pierre Tardy

• http://github.com/tardyp

License

Copyright 2013 Pierre Tardy

Licensed under the MIT license.