node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »



NPM version Build Status Dependency Status devDependency Status Build status

Create a list of files and perform an action on each file in the list then write the results to a file.

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-listfiles --save-dev

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


This plugin was designed to work with Grunt 0.4.x.

Listfiles task

Run this task with the grunt listfiles command.

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



Type: String
Default: null

Prefix the destination file with the given banner, with a linebreak inbetween.


Type: String
Default: null

Postfix the destination file with the given footer, with a prepended linebreak.


Type: String
Choices: 'lf', 'cr', 'crlf'
Default: 'lf'

The linefeed character you would like to use for the destination file.


Type: String
Default: null

A prefix string to prepend to each file that is found.


Type: String
Default: null

A postfix string to append to each file that is found.


Type: String
Default: null

A postfix string to append to the last file that is found.


Type: Array
Default: []

This option will hold all your pattern/replacement pairs. A pattern/replacement pair should contain key:value pairs containing:

  • pattern String or Regex
  • replacement String or Function
options: {
  replacements: [{
    pattern: /\/(asdf|qwer)\//ig,
    replacement: '"$1"'
  }, {
    pattern: ',',
    replacement: ';'
  }, {
    pattern: /(file)(_)([\S]*?)(_)(test)/gi,
    replacement: function (match, p1, p2, p3, p4, p5, offset, string) {
      return [p1, p3, p5].join('-');

If specifying a function as a parameter for the replacemnt please see the documentation at for more details. If the pattern is a string, only the first occurrence will be replaced, as stated on String.prototype.replace.


All results will be alpha sorted after all replacements have occurred.

Usage Examples

Example Config

  listfiles: {
    options: {
      banner: '/**\n' +
              ' * list files banner\n' +
              ' */\n' +
              '{\n' +
      footer: '\t]\n' +
      eol: 'crlf',
      prefix: '\t\t\'',
      postfix: '\',',
      postfixLastLine: '\''
    test1: {
      files: {
        'tmp/output.txt': [
grunt.registerTask('default', ['listfiles']);


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