grunt-war

Pure JavaScript implementation for creating a WAR of your project for deployment on a JVM servlet container. Enjoy!

Getting Started

This plugin requires Grunt ~0.4.2

npm install grunt-war --save-dev

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

grunt.loadNpmTasks('grunt-war');

Then sip on some @AnodyneCoffee.

Are you on Strava?

Do you enjoy YouTube?

Enjoy!

The "war" task

Overview

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

The simplest usage might look simiiar to the following:

grunt.loadNpmTasks('grunt-war');
 
grunt.initConfig({
 
      /*
       * Build a WAR (web archive) without Maven or the JVM installed.
       */
      war: {
        target: {
          options: {
            war_dist_folder: '<%= build_dir %>',    /* Folder where to generate the WAR. */
            war_name: 'webmagic'                    /* The name fo the WAR file (.war will be the extension) */
          },
          files: [
            {
              expand: true,
              cwd: '<%= build_dir %>',
              src: ['**'],
              dest: ''
            }
          ]
        }
      }
});

If your project does not include a web.xml then grunt-war can generate one for you. This is one option below:

grunt.loadNpmTasks('grunt-war');
 
grunt.initConfig({
 
      /*
       * Build a WAR (web archive) without Maven or the JVM installed.
       */
      war: {
        target: {
          options: {
            war_dist_folder: '<%= build_dir %>',
            war_name: 'grunt-magic',
            webxml_welcome: 'index.html',
            webxml_display_name: 'Grunt WAR',
            webxml_mime_mapping: [ { extension: 'woff', mime_type: 'application/font-woff' } ]
          },
          files: [
            {
              expand: true,
              cwd: '<%= build_dir %>',
              src: ['**'],
              dest: ''
            }
          ]
        }
      }
});

A complete and very simple Grunt file example will look like the following.

// Save this snippet as grunt-war.js and run with  "grunt --gruntfile grunt-war.js war" at the command line.
// Assumes simple layout:
// -project
// --build  (The folder where the generated grunt-magic.war file will go)
// --src    (all the source code, html, etc)
// --- index.html (The file name must match up with the webxml_welcome: property below)
module.exports = function ( grunt ) {
    grunt.loadNpmTasks( 'grunt-war' );
 
    var taskConfig = {
        war: {
            target: {
                options: {
                    war_verbose: true,
                    war_dist_folder: 'build',           // Folder path seperator added at runtime.
                    war_name: 'grunt-magic',            // .war will be appended if omitted
                    webxml_welcome: 'index.html',
                    webxml_display_name: 'Grunt WAR'
                },
                files: [
                    {
                        expand: true,
                        cwd: 'src',
                        src: ['**'],
                        dest: ''
                    }
                ]
            }
        }
    };
 
    grunt.initConfig( taskConfig );
};

Options

options.war_dist_folder

Type: 'string' Default value: 'test'

This is the folder that the war will be placed in. This folder has to exist before this task is run.

options.war_name

Type: 'string' Default value: 'grunt'

options.war_extras

Type: 'Array' Default value: []

A list of files and folders entries that are to be included in the war. Each object in the array has keys filename and data example: { filename: 'name_of_file.ext', data: file_data }. If the key data is omitted then an empty folder called filename will be added to the WAR. The value of key data can either be a string or a function that returns a string.

war_extras: [ {filename: 'grunt-war-credits.txt', data: 'This line will appear in the file!\n'} ]

options.war_verbose

Type: 'boolean' Default value: false

Logs progress to the grunt console log.

options.war_compression

Type: 'string' Default value: 'DEFLATE'

Compress ('DEFLATE') or leave uncompressed ('NONE').

options.webxml

Type: 'Function' Default value: Normally omitted. Only provide if you want absolute control over the format and contents of the web.xml. If you specify this option the other options.webxml_XXX will have no effect if specified.

Example 1

     /* Return a string that will become the complete contents of the web.xml */
     webxml: function (opts) { 
                return 'string containing contents of web.xml'; 
             },

Example 2

     /* Return the contents of a file which will become the web.xml */
     webxml: function (opts) { 
                var fs = require('fs'); 
                return fs.readFileSync(pathToFileWithContentsOfHardCodedWebXML, 'binary'); 
             },

