grunt-concat-depends v0.7.3
grunt-concat-depends v0.7.2
Concatenate files with dependency order resolution.
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-concat-depends --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-concat-depends');
Concat task
Run this task with the grunt concat
command.
Task targets, files and options may be specified according to the Grunt Configuring tasks guide.
Options
separator
Type: String
Default: grunt.util.linefeed
Concatenated files will be joined on this string. If you're post-processing concatenated JavaScript files with a minifier, you may need to use a semicolon ';'
as the separator.
banner
Type: String
Default: empty string
This string will be prepended to the beginning of the concatenated output. It is processed using grunt.template.process, using the default options.
(Default processing options are explained in the grunt.template.process documentation)
footer
Type: String
Default: empty string
This string will be appended to the end of the concatenated output. It is processed using grunt.template.process, using the default options.
(Default processing options are explained in the grunt.template.process documentation)
stripBanners
Type: Boolean
Object
Default: false
Strip JavaScript banner comments from source files.
false
- No comments are stripped.true
-/* ... */
block comments are stripped, but NOT/*! ... */
comments.options
object:- By default, behaves as if
true
were specified. block
- If true, all block comments are stripped.line
- If true, any contiguous leading//
line comments are stripped.
- By default, behaves as if
process
Type: Boolean
Object
Function
Default: false
Process source files before concatenating, either as templates or with a custom function.
false
- No processing will occur.true
- Process source files using grunt.template.process defaults.data
object - Process source files using grunt.template.process, using the specified options.function(src, filepath)
- Process source files using the given function, called once for each file. The returned value will be used as source code.
(Default processing options are explained in the grunt.template.process documentation)
Usage Examples
Concatenating with a custom separator
In this example, running grunt concat:dist
(or grunt concat
because concat
is a multi task) will concatenate the three specified source files (in order), joining files with ;
and writing the output to dist/built.js
.
// Project configuration.
grunt.initConfig({
concat: {
options: {
separator: ';',
},
dist: {
src: ['src/intro.js', 'src/project.js', 'src/outro.js'],
dest: 'dist/built.js',
},
},
});
Banner comments
In this example, running grunt concat:dist
will first strip any preexisting banner comment from the src/project.js
file, then concatenate the result with a newly-generated banner comment, writing the output to dist/built.js
.
This generated banner will be the contents of the banner
template string interpolated with the config object. In this case, those properties are the values imported from the package.json
file (which are available via the pkg
config property) plus today's date.
Note: you don't have to use an external JSON file. It's also valid to create the pkg
object inline in the config. That being said, if you already have a JSON file, you might as well reference it.
// Project configuration.
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
concat: {
options: {
stripBanners: true,
banner: '/*! <%= pkg.name %> - v<%= pkg.version %> - ' +
'<%= grunt.template.today("yyyy-mm-dd") %> */',
},
dist: {
src: ['src/project.js'],
dest: 'dist/built.js',
},
},
});
Multiple targets
In this example, running grunt concat
will build two separate files. One "basic" version, with the main file essentially just copied to dist/basic.js
, and another "with_extras" concatenated version written to dist/with_extras.js
.
While each concat target can be built individually by running grunt concat:basic
or grunt concat:extras
, running grunt concat
will build all concat targets. This is because concat
is a multi task.
// Project configuration.
grunt.initConfig({
concat: {
basic: {
src: ['src/main.js'],
dest: 'dist/basic.js',
},
extras: {
src: ['src/main.js', 'src/extras.js'],
dest: 'dist/with_extras.js',
},
},
});
Multiple files per target
Like the previous example, in this example running grunt concat
will build two separate files. One "basic" version, with the main file essentially just copied to dist/basic.js
, and another "with_extras" concatenated version written to dist/with_extras.js
.
This example differs in that both files are built under the same target.
Using the files
object, you can have list any number of source-destination pairs.
// Project configuration.
grunt.initConfig({
concat: {
basic_and_extras: {
files: {
'dist/basic.js': ['src/main.js'],
'dist/with_extras.js': ['src/main.js', 'src/extras.js'],
},
},
},
});
Dynamic filenames
Filenames can be generated dynamically by using <%= %>
delimited underscore templates as filenames.
In this example, running grunt concat:dist
generates a destination file whose name is generated from the name
and version
properties of the referenced package.json
file (via the pkg
config property).
// Project configuration.
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
concat: {
dist: {
src: ['src/main.js'],
dest: 'dist/<%= pkg.name %>-<%= pkg.version %>.js',
},
},
});
Advanced dynamic filenames
In this more involved example, running grunt concat
will build two separate files (because concat
is a multi task). The destination file paths will be expanded dynamically based on the specified templates, recursively if necessary.
For example, if the package.json
file contained {"name": "awesome", "version": "1.0.0"}
, the files dist/awesome/1.0.0/basic.js
and dist/awesome/1.0.0/with_extras.js
would be generated.
// Project configuration.
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
dirs: {
src: 'src/files',
dest: 'dist/<%= pkg.name %>/<%= pkg.version %>',
},
concat: {
basic: {
src: ['<%= dirs.src %>/main.js'],
dest: '<%= dirs.dest %>/basic.js',
},
extras: {
src: ['<%= dirs.src %>/main.js', '<%= dirs.src %>/extras.js'],
dest: '<%= dirs.dest %>/with_extras.js',
},
},
});
Invalid or Missing Files Warning
If you would like the concat
task to warn if a given file is missing or invalid be sure to set nonull
to true
:
grunt.initConfig({
concat: {
missing: {
src: ['src/invalid_or_missing_file'],
dest: 'compiled.js',
nonull: true,
},
},
});
See configuring files for a task for how to configure file globbing in Grunt.
Custom process function
If you would like to do any custom processing before concatenating, use a custom process function:
grunt.initConfig({
concat: {
dist: {
options: {
// Replace all 'use strict' statements in the code with a single one at the top
banner: "'use strict';\n",
process: function(src, filepath) {
return '// Source: ' + filepath + '\n' +
src.replace(/(^|\n)[ \t]*('use strict'|"use strict");?\s*/g, '$1');
},
},
files: {
'dist/built.js': ['src/project.js'],
},
},
},
});
Release History
- 2016-01-17 v0.7.2 Minor bug fix
- 2016-01-17 v0.7.1 Remove extraneous console log left in by mistake
- 2016-01-17 v0.7.0 Fix issues with files with same name in different directories Add 'priority' option to put certain files on top regardless of dependencies
- 2014-06-26 v0.5.1 Change all references to grunt-contrib-concat to grunt-contribut-concat-depends Add support dependency evaluation
- 2014-03-21 v0.4.0 README updates. Output updates.
- 2013-04-25 v0.3.0 Add option to process files with a custom function.
- 2013-04-08 v0.2.0 Don't normalize separator to allow user to set LF even on a Windows environment.
- 2013-02-22 v0.1.3 Support footer option.
- 2013-02-15 v0.1.2 First official release for Grunt 0.4.0.
- 2013-01-18 v0.1.2rc6 Updating grunt/gruntplugin dependencies to rc6. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.
- 2013-01-09 v0.1.2rc5 Updating to work with grunt v0.4.0rc5. Switching back to this.files api.
- 2012-11-13 v0.1.1 Switch to this.file api internally.
- 2012-10-03 v0.1.0 Work in progress, not yet officially released.
Task submitted by Samuel Neff
This file was generated on Sun Jan 17 2016 13:53:50.