grunt-pngcheck

Test PNG files against corruption.


Keywords
gruntplugin, png, corruption, error, validation
License
GPL-2.0+
Install
npm install grunt-pngcheck@0.1.0

Documentation

grunt-pngcheck NPM version

Test PNG files against corruption.

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

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

grunt.loadNpmTasks('grunt-pngcheck');

The "pngcheck" task

Overview

pngcheck task checks against corrupt PNG files:

  • without IEND marker, e.g. those broken by a partial download
  • having trailing bytes post IEND marker, e.g. modified by a virus, script etc.

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

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

Usage Example

grunt.initConfig({
  pngcheck: {
    files: {
      src: ['src/images/layout/{,**/}*.png', 'src/images/style/*.png'],
    },
  },
})

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

See release tags.

License

Copyright © 2014-2015 Ain Tohvri. Licensed under the GPL-3 license.