grunt-files-to-json

grunt-files-to-json

Simple grunt plugin to create a list of files and write it to a json file

Getting Started

This plugin requires Grunt.

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-files-to-json --save-dev

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

grunt.loadNpmTasks('grunt-files-to-json');

The "files_to_json" task

Overview

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

grunt.initConfig({
  files_to_json: {
    files: {
      src: // [pattern],
      dest: // output file,
        options: {
          name: // optional name
       }
    }

  },
})

Options

options.name

Type: String Default value: 'item'

Usage Examples

grunt.initConfig({
  files_to_json: {
    files: {
      src: '<%= distdir %>/themes/*/*.css',
        dest: '<%= distdir %>/themes.json',
        options: {
          name: 'theme'
       }
    }
  },
});

Example output file

{ "results": [
      {"name":"theme_1", "url":"/themes/default/8909873.style.css"},
      {"name":"theme_2", "url":"/themes/comso/8934573.style.css"},
      {"name":"theme_3", "url":"/themes/minimal/8923473.style.css"}
]}

Running the tests

After you have cloned the repo execute grunt test.

Release History

(Nothing yet)

License

Copyright (c) 2014 Nik G. Licensed under the MIT license.