grunt-listfiles

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

grunt-listfiles

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

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:

grunt.loadNpmTasks('grunt-listfiles');

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

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.

grunt.initConfig({
  listfiles: {
    options: {
      banner: '/**\n' +
              ' * list files banner\n' +
              ' */\n' +
              '{\n' +
              '\t[',
      footer: '\t]\n' +
              '}',
      eol: 'crlf',
      prefix: '\t\t\'',
      postfix: '\',',
      postfixLastLine: '\''
    },
    test1: {
      files: {
        'tmp/output.txt': [
          'test/fixtures/**/*.*',
          '!test/fixtures/{,*/,**/}*.{scss,html,md,rb}',
          '!test/fixtures/{,*/,**/}LICENSE'
        ]
      }
    }
  }
});
 
grunt.loadNpmTasks('grunt-listfiles');
 
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.

  • 2013-06-28 v0.1.0 Initial release.