shama / grunt-minjson

A Grunt plugin for minifying json files.
MIT License
11 stars 2 forks source link

grunt-minjson

A Grunt plugin to minify and concat JSON files.

Getting Started

If you haven't used grunt before, be sure to check out the Getting Started guide.

From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:

npm install grunt-minjson --save-dev

Once that's done, add this line to your project's Gruntfile:

grunt.loadNpmTasks('grunt-minjson');

If the plugin has been installed correctly, running grunt --help at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a devDependency, which ensures that it will be installed whenever the npm install command is run.

The "minjson" task

Usage Examples

grunt.initConfig({
  minjson: {
    compile: {
      files: {
        // Minify one json file
        'one.min.json': 'one.json',
        // Concat/minify one.json and all json files within the data folder
        // If more than one json file is matched, json will be wrapped in brackets []
        'all.min.json': ['one.json', 'data/*.json']
      }
    }
  }
});

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