npm install grunt-contrib-concat --save-dev

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

Run this task with thegrunt concat command.

Task targets, files and options may be specified according to the GruntConfiguring tasks guide.

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';\n' as the separator.

Type:String
Default:''

This string will be prepended to the beginning of the concatenated output. It is processed usinggrunt.template.process, using the default options.

(Default processing options are explained in thegrunt.template.process documentation)

Type:String
Default:''

This string will be appended to the end of the concatenated output. It is processed usinggrunt.template.process, using the default options.

(Default processing options are explained in thegrunt.template.process documentation)

Type:BooleanObject
Default:false

Strip JavaScript banner comments from source files.

• false - No comments are stripped.
• true -/* ... */ block comments are stripped, butNOT/*! ... */ comments.
• options object:
  • By default, behaves as iftrue were specified.
  • block - If true,all block comments are stripped.
  • line - If true, any contiguousleading// line comments are stripped.

Type:BooleanObjectFunction
Default:false

Process source files before concatenating, either astemplates or with a custom function.

• false - No processing will occur.
• true - Process source files usinggrunt.template.process defaults.
• data object - Process source files usinggrunt.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 thegrunt.template.process documentation)

Type:Boolean
Default:false

Set to true to create a source map. The source map will be created alongside the destination file, and share the same file name with the.map extension appended to it.

Type:StringFunction
Default:undefined

To customize the name or location of the generated source map, pass a string to indicate where to write the source map to. If a function is provided, the concat destination is passed as the argument and the return value will be used as the file name.

Type:String
Default:embed

Determines the type of source map that is generated. The default value,embed, places the content of the sources directly into the map.link will reference the original sources in the map as links.inline will store the entire map as a data URI in the destination file.

In this example, runninggrunt concat:dist (orgrunt concat becauseconcat is amulti task) will concatenate the three specified source files (in order), joining files with; and writing the output todist/built.js.

// Project configuration.grunt.initConfig({concat:{options:{separator:';',},dist:{src:['src/intro.js','src/project.js','src/outro.js'],dest:'dist/built.js',},},});

In this example, runninggrunt concat:dist will first strip any preexisting banner comment from thesrc/project.js file, then concatenate the result with a newly-generated banner comment, writing the output todist/built.js.

This generated banner will be the contents of thebanner template string interpolated with the config object. In this case, those properties are the values imported from thepackage.json file (which are available via thepkg config property) plus today's date.

Note: you don't have to use an external JSON file. It's also valid to create thepkg 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',},},});

In this example, runninggrunt concat will build two separate files. One "basic" version, with the main file essentially just copied todist/basic.js, and another "with_extras" concatenated version written todist/with_extras.js.

While each concat target can be built individually by runninggrunt concat:basic orgrunt concat:extras, runninggrunt concat will build all concat targets. This is becauseconcat is amulti 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',},},});

Like the previous example, in this example runninggrunt concat will build two separate files. One "basic" version, with the main file essentially just copied todist/basic.js, and another "with_extras" concatenated version written todist/with_extras.js.

This example differs in that both files are built under the same target.

Using thefiles 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'],},},},});

Filenames can be generated dynamically by using<%= %> delimited underscore templates as filenames.

In this example, runninggrunt concat:dist generates a destination file whose name is generated from thename andversion properties of the referencedpackage.json file (via thepkg 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',},},});

In this more involved example, runninggrunt concat will build two separate files (becauseconcat is amulti task). The destination file paths will be expanded dynamically based on the specified templates, recursively if necessary.

For example, if thepackage.json file contained{"name": "awesome", "version": "1.0.0"}, the filesdist/awesome/1.0.0/basic.js anddist/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',},},});

If you would like theconcat task to warn if a given file is missing or invalid be sure to setnonull totrue:

grunt.initConfig({concat:{missing:{src:['src/invalid_or_missing_file'],dest:'compiled.js',nonull:true,},},});

Seeconfiguring files for a task for how to configure file globbing in Grunt.

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 topbanner:"'use strict';\n",process:function(src,filepath){return'// Source: '+filepath+'\n'+src.replace(/(^|\n)[\t]*('usestrict'|"usestrict");?\s*/g,'$1');},},files:{'dist/built.js':['src/project.js'],},},},});

• 2022-04-03   v2.1.0   Updated dependencies
• 2021-10-07   v2.0.0   Update dependencies Requires node.js v12+
• 2016-04-20   v1.0.1   Fix for concatenating multiple source map files.
• 2016-02-20   v1.0.0   Update source-map to 0.5.3. Tag Grunt as peerDep to >=0.4.0. Make source maps generation a little faster. Addcharset:utf-8 tosourceMappingURL.
• 2015-02-20   v0.5.1   Fix path issues with source maps on Windows.
• 2014-07-19   v0.5.0   AddssourceMap option.
• 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 tothis.files API.
• 2012-11-13   v0.1.1   Switch tothis.file API internally.
• 2012-10-03   v0.1.0   Work in progress, not yet officially released.

Task submitted by"Cowboy" Ben Alman

This file was generated on Sun Apr 03 2022 07:55:57.