grunt-json-pretty

0.2.2 • Public • Published

Grunt JSON Pretty

npm version

Clean up the formatting of your JSON files.

Getting Started

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, install this plugin with this command:

npm install grunt-json-pretty --save-dev

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

grunt.loadNpmTasks('grunt-json-pretty');

Tip: the load-grunt-tasks module makes it easier to load multiple grunt tasks.

Documentation

See the Gruntfile in this repo for a full example.

Example config

grunt.initConfig({
  'json-pretty': {
      options: {
        files: 'content/',
        indent: 4,
        minify:true,
        append:'.min',
        cleanup:true
      },
   }
});
 
grunt.loadNpmTasks('grunt-json-pretty');
grunt.registerTask('default', ['json-pretty']);

Example config with multiple directories

grunt.initConfig({
  'json-pretty': {
      options: {
        src: ['contentA/', 'contentB/','contentB/contentA/'],
        indent: 4,
        minify:true,
        append:'.min',
        cleanup:true
      },
   }
});
 
grunt.loadNpmTasks('grunt-json-pretty');
grunt.registerTask('default', ['json-pretty']);

Options

files

Type: String Default value: content/

A reference to a directory that contains JSON files.

src

Type: Array

A reference to multiple directories that contains JSON files.

indent

Type: Number Default value: 4

A number of tab spaces to use in the formatting of JSON files.

minify

Type: Boolean Default value: false

Create a minified version of each JSON file.

append

Type: String Default value: '.min'

Append to minified version of each JSON file.

cleanup

Type: Boolean Default value: false

Removes each original JSON file after minification.

Release History

  • 0.2.2: Merged pull #2
  • 0.2.1: Merged pull #1
  • 0.2.0: Added support for multiple directories and file cleanup.
  • 0.1.9: fix default minify JSON.
  • 0.1.8: add dev dependencies.
  • 0.1.7: add release history notes to documentation.
  • 0.1.6: small adjustments.
  • 0.1.5 add the ability change appened string on minified JSON files.
  • 0.1.4: display output for successful and failed files.
  • 0.1.3: updates to documentation.
  • 0.1.2: updates to documentation.
  • 0.1.1: add the option to minify JSON files.
  • 0.1.0: Initial release.

Contributing

  1. Fork it
  2. Run npm install
  3. Run Grunt watch grunt watch
  4. Create your feature branch (git checkout -b my-new-feature)
  5. Commit your changes (git commit -am "Add some feature")
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

License

'MIT © Ryan Burgess

Package Sidebar

Install

npm i grunt-json-pretty

Weekly Downloads

30

Version

0.2.2

License

none

Last publish

Collaborators

  • ryanburgess