README.md

Deprecation warning This repo is archived and no longer maintained!

gulp-durandal

A Gulp plugin for building Durandal projects.

Both scripts and views are compiled into a single output file.

No double maintenance of path mapping. Allows various code layouts (bower, app.net etc), using the paths already configured in your main.js.

Minimalistic and simple. No need to be expert with r.js's 60+ options. In many cases, the following should be enough:

gulp.task('durandal', function(){
   return durandal()
      .pipe(gulp.dest('dir/to/save/the/output'));
}

Also see the [Gulp Plugin docs] (http://durandaljs.com/documentation/Gulp.html) on the official Durandal site.

Getting Started

This plugin requires Gulp ~3.5.5

If you haven't used Gulp before, be sure to check out the Getting Started guide, as it explains how to create a Gulpfile as well as install and use Gulp plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install gulp-durandal --save-dev

Once the plugin has been installed, it should be required inside your Gulpfile:

var durandal = require('gulp-durandal');

The "durandal" stream

This plugin compiles all the scripts and views of a Durandal project into a single js file.

The task expects that the Durandal files are under a single app dir (usually named app) and that there is a single main module (usually at app/main.js) that contains both the requirejs path configuration and the initial module that executes.

While simple and minimalistic, this task can handle all known Durandal 2.x samples and starter kits (html, bower, node, asp.net, etc.) with almost no configuration.

Overview

In your project's Gulpfile, lunch the plugin inside a task with the wanted configurations. The plugin will return the stream of the wanted file and it's source map.

var durandal = require('gulp-durandal');

gulp.task('durandal', function(){
    return durandal({
            baseDir: 'app',    //Same as default, so not really required.
            main: 'main.js',   //Same as default, so not really required.
            output: 'main.js', //Same as default, so not really required.
                               //WARNING: Change filename if output and input dirs are the same to avoid input overwrites.
            almond: true,
            minify: true
        })
        .pipe(gulp.dest('dir/to/save/the/output'));
});

For async tasks, handling of error and end events should be added.

gulp.task('durandal-async', function(cb){
    durandal({
            ...
        })
        .on('error', function(err) {
            console.error('error. ' + err);
        })
        .pipe(gulp.dest('dir/to/save/the/output'))
        .on('end', cb);

Options

options.verbose

Type: Boolean Default value: false

Should the task emit information about as it progresses.

options.baseDir

Type: String Default value: 'app'

The path, relative to the gulp cwd, to the root directory of your durandal app (usually called app or App in the durandal starter kits and generators).

This directory is expected to contain all your views, viewmodels, service modules etc. All files under it are are automatically included in the output: *.js files as modules and text files (*.html, *.json) as 'text!' prefixed modules.

options.main

Type: String|Boolean Default value: 'main.js'

The path to the main js file of the application, relative to the baseDir, or null / false if main js file is not used.

This is where we expect to find the project's requirejs.config call which defines all the path mapping for the external modules and libraries.

This file also contains the main module of the application.

Note: The path and module configuration done in this file is extremely important for the build too. Promoting the 'Single Point of Truth` principle, we do not allow any configuration or path mapping outside of this file. We believe that if it is good enough for development, it it good enough for the build.

options.output

Type: String Default value: path.basename(options.main)

Output js file's name.

WARNING: Would overwrite existing file with same name if it is in the same directory!

options.minifiy

Type: Boolean Default value: false

Determines whether the output file is minified (using Uglify2).

options.almond

Type: Boolean|String Default value: false

True to wrap the generated code and include a Durandal specific version of AlmondJS, to replace the need for the much bigger requiresjs, and create a single and self sufficient output file. (Read more about AlmondJS and the Durandal version)

If the value is a string, it should be the path to an almond script, relative to the gulp cwd. The result is similar to setting the value to true, expect the almond script inserted is the one specified here and not the script that comes bundled with the task.

options.extraModules

Type: String[] Default value: []

A list of extra modules to include in the output file, e.g. ['plugins/widget', 'plugins/dialog']. This can be used for all dynamically loaded modules that reside outside of the baseDir (such as Durandal's own plugins and transitions).

We will automatically include any module whose file is under the baseDir, as well as any of their explicit dependencies. Alas, non-explicit dependencies are not recognized automatically by r.js. If their files are outside the baseDir, they will not be recognized by our scanning process. Examples are the Durandal transitions that are loaded dynamically by convention, and Durandal plugins are loaded via app.configurePlugins({ widget: true }).

In short, all required modules must either reside under the baseDir, be an explicit dependency of a module under that dir, or be explicitly included via the extraModules option.

Module names are resolved and mapped to files according to the paths and mapping in the main config file, so use the same names as you would do in your code.

options.durandalDynamicModules

Type: Boolean Default value: true

True to add default Durandal dynamic modules to options.extraModules. Adds all default Durandal plugins and transitions if the definition of plugins / transitions paths exists in the main config file.

options.require

Type: Boolean|String|String[] Default value: options.almond? true : false

Determines if a 'require([...])' call is to be inserted, and which modules are included in the list of required modules.

When options.almond is used, this value is true by default as almond requires usually to explicitly call require(['<main module name>']), which is not the convention for require js and Durandal.

The tasks avoids inserting the call if the value is set to false. If it true, it will insert the options.main module. If you need to explicitly specify the module names, use the string or string array value.

options.moduleFilter

Type: Function Default value: function(moduleName){return true;}

After all top level modules are resolved, they are passed via a filter function, so that you have a chance to exclude any modules for any reason you might have.

For example, if you would not like to include the views, you could supply the following function:

function(moduleName){
  return moduleName.indexOf('text!') == -1;
}

options.rjsConfigAdapter

Type: Function Default value: function(rjsConfig){return rjsConfig;}

An advanced argument that allows complete control over the parameters passed to the rjs optimizer. You can add new fields, remove and change any parameter calculated and defined by the plugin, just before the config object is passed to the optimizer.

The 'gulp-durandal' plugin tries to hide the complexity of rjs optimizer from its users, promote preferring convention over configuration and simply work. However, sometimes you just have to have more control over the process and you are willing to trade simplicity for flexibility.

If this is the case, then the rjsConfigAdapter is for you. But be warned, you probably need to understand not only the rjs params but also the internals of the plugin in order to use it.

function(rjsConfig){
  rjsConfig.pragmas = {
        fooExclude: true
  };
  return rjsConfig;
}

Usage Examples

The tests and examples folders contains several examples, for both simple and complex scenarios.

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 Gulp.

Release History

• 1.0.0 - Basic features, tests and samples in place. Deployed on npm.
• 1.1.0 - Added rjsConfigAdapter option to allow full control over the config object passed to the rjs optimizer.
• 1.1.1 - More robust error handling to ensure gulp.watch continues to work even in case of rjs errors.
• 1.1.2 - Updated readme with useful links.
• 1.1.3 - Fixed documentation of callback process in documentation.
• 1.1.4 - Enable mapping file extensions to require.js plugins.
•          - Enable building packages without a main file.
• 1.1.5 - Added warning about potential input file overwrite.
• 1.1.6 - Made Nodeunit report to a file.
• 1.1.7 - Fixed a bug where a source map comment on an output file was generated even when source maps was turned off.

License

MIT