options.webxml_welcome

Type: 'string' Default value: 'index.html'

options.webxml_display_name

Type: 'string' Default value: 'Grunt WAR'

options.webxml_mime_mapping

Type: 'Array' Default value: []

An array of objects with properties extension and mime_type.

options.webxml_webapp_extras

Type: 'Array' Default value: []

An array of objects that are either 'string' or 'function' that return 'string'. These entries are included directly into the generated web.xml.

webxml_webapp_extras: [
    '<login-config />\n',
    '<session-config>\n<session-timeout>\n30\n</session-timeout>\n</session-config>\n'
]

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

• Sample webxml_webapp_extras. Thanks to @pthaden

0.5.0

• Fixed issue when using NPM3 that grunt-war dependencies had to be manually installed. Thanks to @bradrox

0.4.9

• Just a version bump of dependencies used internally.

0.4.8

• Fixed issue with "normalize" creating folders. Thanks to rbalmf and laszlogmenyhart.

0.4.7

• Fixed issue with "extras" that was not consistent with EMFILE fix. Thanks to laszlogmenyhart.

0.4.6

• Fixed EMFILE exception (no many open files).

0.4.5

• Fixed a second WEB-INF/web.xml being added on windows.

0.4.4

• Bug fix that prevented old wars from being deleted

0.4.3

• Update to package.json for grunt-war.

0.4.2

• Fixed bad archive entry names. (mmaday)

0.4.1

• Documenation update.

0.4.0

• This build uses streams to build the WAR and can process vastly larger projects (huge) than in prior versions. This should fix the "Out of memory error - FATAL ERROR". that has been reported by a few individuals.

0.3.4

• If the project being processed provides a top level WEB-INF/web.xml then grunt-war will use it in lieu of generating one automatically and will ignore the webxml options configured on the grunt-war task.

0.3.3

• Removed a project dependency (not actively maintained) to try and address reports of a out-of-memory exception while generating a war file from 2 users.
• Grammer corrections - Thank you Tim Russell (trussell314).

0.3.2

• If the war_dist_folder does not already exist then grunt-war will create it. This saves the pain of adding this check before calling grunt-war. (skray)

0.3.1

• Added options.webxml so that you may provide the raw contents of the web.xml when necessary. Requested by MartinDoyleUK.

     /* Example of how to return the contents of a file which will become the web.xml */
     webxml: function (opts) { 
                var fs = require('fs'); 
                return fs.readFileSync(pathToFileWithContentsOfHardCodedWebXML, 'binary'); 
             },

0.3.0 (Breaking changes)

• This release allows for more flexible output paths inside the war bundle using Grunt's built-in dest write instead of the prior custom and less flexible rewrites. If you want the same behavior as in prior releases that did not depend on the 'dest' configuration then you must modify the task to something similiar to the following snippet. (shcarrico)

    ...
    war: {
      target: {
        options: { ... },
        files: [
            {
              expand: true,
              cwd: '<%= build_dir %>',
              src: ['**'],
              dest: ''  
            }
        ]
      }
    },
    ...

0.2.7

• Fixed the inclusion of source files defined in previous WAR task configurations for all future WAR tasks. Example: a war.foo task includes dist/foo in foo.war, and a war.bar task includes dist/bar in bar.war. bar.war would include both dist/bar and the previously added dist/foo. (jbenner)

0.2.6

• Fixed grunt-war encoding text incorrectly. Example: 'Količina' and 'Osveži' would get encoded as 'Količina' and 'Osveži'. (sobrle)

0.2.5

• Updated peerDependencies to include node-zip. (@augier)

0.2.4

• Now deletes options.war_name from options.war_dist_folder before trying to generate a new war file.

0.2.3

• Fixed file names being trimmed when included in war. (@augier)

0.2.1

• Fixed deployment issue resulting from using wrong option when generating webapp tag.

0.2.0

• Renamed options.war_filename to options.war_name.
• Added options.war_extras
• Added options.webxml_webapp_extras.

0.1.4 Initial