grunt-ux-concat

version: 0.10.0-alpha2

Grunt task that concatinates JavaScript source files for various distribution styles like commonjs, amd, and closure style for browsers.

Getting Started

This plugin requires Grunt ~0.4.2

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

npm install grunt-ux-concat --save-dev

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

grunt.loadNpmTasks('grunt-ux-concat');

The "uxConcat" task

Overview

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

grunt.initConfig({
  uxConcat: {
    options: {
      // Task-specific options go here.
    },
    files: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.license

Type: String Default value: null

Path of the license file that will be prepended to each final distribution file.

options.strict

Type: Boolean Default value: false

Instructions the task to inject "use strict"; into the distribution file if true.

Usage Examples

Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  uxConcat: {
    options: {
      "license": "license.js",
      "strict": true,
      "package": "ux-lexer",
      "indent": true,
      "types": ["amd", "browser", "commonjs"],
      "srcs": ["node_modules/ux-util/src"]
      'config': {
          'inherits': {
              require: "ux-util/lib/inherits",
              exports: ['inherits']
          },
          'extend': {
              require: "ux-util/lib/extend",
              exports: ['extend']
          },
          'lexer-src': {},
          'lexer' : {
              exports: ["Lexer", "LexerRule", "Reader"],
              deps: ['inherits', 'extend'],
              namespace: 'ux.Text'
          },
          'lexer-all' : {
              exports: ["Lexer", "LexerRule", "Reader"],
              namespace: 'ux.Text'
          }
      }
    },
    files: {
      lexer: ['lexer-src'],
      'lexer-all': [
        /* will search for files in /src & node_modules/ux-util/src */
        'core', 
        'global',
        'is-plain-object-src',
        'extend-src',
        'inherits-src',
        'lexer-src'
      ]
    }
  },
});

Default AMD Template

<%= license %>define(<%= amdName  %>["require", "exports"<%= dependencies %>], function(require, exports) { 
<%= strict %><%= imports %>
<%= content %><%= exports %>
  return exports;
});

Default browser Template

<%= license %>(function(){
  <%= strict %><%= content %><%= exports %>
})();

Default lib Template

<%= license %><%= strict %><%= imports %>
<%= content %><%= exports %>
  
module.exports = exports;

Sample Source File

var TestClass = function() {
  
};

TestClass.prototype = {
  x: "one",
  b: "two"
};

Sample Config

grunt.initConfig({
 uxConcat: {
      options: {
      "license": "license.js",
      "strict": true,
      "package": "ux-lexer",
      "indent": true,
      "types": ["amd", "browser", "commonjs"],
      "srcs": ["node_modules/ux-util/src"]
      'config': {
          'inherits': {
              require: "ux-util/lib/inherits",
              exports: ['inherits']
          },
          'extend': {
              require: "ux-util/lib/extend",
              exports: ['extend']
          },
          'lexer-src': {},
          'lexer' : {
              exports: ["Lexer", "LexerRule", "Reader"],
              deps: ['inherits', 'extend'],
              namespace: 'ux.Text'
          },
          'lexer-all' : {
              exports: ["Lexer", "LexerRule", "Reader"],
              namespace: 'ux.Text'
          }
      }
    },
    files: {
      lexer: ['lexer-src'],
      'lexer-all': [
        'node_modules/ux-util/src/core.js', 
        'node_modules/ux-util/src/global.js',
        'node_modules/ux-util/src/is-plain-object-src.js',
        'node_modules/ux-util/src/extend-src.js',
        'node_modules/ux-util/src/inherits-src.js',
        'lexer-src'
      ]
    }
  }
});

Output AMD

define("ux-util/test-class",["require", "exports"], function(require, exports) { 
  "use strict";
    
  var TestClass = function() {
    
  };
  
  TestClass.prototype = {
    x: "one",
    b: "two"
  };
    
  exports.TestClass = TestClass;
  return exports;
});

Output Browser

(function(){
  "use strict";
  var TestClass = function() {
    
  };
  
  TestClass.prototype = {
    x: "one",
    b: "two"
  };
    
  if(typeof self.ux === 'undefined')
    self.ux = {};
  
  self.ux.TestClass = TestClass;
})();

Output Lib

"use strict";
    
var TestClass = function() {
  
};

TestClass.prototype = {
  x: "one",
  b: "two"
};

exports.TestClass = TestClass;
  
module.exports = exports;

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.10.0-alpha2
  • fixed issues with imports for browser / closure vesrions scripts
  • allowed searching multiple folders for files.
• 0.10.0-alpha1
  • complete rewrite of file meta attribute.
  • handles vanilla browser exports / imports.
• 0.1.0 Alpha Release
• 0.1.1 Allows for files to be an empty array.
• 0.1.2 Add amd option for required paths.