grunt-plugin-listfiles v0.1.2

grunt-plugin-listfiles

The Grunt plugin that lists files in the given directory recursively.

Getting Started

This plugin requires Grunt ~0.4.5

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

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

grunt.loadNpmTasks('grunt-plugin-listfiles');

The "listFiles" task

Overview

In your project's Gruntfile, add a section named listFiles to the data object passed into grunt.initConfig().

grunt.initConfig({
  listFiles: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.debug

Type: Boolean Default value: false

A boolean value that is used to set debugger as on or off.

Usage Examples

Default Options

grunt.initConfig({
  listFiles: {
  },
});

Custom Options

grunt.initConfig({
  listFiles: {
    options: {
      debug: true
    },
    dev: {
        src: ['./']
    },
    prod: {
        options: {
            debug: false
        },
        files: [{
            src: './'
        }
        ]
    }
  },
});

Contributing

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

(Nothing yet)