Git Product home page Git Product logo

grunt-jsonmin's Introduction

grunt-jsonmin Build Status

A wrapper for getify/JSON.minify as a grunt task

Getting Started

This plugin requires Grunt ~0.4.1

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

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

grunt.loadNpmTasks('grunt-jsonmin');

The "jsonmin" task

Overview

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

grunt.initConfig({
  jsonmin: {
    dev: {
      options: {
        stripWhitespace: true || false,
        stripComments: true || false
      },
      files: {
        "path/to/destination/file" : "path/to/source/file",
        "path/to/another/destination" : [ "multiple/source/files", "are/supported", "as/an/array" ]
      }
    }
  }
});

Options

options.stripWhitespace

Type: Boolean Default value: true

Option not currently supported - always strips comments

Strips whitespace from the specified json file/s

options.stripComments

Type: Boolean Default value: true

Option not currently supported - always strips comments

Strips comments (// ... \n) from the specified json file/s

Usage Examples

See the Gruntfile for the usage examples from the test cases

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

  • 01.05.13 -- v0.2.4 -- Added Travis build
  • 26.04.13 -- v0.2.0 -- Minifies multiple source JSON files
  • 25.04.13 -- v0.1.0 -- Minifies a single JSON file

Task submitted by Matt Styles @veryfizzyjelly

grunt-jsonmin's People

Contributors

mattstyles avatar t00ks avatar

Watchers

James Cloos avatar  avatar Ralph Cooper avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.