grunt-depend-concat

grunt-depend-concat

A Grunt task that concatenates files in order via path references.

This task was initially developed to be used in conjunction with grunt-ts for concatenating separately compiled JavaScript files.

Written in TypeScript.

Supported Path References

Comments Tags

/**
 * @depends ../path/to/file.js
 */

/* @requires ../path/to/file.js */

// @include ../path/to/file.js

TypeScript References

/// <reference path="../path/to/file.ts" />

Getting Started

This plugin requires Grunt ~0.4.0

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-depend-concat --save-dev

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

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

Configuration

method

The method used for finding dependencies. Default: "depends"

Comment Tags

If the method option is set to a string that doesn't match a built in method it will be treated as a comment tag. For example, setting the method to "use" will result in the following comments be recognized.

/**
 * @use ../path/to/file.js
 */

/* @use ../path/to/file.js */

// @use ../path/to/file.js

TypeScript References

Set the the method to "reference" for TypeScript references to be recognized.

/// <reference path="../path/to/file.ts" />

Custom

You can also use a custom method by providing a literal object with the regex and index properties set.

{
    /**
     * A regular expression used to find the dependencies
     */
    regex: /somefancyregex/gi,

    /**
     * An array index where each dependency's file path
     * can be found from the result of RegExp.exec()
     */
    index: 1
}

separator

File contents separator. Default: "\n"

ignore_ext

When looking for matching dependency files, the file extensions are ignored. Allows TypeScript references (.ts) to discover their compiled (.js) counterparts. Default: true

Example

grunt.initConfig({
    'depend-concat': {
        options: {
            method: 'depends',
            separator: '\n'
        },
        build: {
            src: ['src/files/**.js'],
            dest: 'dist/concat.js'
        }
    }
});

License

Released under the MIT license

---

(^_^)